javalin-security-api-key/io.github.mzlnk.javalin.security.apikey

Package-level declarations

Types

Link copied to clipboard
class ApiKeyAuthenticator @JvmOverloads constructor(lookup: ApiKeyLookup, resolver: ApiKeyResolver = ApiKeyResolver.DEFAULT) : Authenticator

Implements opaque API-key authentication.

Link copied to clipboard
class ApiKeyConfig

Configuration for the apiKey strategy factory.

Link copied to clipboard
data class ApiKeyDetails @JvmOverloads constructor(val identity: Identity, val roles: Set<RouteRole> = emptySet())

Lookup result for opaque API-key authentication: the caller's identity and the roles granted on success.

Link copied to clipboard
fun interface ApiKeyLookup

Resolves a raw API key to ApiKeyDetails carrying the caller's own identity.

Link copied to clipboard
fun interface ApiKeyResolver

Locates a raw API key string within an incoming request.

Functions

Link copied to clipboard
fun apiKey(configure: Consumer<ApiKeyConfig>): AuthenticationStrategy.Sync

Builds an AuthenticationStrategy.Sync for opaque API-key authentication.