javalin-security API

0.2.0

javalin-security-jwt/io.github.mzlnk.javalin.security.jwt

Package-level declarations

Types

BearerChallengeUnauthorizedHandler

class BearerChallengeUnauthorizedHandler(realm: String = "API") : UnauthorizedHandler

An UnauthorizedHandler that includes a WWW-Authenticate: Bearer challenge on 401 responses.

interface DecodedJwt

A library-agnostic view of a successfully verified JWT.

class Jwt(val token: DecodedJwt) : Identity

The Identity produced by JWT authentication.

JwtAuthenticator

class JwtAuthenticator : Authenticator

Implements JWT bearer-token authentication.

class JwtConfig

Configuration for the jwt strategy factory.

fun interface JwtDecoder

Verifies and decodes a raw JWT according to a JwtVerification specification.

JwtIdentityMapper

fun interface JwtIdentityMapper

Maps a verified DecodedJwt to a caller-defined Identity.

sealed interface JwtKeySource

Describes where the key(s) used to verify a JWT signature come from.

fun interface JwtRolesMapper

Maps a decoded JWT to the set of RouteRoles granted to the caller.

JwtVerification

class JwtVerification

Library-agnostic specification of how a JWT must be verified.

SimpleDecodedJwt

data class SimpleDecodedJwt(val subject: String, val claims: Map<String, Any?>) : DecodedJwt

Immutable DecodedJwt implementation created by adapter modules after library-specific verification.

Functions

fun jwt(configure: Consumer<JwtConfig>): AuthenticationStrategy.Sync

Builds an AuthenticationStrategy.Sync for JWT bearer-token authentication, and returns it for assignment to http.authentication or ws.authentication.