Package org.springframework.security.oauth2.jwt
Core classes and interfaces providing support for JSON Web Token (JWT).
-
Interface Summary Interface Description JwtClaimAccessor AClaimAccessorfor the "claims" that may be contained in the JSON object JWT Claims Set of a JSON Web Token (JWT).JwtClaimNames The Registered Claim Names defined by the JSON Web Token (JWT) specification that may be contained in the JSON object JWT Claims Set.JwtDecoder Implementations of this interface are responsible for "decoding" a JSON Web Token (JWT) from it's compact claims representation format to aJwt.JwtDecoderFactory<C> A factory forJwtDecoder(s).JwtEncoder Implementations of this interface are responsible for encoding a JSON Web Token (JWT) to it's compact claims representation format.ReactiveJwtDecoder Implementations of this interface are responsible for "decoding" a JSON Web Token (JWT) from it's compact claims representation format to aJwt.ReactiveJwtDecoderFactory<C> A factory forReactiveJwtDecoder(s). -
Class Summary Class Description JoseHeaderNames The Registered Header Parameter Names defined by the JSON Web Token (JWT), JSON Web Signature (JWS) and JSON Web Encryption (JWE) specifications that may be contained in the JOSE Header of a JWT.JwsHeader The JSON Web Signature (JWS) header is a JSON object representing the header parameters of a JSON Web Token, that describe the cryptographic operations used to digitally sign or create a MAC of the contents of the JWS Protected Header and JWS Payload.JwsHeader.Builder A builder forJwsHeader.Jwt An implementation of anAbstractOAuth2Tokenrepresenting a JSON Web Token (JWT).Jwt.Builder Helps configure aJwtJwtClaimsSet TheJWTClaims Set is a JSON object representing the claims conveyed by a JSON Web Token.JwtClaimsSet.Builder A builder forJwtClaimsSet.JwtClaimValidator<T> Validates a claim in aJwtagainst a providedPredicateJwtDecoders Allows creating aJwtDecoderfrom an OpenID Provider Configuration or Authorization Server Metadata Request based on provided issuer and method invoked.JwtEncoderParameters A holder of parameters containing the JWS headers and JWT Claims Set.JwtIssuerValidator Validates the "iss" claim in aJwt, that is matches a configured valueJwtTimestampValidator An implementation ofOAuth2TokenValidatorfor verifying claims in a Jwt-based access tokenJwtValidators Provides factory methods for creatingOAuth2TokenValidator<Jwt>MappedJwtClaimSetConverter Converts a JWT claim set, claim by claim.NimbusJwtDecoder A low-level Nimbus implementation ofJwtDecoderwhich takes a raw Nimbus configuration.NimbusJwtDecoder.JwkSetUriJwtDecoderBuilder A builder for creatingNimbusJwtDecoderinstances based on a JWK Set uri.NimbusJwtDecoder.PublicKeyJwtDecoderBuilder A builder for creatingNimbusJwtDecoderinstances based on a public key.NimbusJwtDecoder.SecretKeyJwtDecoderBuilder A builder for creatingNimbusJwtDecoderinstances based on aSecretKey.NimbusJwtDecoderJwkSupport Deprecated. UseNimbusJwtDecoderorJwtDecodersinsteadNimbusJwtEncoder An implementation of aJwtEncoderthat encodes a JSON Web Token (JWT) using the JSON Web Signature (JWS) Compact Serialization format.NimbusReactiveJwtDecoder An implementation of aReactiveJwtDecoderthat "decodes" a JSON Web Token (JWT) and additionally verifies it's digital signature if the JWT is a JSON Web Signature (JWS).NimbusReactiveJwtDecoder.JwkSetUriReactiveJwtDecoderBuilder A builder for creatingNimbusReactiveJwtDecoderinstances based on a JWK Set uri.NimbusReactiveJwtDecoder.JwkSourceReactiveJwtDecoderBuilder A builder for creatingNimbusReactiveJwtDecoderinstances.NimbusReactiveJwtDecoder.PublicKeyReactiveJwtDecoderBuilder A builder for creatingNimbusReactiveJwtDecoderinstances based on a public key.NimbusReactiveJwtDecoder.SecretKeyReactiveJwtDecoderBuilder A builder for creatingNimbusReactiveJwtDecoderinstances based on aSecretKey.ReactiveJwtDecoders Allows creating aReactiveJwtDecoderfrom an OpenID Provider Configuration or Authorization Server Metadata Request based on provided issuer and method invoked.SupplierJwtDecoder AJwtDecoderthat lazily initializes anotherJwtDecoderSupplierReactiveJwtDecoder AReactiveJwtDecoderthat lazily initializes anotherReactiveJwtDecoder -
Exception Summary Exception Description BadJwtException An exception similar toBadCredentialsExceptionthat indicates aJwtthat is invalid in some way.JwtDecoderInitializationException An exception thrown when aJwtDecoderorReactiveJwtDecoder's lazy initialization fails.JwtEncodingException This exception is thrown when an error occurs while attempting to encode a JSON Web Token (JWT).JwtException Base exception for all JSON Web Token (JWT) related errors.JwtValidationException An exception that results from an unsuccessfulOAuth2TokenValidatorResult