ktor-server-auth-jwt/io.ktor.server.auth.jwt

Package-level declarations

Types

JWTAuthChallengeFunction

typealias JWTAuthChallengeFunction = suspend JWTChallengeContext.(defaultScheme: String, realm: String) -> Unit

Specifies what to send back if JWT authentication fails.

JWTAuthenticationProvider

class JWTAuthenticationProvider : AuthenticationProvider

A JWT Authentication provider.

JWTChallengeContext

class JWTChallengeContext(val call: ApplicationCall)

A context for JWTAuthChallengeFunction.

JWTConfigureFunction

typealias JWTConfigureFunction = Verification.() -> Unit

A JWT verifier function used to verify a token format and its signature.

class JWTCredential(payload: Payload) : JWTPayloadHolder

A JWT credential that consists of the specified payload.

JWTPayloadHolder

abstract class JWTPayloadHolder(val payload: Payload)

Shortcut functions for standard registered JWT claims.

class JWTPrincipal(payload: Payload) : JWTPayloadHolder

A JWT principal that consists of the specified payload.

TypedJwtAuthConfig

@ExperimentalKtorApi

class TypedJwtAuthConfig<P : Any>

Configures a typed JWT authentication scheme with principal type P.

Functions

causedByProviderSentInvalidJwk

fun SigningKeyNotFoundException.causedByProviderSentInvalidJwk(): Boolean

Checks whether the signing key lookup failed because the provider returned unusable JWK data.

@ExperimentalKtorApi

inline fun <P : Any> jwt(name: String, configure: TypedJwtAuthConfig<P>.() -> Unit): SimpleAuthenticationScheme<P>

Creates a typed JWT authentication scheme with principal type P.

fun AuthenticationConfig.jwt(name: String? = null, configure: JWTAuthenticationProvider.Config.() -> Unit)

Installs the JWT Authentication provider. JWT (JSON Web Token) is an open standard that defines a way for securely transmitting information between parties as a JSON object. To learn how to configure it, see JSON Web Tokens.

fun AuthenticationConfig.jwt(name: String? = null, description: String? = null, configure: JWTAuthenticationProvider.Config.() -> Unit)

Installs the JWT Authentication provider with description. JWT (JSON Web Token) is an open standard that defines a way for securely transmitting information between parties as a JSON object. To learn how to configure it, see JSON Web Tokens.