Package io.quarkus.oidc.common.runtime
Class OidcCommonConfig.Credentials.Jwt
- java.lang.Object
-
- io.quarkus.oidc.common.runtime.OidcCommonConfig.Credentials.Jwt
-
- Enclosing class:
- OidcCommonConfig.Credentials
public static class OidcCommonConfig.Credentials.Jwt extends Object
Supports the client authentication 'client_secret_jwt' and `private_key_jwt` methods which involve sending a JWT token assertion signed with either a client secret or private key.
-
-
Field Summary
Fields Modifier and Type Field Description Optional<String>audienceJWT audience ('aud') claim value.Optional<String>issuerIssuer of the signing key added as a JWT `iss` claim (default: client id)Optional<String>keyFileIf provided, indicates that JWT is signed using a private key in PEM or JWK format.Optional<String>keyIdThe private key id/aliasOptional<String>keyPasswordThe private key passwordOptional<String>keyStoreFileIf provided, indicates that JWT is signed using a private key from a keystoreOptional<String>keyStorePasswordA parameter to specify the password of the keystore file.intlifespanJWT life-span in seconds.Optional<String>secretIf provided, indicates that JWT is signed using a secret keyOidcCommonConfig.Credentials.ProvidersecretProviderIf provided, indicates that JWT is signed using a secret key provided by Secret CredentialsProviderOptional<String>signatureAlgorithmSignature algorithm, also used for thekeyFileproperty.Optional<String>subjectSubject of the signing key added as a JWT 'sub' claim (default: client id)Optional<String>tokenKeyIdKey identifier of the signing key added as a JWT 'kid' header
-
Constructor Summary
Constructors Constructor Description Jwt()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Optional<String>getAudience()Optional<String>getKeyFile()intgetLifespan()Optional<String>getSecret()OidcCommonConfig.Credentials.ProvidergetSecretProvider()Optional<String>getSignatureAlgorithm()Optional<String>getTokenKeyId()voidsetAudience(String audience)voidsetKeyFile(String keyFile)voidsetLifespan(int lifespan)voidsetSecret(String secret)voidsetSecretProvider(OidcCommonConfig.Credentials.Provider secretProvider)voidsetSignatureAlgorithm(String signatureAlgorithm)voidsetTokenKeyId(String tokenKeyId)
-
-
-
Field Detail
-
secret
@ConfigItem public Optional<String> secret
If provided, indicates that JWT is signed using a secret key
-
secretProvider
@ConfigItem public OidcCommonConfig.Credentials.Provider secretProvider
If provided, indicates that JWT is signed using a secret key provided by Secret CredentialsProvider
-
keyFile
@ConfigItem public Optional<String> keyFile
If provided, indicates that JWT is signed using a private key in PEM or JWK format. You can use thesignatureAlgorithmproperty to specify the key algorithm.
-
keyStoreFile
@ConfigItem public Optional<String> keyStoreFile
If provided, indicates that JWT is signed using a private key from a keystore
-
keyStorePassword
@ConfigItem public Optional<String> keyStorePassword
A parameter to specify the password of the keystore file.
-
keyId
@ConfigItem public Optional<String> keyId
The private key id/alias
-
keyPassword
@ConfigItem public Optional<String> keyPassword
The private key password
-
audience
@ConfigItem public Optional<String> audience
JWT audience ('aud') claim value. By default, the audience is set to the address of the OpenId Connect Provider's token endpoint.
-
tokenKeyId
@ConfigItem public Optional<String> tokenKeyId
Key identifier of the signing key added as a JWT 'kid' header
-
issuer
@ConfigItem public Optional<String> issuer
Issuer of the signing key added as a JWT `iss` claim (default: client id)
-
subject
@ConfigItem public Optional<String> subject
Subject of the signing key added as a JWT 'sub' claim (default: client id)
-
signatureAlgorithm
@ConfigItem public Optional<String> signatureAlgorithm
Signature algorithm, also used for thekeyFileproperty. Supported values: RS256, RS384, RS512, PS256, PS384, PS512, ES256, ES384, ES512, HS256, HS384, HS512.
-
lifespan
@ConfigItem(defaultValue="10") public int lifespan
JWT life-span in seconds. It will be added to the time it was issued at to calculate the expiration time.
-
-
Method Detail
-
setSecret
public void setSecret(String secret)
-
getLifespan
public int getLifespan()
-
setLifespan
public void setLifespan(int lifespan)
-
setTokenKeyId
public void setTokenKeyId(String tokenKeyId)
-
getSecretProvider
public OidcCommonConfig.Credentials.Provider getSecretProvider()
-
setSecretProvider
public void setSecretProvider(OidcCommonConfig.Credentials.Provider secretProvider)
-
setSignatureAlgorithm
public void setSignatureAlgorithm(String signatureAlgorithm)
-
setAudience
public void setAudience(String audience)
-
setKeyFile
public void setKeyFile(String keyFile)
-
-