Index
All Classes and Interfaces|All Packages
A
- addKey(String, JWK) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JWKSStaticSetHandlerImpl
- addKey(String, JWK) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JsonWebKeySetStaticHandler
-
Add a JWK to the known set.
- addPermittedAlgorithm(JsonWebAlgorithm) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JwtValidatorVertxImpl
- addPermittedAlgorithm(JsonWebAlgorithm) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JwtValidatorVertx
-
Add a single algorithm to the current set of permitted algorithms.
- AsyncLoadingCache<K,
V> - Class in uk.co.spudsoft.jwtvalidatorvertx.impl -
Class backed by a Guava Cache that returns a Future for all elements whilst still ensuring that the loader is only called once at a time per element.
- AsyncLoadingCache(Function<V, Long>) - Constructor for class uk.co.spudsoft.jwtvalidatorvertx.impl.AsyncLoadingCache
-
Constructor.
C
- containsKey(K) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.AsyncLoadingCache
-
Return true if the cache already contains a value for the provided key.
- create() - Static method in interface uk.co.spudsoft.jwtvalidatorvertx.JsonWebKeySetStaticHandler
-
Construct an instance of the implementation class that will accept any issuer.
- create(Vertx, Collection<String>, Duration) - Static method in interface uk.co.spudsoft.jwtvalidatorvertx.JwtValidatorVertx
-
Create a JwtValidatorVertx.
- create(WebClient, Collection<String>, Duration) - Static method in interface uk.co.spudsoft.jwtvalidatorvertx.JsonWebKeySetOpenIdDiscoveryHandler
-
Construct an instance of the implementation class.
- create(Collection<String>) - Static method in interface uk.co.spudsoft.jwtvalidatorvertx.JsonWebKeySetStaticHandler
-
Construct an instance of the implementation class.
D
- DiscoveryData - Class in uk.co.spudsoft.jwtvalidatorvertx
-
Represents the data returned in an OpenID Connect Discovery response.
- DiscoveryData(long, JsonObject) - Constructor for class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Constructor.
E
- EdDSA - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
EdDSA using P-521 and SHA-512.
- ES256 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
ECDSA using P-256 and SHA-256.
- ES384 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
ECDSA using P-384 and SHA-384.
- ES512 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
ECDSA using P-521 and SHA-512.
F
- findJwk(String, String) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JWKSOpenIdDiscoveryHandlerImpl
- findJwk(String, String) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JWKSStaticSetHandlerImpl
- findJwk(String, String) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JsonWebKeySetHandler
-
Find a JWK for the given issuer and kid.
- findJwk(DiscoveryData, String) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JWKSOpenIdDiscoveryHandlerImpl
- findJwk(DiscoveryData, String) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JsonWebKeySetOpenIdDiscoveryHandler
-
Find a JWK using the jwks_uri value from the Discovery Data.
G
- get(String) - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get a value from the response.
- get(K, Callable<Future<V>>) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.AsyncLoadingCache
-
Get an item from the cache, returning a Future in case the item is not already there.
- getAcrValuesSupported() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the authentication context class references supposed.
- getAlgorithm() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the algorithm specified in the JWT header.
- getAudience() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the token audience specified in the JWT payload.
- getAuthorizationEndpoint() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the authorization endpoint.
- getClaim(String) - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get a single payload claim by name.
- getClaimAsList(String) - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get a payload claim by name returning a List or Strings.
- getExpiration() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the expiration timestamp specified in the JWT payload.
- getExpirationLocalDateTime() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the expiration timestamp specified in the JWT payload as a LocalDateTime.
- getExpiry() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the expiry time in ms from the epoch.
- getExpiryMs() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWK
-
Get the expiry time in ms from the epoch.
- getFamilyName() - Method in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
Get the name of the family of algorithms that this belongs to.
- getGrantTypesSupported() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the grant types supported.
- getGroups() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the groups specified in the JWT payload.
- getIdTokenSigningAlgValuesSupported() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the token signing algorithms supported.
- getIssuer() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the issuer.
- getIssuer() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the token issuer specified in the JWT payload.
- getJdkAlgName() - Method in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
Get the name of the algorithm, in JDK terminology.
- getJsonWebAlgorithm() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the algorithm specified in the JWT header as a
JsonWebAlgorithm
. - getJwk() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the jwk cached by a successful call to
JWT.getJwk(uk.co.spudsoft.jwtvalidatorvertx.JsonWebKeySetHandler)
. - getJwk(JsonWebKeySetHandler) - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Use the provided OpenIdDiscoveryHandler to call the jwks_uri from the discovery data to obtain the correct JWK for this JWT.
- getJwksUri() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the JWKS URI.
- getKey() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWK
-
Get the key represented by this JWK.
- getKid() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWK
-
Get the key identifier.
- getKid() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the key ID specified in the JWT header.
- getMinKeyLength() - Method in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
Get the minimum length of keys for this algorithm.
- getName() - Method in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
Get the name of the algorithm, in JWT terminology.
- getNotBefore() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the not-valid-before timestamp specified in the JWT payload.
- getNotBeforeLocalDateTime() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the not-valid-before timestamp specified in the JWT payload as a LocalDateTime.
- getParameter() - Method in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
Get the parameter spec needed for configuring a signer.
- getPayloadSize() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the number of claims in the payload.
- getPermittedAlgorithms() - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JwtValidatorVertxImpl
- getPermittedAlgorithms() - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JwtValidatorVertx
-
Get a copy of the current set of permitted algorithms.
- getRegistrationEndpoint() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the registration endpoint.
- getResponseModesSupported() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the response modes supported.
- getResponseTypesSupported() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the response types supported.
- getRoles() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the roles specified in the JWT payload.
- getScope() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the scopes specified in the JWT payload.
- getScopesSupported() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the scopes supported.
- getSignature() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the signature from the JWT.
- getSignatureBase() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the value used to calculate the signature - base64(header) + "." + base64(payload).
- getSubject() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Get the token subject specified in the JWT payload.
- getSubjectTypesSupported() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the subject types supported.
- getSubName() - Method in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
Get any sub-name that the algorithm may have.
- getTokenEndpoint() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the token endpoint.
- getUse() - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWK
-
Get the key use string.
- getUserinfoEndpoint() - Method in class uk.co.spudsoft.jwtvalidatorvertx.DiscoveryData
-
Get the user-info endpoint.
H
- HS256 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
HMAC using SHA-256.
- HS384 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
HMAC using SHA-384.
- HS512 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
HMAC using SHA-512.
J
- JsonWebAlgorithm - Enum Class in uk.co.spudsoft.jwtvalidatorvertx
-
Algorithm for use with JWTs as specified by RFC7518.
- JsonWebKeySetHandler - Interface in uk.co.spudsoft.jwtvalidatorvertx
-
Perform OpenID Connect discovery as per openid-connect-discovery-1_0.
- JsonWebKeySetOpenIdDiscoveryHandler - Interface in uk.co.spudsoft.jwtvalidatorvertx
-
Perform OpenID Connect discovery as per openid-connect-discovery-1_0.
- JsonWebKeySetStaticHandler - Interface in uk.co.spudsoft.jwtvalidatorvertx
-
Manage JWKs manually.
- JWK - Class in uk.co.spudsoft.jwtvalidatorvertx
-
Represent a single Json Web Key as defined in RFC 7517.
- JWK(long, JsonObject) - Constructor for class uk.co.spudsoft.jwtvalidatorvertx.JWK
-
Constructor.
- JWKSOpenIdDiscoveryHandlerImpl - Class in uk.co.spudsoft.jwtvalidatorvertx.impl
-
Default implementation of
JsonWebKeySetHandler
. - JWKSOpenIdDiscoveryHandlerImpl(WebClient, Collection<String>, long) - Constructor for class uk.co.spudsoft.jwtvalidatorvertx.impl.JWKSOpenIdDiscoveryHandlerImpl
-
Constructor.
- JWKSStaticSetHandlerImpl - Class in uk.co.spudsoft.jwtvalidatorvertx.impl
- JWKSStaticSetHandlerImpl(Collection<String>) - Constructor for class uk.co.spudsoft.jwtvalidatorvertx.impl.JWKSStaticSetHandlerImpl
-
Constructor.
- JWT - Class in uk.co.spudsoft.jwtvalidatorvertx
-
A JWT as defined by RFC7519.
- JWT(JsonObject, JsonObject, String, String) - Constructor for class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Constructor.
- JwtValidatorVertx - Interface in uk.co.spudsoft.jwtvalidatorvertx
-
Validate JWTs, obtaining keys via OpenID Discovery is necessary.
- JwtValidatorVertxImpl - Class in uk.co.spudsoft.jwtvalidatorvertx.impl
-
Token validation for vertx - implementation of
JwtValidatorVertx
. - JwtValidatorVertxImpl(JsonWebKeySetHandler) - Constructor for class uk.co.spudsoft.jwtvalidatorvertx.impl.JwtValidatorVertxImpl
-
Constructor.
K
- keySet() - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.AsyncLoadingCache
-
Get an immutable view of the keys currently in the backing map.
N
- none - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
No digital signature or MAC performed.
O
- OpenIdDiscoveryHandler - Interface in uk.co.spudsoft.jwtvalidatorvertx
P
- parseJws(String) - Static method in class uk.co.spudsoft.jwtvalidatorvertx.JWT
-
Parse a JWT in delimited string form.
- performOpenIdDiscovery(String) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JWKSOpenIdDiscoveryHandlerImpl
- performOpenIdDiscovery(String) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.OpenIdDiscoveryHandler
-
Obtain the discovery data for an issuer as per openid-connect-discovery-1_0.
- PS256 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
RSASSA-PSS using SHA-256 and MGF1 with SHA-256.
- PS384 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
RSASSA-PSS using SHA-384 and MGF1 with SHA-384.
- PS512 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
RSASSA-PSS using SHA-512 and MGF1 with SHA-512.
- put(K, V) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.AsyncLoadingCache
-
Associates
value
withkey
in this cache.
R
- removeKey(String, String) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JWKSStaticSetHandlerImpl
- removeKey(String, String) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JsonWebKeySetStaticHandler
-
Remove a JWK from the known set.
- RS256 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
RSASSA-PKCS-v1_5 using SHA-256.
- RS384 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
RSASSA-PKCS-v1_5 using SHA-384.
- RS512 - Enum constant in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
RSASSA-PKCS-v1_5 using SHA-512.
S
- setPermittedAlgorithms(EnumSet<JsonWebAlgorithm>) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JwtValidatorVertxImpl
- setPermittedAlgorithms(EnumSet<JsonWebAlgorithm>) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JwtValidatorVertx
-
Replace the current set of permitted algorithms with a new set.
- setRequireExp(boolean) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JwtValidatorVertxImpl
-
Set to true if the token is required to have an exp claim.
- setRequireExp(boolean) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JwtValidatorVertx
-
Set to true if the token is required to have an exp claim.
- setRequireNbf(boolean) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JwtValidatorVertxImpl
-
Set to true if the token is required to have an nbf claim.
- setRequireNbf(boolean) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JwtValidatorVertx
-
Set to true if the token is required to have an nbf claim.
- setTimeLeewaySeconds(long) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JwtValidatorVertxImpl
-
Set the maximum amount of time that can pass between the exp and now.
- setTimeLeewaySeconds(long) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JwtValidatorVertx
-
Set the maximum amount of time that can pass between the exp and now.
U
- uk.co.spudsoft.jwtvalidatorvertx - package uk.co.spudsoft.jwtvalidatorvertx
- uk.co.spudsoft.jwtvalidatorvertx.impl - package uk.co.spudsoft.jwtvalidatorvertx.impl
V
- validateIssuer(String) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JWKSOpenIdDiscoveryHandlerImpl
- validateIssuer(String) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JWKSStaticSetHandlerImpl
- validateIssuer(String) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JsonWebKeySetHandler
-
Confirm that the issuer matches at least one of the configured acceptable issuer regular expressions.
- validateToken(String, List<String>, boolean) - Method in class uk.co.spudsoft.jwtvalidatorvertx.impl.JwtValidatorVertxImpl
-
Validate the token and either throw an exception or return it's constituent parts.
- validateToken(String, List<String>, boolean) - Method in interface uk.co.spudsoft.jwtvalidatorvertx.JwtValidatorVertx
-
Validate the token and either throw an exception or return it's constituent parts.
- valueOf(String) - Static method in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class uk.co.spudsoft.jwtvalidatorvertx.JsonWebAlgorithm
-
Returns an array containing the constants of this enum class, in the order they are declared.
- verify(JsonWebAlgorithm, byte[], byte[]) - Method in class uk.co.spudsoft.jwtvalidatorvertx.JWK
-
Verify a signature using the key in this JWK.
All Classes and Interfaces|All Packages