Skip navigation links
A C D E F G H I J M N O P R S V W 

A

AUD - Static variable in interface org.springframework.security.oauth2.jwt.JwtClaimNames
aud - the Audience claim identifies the recipient(s) that the JWT is intended for

C

convert(Map<String, Object>) - Method in class org.springframework.security.oauth2.jwt.MappedJwtClaimSetConverter
createDefault() - Static method in class org.springframework.security.oauth2.jwt.JwtValidators
Create a Jwt Validator that contains all standard validators.
createDefaultWithIssuer(String) - Static method in class org.springframework.security.oauth2.jwt.JwtValidators
Create a Jwt Validator that contains all standard validators when an issuer is known.

D

decode(String) - Method in interface org.springframework.security.oauth2.jwt.JwtDecoder
Decodes the JWT from it's compact claims representation format and returns a Jwt.
decode(String) - Method in class org.springframework.security.oauth2.jwt.NimbusJwtDecoderJwkSupport
 
decode(String) - Method in class org.springframework.security.oauth2.jwt.NimbusReactiveJwtDecoder
 
decode(String) - Method in interface org.springframework.security.oauth2.jwt.ReactiveJwtDecoder
Decodes the JWT from it's compact claims representation format and returns a Jwt.

E

ES256 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
ECDSA using P-256 and SHA-256 (Recommended+)
ES384 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
ECDSA using P-384 and SHA-384 (Optional)
ES512 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
ECDSA using P-521 and SHA-512 (Optional)
EXP - Static variable in interface org.springframework.security.oauth2.jwt.JwtClaimNames
exp - the Expiration time claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing

F

fromOidcIssuerLocation(String) - Static method in class org.springframework.security.oauth2.jwt.JwtDecoders
Creates a JwtDecoder using the provided Issuer by making an OpenID Provider Configuration Request and using the values in the OpenID Provider Configuration Response to initialize the JwtDecoder.
fromOidcIssuerLocation(String) - Static method in class org.springframework.security.oauth2.jwt.ReactiveJwtDecoders
Creates a ReactiveJwtDecoder using the provided Issuer by making an OpenID Provider Configuration Request and using the values in the OpenID Provider Configuration Response to initialize the ReactiveJwtDecoder.

G

getAudience() - Method in interface org.springframework.security.oauth2.jwt.JwtClaimAccessor
Returns the Audience (aud) claim which identifies the recipient(s) that the JWT is intended for.
getClaims() - Method in class org.springframework.security.oauth2.jwt.Jwt
Returns the JWT Claims Set.
getErrors() - Method in exception org.springframework.security.oauth2.jwt.JwtValidationException
Return the list of OAuth2Errors associated with this exception
getExpiresAt() - Method in interface org.springframework.security.oauth2.jwt.JwtClaimAccessor
Returns the Expiration time (exp) claim which identifies the expiration time on or after which the JWT MUST NOT be accepted for processing.
getHeaders() - Method in class org.springframework.security.oauth2.jwt.Jwt
Returns the JOSE header(s).
getId() - Method in interface org.springframework.security.oauth2.jwt.JwtClaimAccessor
Returns the JWT ID (jti) claim which provides a unique identifier for the JWT.
getIssuedAt() - Method in interface org.springframework.security.oauth2.jwt.JwtClaimAccessor
Returns the Issued at (iat) claim which identifies the time at which the JWT was issued.
getIssuer() - Method in interface org.springframework.security.oauth2.jwt.JwtClaimAccessor
Returns the Issuer (iss) claim which identifies the principal that issued the JWT.
getNotBefore() - Method in interface org.springframework.security.oauth2.jwt.JwtClaimAccessor
Returns the Not Before (nbf) claim which identifies the time before which the JWT MUST NOT be accepted for processing.
getSubject() - Method in interface org.springframework.security.oauth2.jwt.JwtClaimAccessor
Returns the Subject (sub) claim which identifies the principal that is the subject of the JWT.

H

HS256 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
HMAC using SHA-256 (Required)
HS384 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
HMAC using SHA-384 (Optional)
HS512 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
HMAC using SHA-512 (Optional)

I

IAT - Static variable in interface org.springframework.security.oauth2.jwt.JwtClaimNames
iat - The Issued at claim identifies the time at which the JWT was issued
ISS - Static variable in interface org.springframework.security.oauth2.jwt.JwtClaimNames
iss - the Issuer claim identifies the principal that issued the JWT

J

JTI - Static variable in interface org.springframework.security.oauth2.jwt.JwtClaimNames
jti - The JWT ID claim provides a unique identifier for the JWT
JwsAlgorithms - Interface in org.springframework.security.oauth2.jose.jws
The cryptographic algorithms defined by the JSON Web Algorithms (JWA) specification and used by JSON Web Signature (JWS) to digitally sign or create a MAC of the contents of the JWS Protected Header and JWS Payload.
Jwt - Class in org.springframework.security.oauth2.jwt
An implementation of an AbstractOAuth2Token representing a JSON Web Token (JWT).
Jwt(String, Instant, Instant, Map<String, Object>, Map<String, Object>) - Constructor for class org.springframework.security.oauth2.jwt.Jwt
Constructs a Jwt using the provided parameters.
JwtClaimAccessor - Interface in org.springframework.security.oauth2.jwt
A ClaimAccessor for the "claims" that may be contained in the JSON object JWT Claims Set of a JSON Web Token (JWT).
JwtClaimNames - Interface in org.springframework.security.oauth2.jwt
The Registered Claim Names defined by the JSON Web Token (JWT) specification that may be contained in the JSON object JWT Claims Set.
JwtDecoder - Interface in org.springframework.security.oauth2.jwt
Implementations of this interface are responsible for "decoding" a JSON Web Token (JWT) from it's compact claims representation format to a Jwt.
JwtDecoders - Class in org.springframework.security.oauth2.jwt
Allows creating a JwtDecoder from an OpenID Provider Configuration.
JwtException - Exception in org.springframework.security.oauth2.jwt
Base exception for all JSON Web Token (JWT) related errors.
JwtException(String) - Constructor for exception org.springframework.security.oauth2.jwt.JwtException
Constructs a JwtException using the provided parameters.
JwtException(String, Throwable) - Constructor for exception org.springframework.security.oauth2.jwt.JwtException
Constructs a JwtException using the provided parameters.
JwtIssuerValidator - Class in org.springframework.security.oauth2.jwt
Validates the "iss" claim in a Jwt, that is matches a configured value
JwtIssuerValidator(String) - Constructor for class org.springframework.security.oauth2.jwt.JwtIssuerValidator
Constructs a JwtIssuerValidator using the provided parameters
JwtTimestampValidator - Class in org.springframework.security.oauth2.jwt
An implementation of OAuth2TokenValidator for verifying claims in a Jwt-based access token
JwtTimestampValidator() - Constructor for class org.springframework.security.oauth2.jwt.JwtTimestampValidator
A basic instance with no custom verification and the default max clock skew
JwtTimestampValidator(Duration) - Constructor for class org.springframework.security.oauth2.jwt.JwtTimestampValidator
 
JwtValidationException - Exception in org.springframework.security.oauth2.jwt
An exception that results from an unsuccessful OAuth2TokenValidatorResult
JwtValidationException(String, Collection<OAuth2Error>) - Constructor for exception org.springframework.security.oauth2.jwt.JwtValidationException
Constructs a JwtValidationException using the provided parameters While each OAuth2Error does contain an error description, this constructor can take an overarching description that encapsulates the composition of failures That said, it is appropriate to pass one of the messages from the error list in as the exception description, for example:
JwtValidators - Class in org.springframework.security.oauth2.jwt
Provides factory methods for creating OAuth2TokenValidator<Jwt>

M

MappedJwtClaimSetConverter - Class in org.springframework.security.oauth2.jwt
Converts a JWT claim set, claim by claim.
MappedJwtClaimSetConverter(Map<String, Converter<Object, ?>>) - Constructor for class org.springframework.security.oauth2.jwt.MappedJwtClaimSetConverter
Constructs a MappedJwtClaimSetConverter with the provided arguments This will completely replace any set of default converters.

N

NBF - Static variable in interface org.springframework.security.oauth2.jwt.JwtClaimNames
nbf - the Not Before claim identifies the time before which the JWT MUST NOT be accepted for processing
NimbusJwtDecoderJwkSupport - Class in org.springframework.security.oauth2.jwt
An implementation of a JwtDecoder that "decodes" a JSON Web Token (JWT) and additionally verifies it's digital signature if the JWT is a JSON Web Signature (JWS).
NimbusJwtDecoderJwkSupport(String) - Constructor for class org.springframework.security.oauth2.jwt.NimbusJwtDecoderJwkSupport
Constructs a NimbusJwtDecoderJwkSupport using the provided parameters.
NimbusJwtDecoderJwkSupport(String, String) - Constructor for class org.springframework.security.oauth2.jwt.NimbusJwtDecoderJwkSupport
Constructs a NimbusJwtDecoderJwkSupport using the provided parameters.
NimbusReactiveJwtDecoder - Class in org.springframework.security.oauth2.jwt
An implementation of a ReactiveJwtDecoder that "decodes" a JSON Web Token (JWT) and additionally verifies it's digital signature if the JWT is a JSON Web Signature (JWS).
NimbusReactiveJwtDecoder(RSAPublicKey) - Constructor for class org.springframework.security.oauth2.jwt.NimbusReactiveJwtDecoder
 
NimbusReactiveJwtDecoder(String) - Constructor for class org.springframework.security.oauth2.jwt.NimbusReactiveJwtDecoder
Constructs a NimbusJwtDecoderJwkSupport using the provided parameters.

O

org.springframework.security.oauth2.jose.jws - package org.springframework.security.oauth2.jose.jws
Core classes and interfaces providing support for JSON Web Signature (JWS).
org.springframework.security.oauth2.jwt - package org.springframework.security.oauth2.jwt
Core classes and interfaces providing support for JSON Web Token (JWT).

P

PS256 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
RSASSA-PSS using SHA-256 and MGF1 with SHA-256 (Optional)
PS384 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
RSASSA-PSS using SHA-384 and MGF1 with SHA-384 (Optional)
PS512 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
RSASSA-PSS using SHA-512 and MGF1 with SHA-512 (Optional)

R

ReactiveJwtDecoder - Interface in org.springframework.security.oauth2.jwt
Implementations of this interface are responsible for "decoding" a JSON Web Token (JWT) from it's compact claims representation format to a Jwt.
ReactiveJwtDecoders - Class in org.springframework.security.oauth2.jwt
RS256 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
RSASSA-PKCS1-v1_5 using SHA-256 (Recommended)
RS384 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
RSASSA-PKCS1-v1_5 using SHA-384 (Optional)
RS512 - Static variable in interface org.springframework.security.oauth2.jose.jws.JwsAlgorithms
RSASSA-PKCS1-v1_5 using SHA-512 (Optional)

S

setClaimSetConverter(Converter<Map<String, Object>, Map<String, Object>>) - Method in class org.springframework.security.oauth2.jwt.NimbusJwtDecoderJwkSupport
Use the following Converter for manipulating the JWT's claim set
setClock(Clock) - Method in class org.springframework.security.oauth2.jwt.JwtTimestampValidator
' Use this Clock with Instant.now() for assessing timestamp validity
setJwtValidator(OAuth2TokenValidator<Jwt>) - Method in class org.springframework.security.oauth2.jwt.NimbusJwtDecoderJwkSupport
Use this Jwt Validator
setJwtValidator(OAuth2TokenValidator<Jwt>) - Method in class org.springframework.security.oauth2.jwt.NimbusReactiveJwtDecoder
Use the provided OAuth2TokenValidator to validate incoming Jwts.
setRestOperations(RestOperations) - Method in class org.springframework.security.oauth2.jwt.NimbusJwtDecoderJwkSupport
Sets the RestOperations used when requesting the JSON Web Key (JWK) Set.
SUB - Static variable in interface org.springframework.security.oauth2.jwt.JwtClaimNames
sub - the Subject claim identifies the principal that is the subject of the JWT

V

validate(Jwt) - Method in class org.springframework.security.oauth2.jwt.JwtIssuerValidator
validate(Jwt) - Method in class org.springframework.security.oauth2.jwt.JwtTimestampValidator

W

withDefaults(Map<String, Converter<Object, ?>>) - Static method in class org.springframework.security.oauth2.jwt.MappedJwtClaimSetConverter
Construct a MappedJwtClaimSetConverter, overriding individual claim converters with the provided Map of Converters.
A C D E F G H I J M N O P R S V W 
Skip navigation links