commonMain.io.ktor.server.sessions.SameSite.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ktor-server-sessions-mingwx64 Show documentation

Ktor is a framework for quickly creating web applications in Kotlin with minimal effort.

The newest version!

/*
 * Copyright 2014-2023 JetBrains s.r.o and contributors. Use of this source code is governed by the Apache 2.0 license.
 */

package io.ktor.server.sessions

import io.ktor.http.*

private const val SameSiteKey: String = "SameSite"

/**
 * String constant options for SameSite cookie attribute.
 */
public object SameSite {
    /**
     * Only sends cookies from the origin's site.
     */
    public const val Strict: String = "Strict"

    /**
     * Default behavior. Also sends cookies when navigating to origin site.
     */
    public const val Lax: String = "Lax"

    /**
     * Also sends cookies from cross-site requests.
     * Requires Secure attribute to also be set.
     */
    public const val None: String = "None"
}

/**
 * Cookie configuration extension to supply the "SameSite" attribute for
 * preventing cross-site request forgery (CSRF) attacks.
 */
public var CookieConfiguration.sameSite: String?
    get() = extensions[SameSiteKey]
    set(value) {
        extensions[SameSiteKey] = value
    }

/**
 * Extension for easier access of SameSite attribute.
 */
public val Cookie.sameSite: String? get() =
    extensions[SameSiteKey]