ktor-server-sessions/io.ktor.server.sessions/CookieConfiguration

CookieConfiguration

class CookieConfiguration

A configuration used to specify cookie attributes for Sessions.

Constructors

CookieConfiguration

fun CookieConfiguration()

Properties

domain

var domain: String? = null

Specifies the host to which the cookie is sent.

encoding

var encoding: CookieEncoding

Specifies a cookie encoding.

extensions

val extensions: MutableMap<String, String?>

Allows you to add custom cookie attributes, which are not exposed explicitly. For example, you can pass the SameSite attribute in the following way:

httpOnly

var httpOnly: Boolean = true

Specifies whether cookie access is forbidden from JavaScript.

maxAgeInSeconds

var maxAgeInSeconds: Long

Specifies the number of seconds until the cookie expires.

path

var path: String?

Cookie path

secure

var secure: Boolean = false

Enables transferring cookies via a secure connection only and protects session data from HTTPS downgrade attacks.

Extensions

maxAge

var CookieConfiguration.maxAge: Duration?

Cookie time to live duration or null for session cookies. Session cookies are client-driven. For example, a web browser usually removes session cookies at browser or window close unless the session is restored.