io.smallrye.jwt.config

Class JWTAuthContextInfoProvider

java.lang.Object

io.smallrye.jwt.config.JWTAuthContextInfoProvider

@Dependent
public class JWTAuthContextInfoProvider
extends Object

A CDI provider for the JWTAuthContextInfo that obtains the necessary information from MP config properties.

Constructor Summary

Constructors

Constructor and Description
JWTAuthContextInfoProvider()

Method Summary

Modifier and Type	Method and Description
static JWTAuthContextInfoProvider	createWithCertificate(String keyLocation, String issuer) Create JWTAuthContextInfoProvider with the verification public key location and issuer.
static JWTAuthContextInfoProvider	createWithKey(String publicKey, String issuer) Create JWTAuthContextInfoProvider with the public key and issuer
static JWTAuthContextInfoProvider	createWithKeyLocation(String keyLocation, String issuer) Create JWTAuthContextInfoProvider with the verification public key location and issuer
static JWTAuthContextInfoProvider	createWithSecretKeyLocation(String keyLocation, String issuer) Create JWTAuthContextInfoProvider with the verification secret key location and issuer
protected void	decodeMpJwtPublicKey(JWTAuthContextInfo contextInfo)
JWTAuthContextInfo	getContextInfo()
Optional<String>	getDefaultGroupsClaim()
Optional<String>	getDefaultSubjectClaim()
Optional<Set<String>>	getExpectedAudience()
Optional<Integer>	getExpGracePeriodSecs()
int	getForcedJwksRefreshInterval()
Optional<String>	getGroupsPath()
String	getGroupsSeparator()
Optional<Integer>	getJwksRefreshInterval()
KeyFormat	getKeyFormat()
Optional<Long>	getMaxTimeToLiveSecs()
String	getMpJwtIssuer()
Optional<String>	getMpJwtLocation()
Optional<String>	getMpJwtPublicKey()
Optional<Boolean>	getMpJwtRequireIss()
Optional<Set<String>>	getRequiredClaims()
Optional<SignatureAlgorithm>	getSignatureAlgorithm()
Optional<String>	getSubjectPath()
Optional<String>	getTokenCookie()
String	getTokenHeader()
Optional<String>	getTokenKeyId()
Optional<String>	getTokenSchemes()
Optional<String>	getWhitelistAlgorithms() Deprecated.
boolean	isAlwaysCheckAuthorization()
boolean	isRelaxVerificationKeyValidation()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JWTAuthContextInfoProvider

public JWTAuthContextInfoProvider()

Method Detail

createWithKey

public static JWTAuthContextInfoProvider createWithKey(String publicKey,
                                                       String issuer)

Create JWTAuthContextInfoProvider with the public key and issuer

Parameters:

publicKey - the public key value

issuer - the issuer

Returns:

a new instance of JWTAuthContextInfoProvider

createWithKeyLocation

public static JWTAuthContextInfoProvider createWithKeyLocation(String keyLocation,
                                                               String issuer)

Create JWTAuthContextInfoProvider with the verification public key location and issuer

Parameters:

keyLocation - the verification public key location

issuer - the issuer

Returns:

a new instance of JWTAuthContextInfoProvider

createWithCertificate

public static JWTAuthContextInfoProvider createWithCertificate(String keyLocation,
                                                               String issuer)

Create JWTAuthContextInfoProvider with the verification public key location and issuer. Tokens will be expected to contain either 'x5t' or 'x5t#S256' thumbprints.

Parameters:

keyLocation - certificate location which points to a PEM certificate or JWK containing the certificate chain

issuer - the issuer

Returns:

a new instance of JWTAuthContextInfoProvider

createWithSecretKeyLocation

public static JWTAuthContextInfoProvider createWithSecretKeyLocation(String keyLocation,
                                                                     String issuer)

Create JWTAuthContextInfoProvider with the verification secret key location and issuer

Parameters:

keyLocation - the verification secret key location

issuer - the issuer

Returns:

a new instance of JWTAuthContextInfoProvider

decodeMpJwtPublicKey

protected void decodeMpJwtPublicKey(JWTAuthContextInfo contextInfo)

getMpJwtPublicKey

public Optional<String> getMpJwtPublicKey()

getMpJwtIssuer

public String getMpJwtIssuer()

getMpJwtLocation

public Optional<String> getMpJwtLocation()

getMpJwtRequireIss

public Optional<Boolean> getMpJwtRequireIss()

getTokenHeader

public String getTokenHeader()

getTokenCookie

public Optional<String> getTokenCookie()

isAlwaysCheckAuthorization

public boolean isAlwaysCheckAuthorization()

getTokenKeyId

public Optional<String> getTokenKeyId()

getTokenSchemes

public Optional<String> getTokenSchemes()

getExpGracePeriodSecs

public Optional<Integer> getExpGracePeriodSecs()

getMaxTimeToLiveSecs

public Optional<Long> getMaxTimeToLiveSecs()

getJwksRefreshInterval

public Optional<Integer> getJwksRefreshInterval()

getForcedJwksRefreshInterval

public int getForcedJwksRefreshInterval()

getDefaultGroupsClaim

public Optional<String> getDefaultGroupsClaim()

getGroupsPath

public Optional<String> getGroupsPath()

getGroupsSeparator

public String getGroupsSeparator()

getSubjectPath

public Optional<String> getSubjectPath()

getDefaultSubjectClaim

public Optional<String> getDefaultSubjectClaim()

getWhitelistAlgorithms

@Deprecated
public Optional<String> getWhitelistAlgorithms()

Deprecated.

getSignatureAlgorithm

public Optional<SignatureAlgorithm> getSignatureAlgorithm()

getKeyFormat

public KeyFormat getKeyFormat()

getExpectedAudience

public Optional<Set<String>> getExpectedAudience()

getRequiredClaims

public Optional<Set<String>> getRequiredClaims()

isRelaxVerificationKeyValidation

public boolean isRelaxVerificationKeyValidation()

getContextInfo

@Produces
 @ApplicationScoped
public JWTAuthContextInfo getContextInfo()