JwtOptions class

Configuration options for JWT verification.

Constructors

JwtOptions({bool enabled = true, String? issuer, List<String> audience = const <String>[], List<String> requiredClaims = const <String>['exp'], Uri? jwksUri, List<Map<String, dynamic>> inlineKeys = const <Map<String, dynamic>>[], List<String> algorithms = const <String>['RS256'], Duration clockSkew = const Duration(seconds: 60), Duration jwksCacheTtl = const Duration(minutes: 5), Duration requestTimeout = const Duration(seconds: 10), String header = 'Authorization', String bearerPrefix = 'Bearer ', String cookieName = 'auth_token'})
Creates a JwtOptions instance with the specified parameters.
const

Properties

algorithms → List<String>
The allowed algorithms for JWT signature verification.
final
audience → List<String>
The expected audience (aud) values for the JWT.
final
bearerPrefix → String
The prefix expected before the token in the authorization header.
final
clockSkew → Duration
The allowed clock skew for token expiry and not-before validation.
final
cookieName → String
The cookie name used to read or write JWT tokens.
final
enabled → bool
Whether JWT verification is enabled.
final
hashCode → int
The hash code for this object.
no setterinherited
The HTTP header used to extract the JWT.
final
inlineKeys → List<Map<String, dynamic>>
Inline JSON Web Keys for verifying tokens.
final
issuer → String?
The expected issuer (iss) claim of the JWT.
final
jwksCacheTtl → Duration
The cache time-to-live for fetched JWKS keys.
final
jwksUri → Uri?
The URI for fetching JSON Web Key Sets (JWKS).
final
requestTimeout → Duration
Timeout applied when fetching the configured JWKS endpoint.
final
requiredClaims → List<String>
The claim names that must be present in the JWT.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

copyWith({bool? enabled, String? issuer, List<String>? audience, List<String>? requiredClaims, Uri? jwksUri, List<Map<String, dynamic>>? inlineKeys, List<String>? algorithms, Duration? clockSkew, Duration? jwksCacheTtl, Duration? requestTimeout, String? header, String? bearerPrefix, String? cookieName}) → JwtOptions
Creates a copy of this JwtOptions with the specified overrides.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited