Interface JwksSignatureConfiguration
- All Superinterfaces:
io.micronaut.core.naming.Named
- All Known Implementing Classes:
JwksSignatureConfigurationProperties
public interface JwksSignatureConfiguration
extends io.micronaut.core.naming.Named
JSON Web Key Set Configuration.
- Since:
- 1.1.0
- Author:
- Sergio del Amo
-
Method Summary
Modifier and TypeMethodDescription@NonNull IntegerDeprecated, for removal: This API element is subject to removal in a future version.Not used.default @Nullable StringThe issuer this JSON Web Key Set is bound to.@Nullable com.nimbusds.jose.jwk.KeyTypeRepresentation the KeyType for this JWKS signature configuration.@NonNull StringgetUrl()Json Web Key Set endpoint url.Methods inherited from interface io.micronaut.core.naming.Named
getName
-
Method Details
-
getUrl
@NonNull String getUrl()Json Web Key Set endpoint url.- Returns:
- returns a url where a JWKS is exposed.
-
getKeyType
@Nullable com.nimbusds.jose.jwk.KeyType getKeyType()Representation the KeyType for this JWKS signature configuration. KeyType is the kty parameter in a JSON Web Key (JWK). When a key type is returned, only keys of that type are used to verify token signatures; a token signed with a key of another type is not verified, even if that key is part of the JWKS.- Returns:
- The KeyType for the JWKS signature configuration, or
nullif keys of any type are matched.
-
getCacheExpiration
Deprecated, for removal: This API element is subject to removal in a future version.Not used. JWKS is cached via Micronaut Cache. You need an implementation of Micronaut Cache and the cache configuration micronaut.caches.jwks.expire-after-write- Returns:
- The number of seconds to cache the JWKS.
-
getIssuer
The issuer this JSON Web Key Set is bound to. When an issuer is set, a token is only verified with this key set if itsissclaim matches the issuer, even if its signature validates against one of the keys. This prevents a key trusted for one identity provider from signing tokens that claim to be issued by another provider.- Returns:
- The issuer the key set is bound to, or
nullif tokens are verified regardless of theirissclaim. - Since:
- 5.5.2
-