Package org.pac4j.jwt.credentials.authenticator

Class JwtAuthenticator

java.lang.Object

org.pac4j.core.util.InitializableObject

org.pac4j.core.profile.definition.ProfileDefinitionAware

org.pac4j.jwt.credentials.authenticator.JwtAuthenticator

All Implemented Interfaces:

Authenticator

public class JwtAuthenticator
extends ProfileDefinitionAware
implements Authenticator

Authenticator for JWT. It creates the user profile and stores it in the credentials for the AuthenticatorProfileCreator.

Since:

1.8.0

Author:

Jerome Leleu

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.slf4j.Logger	logger

Fields inherited from interface org.pac4j.core.credentials.authenticator.Authenticator

ALWAYS_VALIDATE, NEVER_VALIDATE

Constructor Summary

Constructors

Constructor	Description
JwtAuthenticator()	Constructor for JwtAuthenticator.
JwtAuthenticator(List<SignatureConfiguration> signatureConfigurations)	Constructor for JwtAuthenticator.
JwtAuthenticator(List<SignatureConfiguration> signatureConfigurations, List<EncryptionConfiguration> encryptionConfigurations)	Constructor for JwtAuthenticator.
JwtAuthenticator(SignatureConfiguration signatureConfiguration)	Constructor for JwtAuthenticator.
JwtAuthenticator(SignatureConfiguration signatureConfiguration, EncryptionConfiguration encryptionConfiguration)	Constructor for JwtAuthenticator.

Method Summary

Modifier and Type	Method	Description
void	addEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	addEncryptionConfiguration.
void	addSignatureConfiguration(SignatureConfiguration signatureConfiguration)	addSignatureConfiguration.
protected void	createJwtProfile(CallContext ctx, TokenCredentials credentials, com.nimbusds.jwt.JWT jwt)	createJwtProfile.
Date	getExpirationTime()	Getter for the field expirationTime.
protected void	internalInit(boolean forceReinit)
void	setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)	setEncryptionConfiguration.
void	setEncryptionConfigurations(List<EncryptionConfiguration> encryptionConfigurations)	Setter for the field encryptionConfigurations.
void	setExpirationTime(Date expirationTime)	Setter for the field expirationTime.
void	setSignatureConfiguration(SignatureConfiguration signatureConfiguration)	setSignatureConfiguration.
void	setSignatureConfigurations(List<SignatureConfiguration> signatureConfigurations)	Setter for the field signatureConfigurations.
Optional<Credentials>	validate(CallContext ctx, Credentials cred)
UserProfile	validateToken(String token)	Validates the token and returns the corresponding user profile.
Map<String,Object>	validateTokenAndGetClaims(String token)	Validates the token and returns the corresponding user profile.

Methods inherited from class org.pac4j.core.profile.definition.ProfileDefinitionAware

getProfileDefinition, setProfileDefinition, setProfileDefinitionIfUndefined

Methods inherited from class org.pac4j.core.util.InitializableObject

afterInternalInit, beforeInternalInit, getInitialized, getLastAttempt, getMaxAttempts, getMinTimeIntervalBetweenAttemptsInMilliseconds, getNbAttempts, init, init, isInitialized, reinit, setMaxAttempts, setMinTimeIntervalBetweenAttemptsInMilliseconds, shouldInitialize, toString

Methods inherited from class java.lang.Object

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

Field Details

logger

protected final org.slf4j.Logger logger

Constructor Details

JwtAuthenticator

public JwtAuthenticator()

Constructor for JwtAuthenticator.

JwtAuthenticator

public JwtAuthenticator(List<SignatureConfiguration> signatureConfigurations)

Constructor for JwtAuthenticator.

Parameters:

signatureConfigurations - a List object

JwtAuthenticator

public JwtAuthenticator(List<SignatureConfiguration> signatureConfigurations,
 List<EncryptionConfiguration> encryptionConfigurations)

Constructor for JwtAuthenticator.

Parameters:

signatureConfigurations - a List object

encryptionConfigurations - a List object

JwtAuthenticator

public JwtAuthenticator(SignatureConfiguration signatureConfiguration)

Constructor for JwtAuthenticator.

Parameters:

signatureConfiguration - a SignatureConfiguration object

JwtAuthenticator

public JwtAuthenticator(SignatureConfiguration signatureConfiguration,
 EncryptionConfiguration encryptionConfiguration)

Constructor for JwtAuthenticator.

Parameters:

signatureConfiguration - a SignatureConfiguration object

encryptionConfiguration - a EncryptionConfiguration object

Method Details

internalInit

protected void internalInit(boolean forceReinit)

Specified by:

internalInit in class InitializableObject

validateTokenAndGetClaims

public Map<String,Object> validateTokenAndGetClaims(String token)

Validates the token and returns the corresponding user profile.

Parameters:

token - the JWT

Returns:

the corresponding user profile

validateToken

public UserProfile validateToken(String token)

Validates the token and returns the corresponding user profile.

Parameters:

token - the JWT

Returns:

the corresponding user profile

validate

public Optional<Credentials> validate(CallContext ctx,
 Credentials cred)

Specified by:

validate in interface Authenticator

createJwtProfile

protected void createJwtProfile(CallContext ctx,
 TokenCredentials credentials,
 com.nimbusds.jwt.JWT jwt)
                         throws ParseException

createJwtProfile.

Parameters:

ctx - a CallContext object

credentials - a TokenCredentials object

jwt - a JWT object

Throws:

ParseException - if any.

setSignatureConfiguration

public void setSignatureConfiguration(SignatureConfiguration signatureConfiguration)

setSignatureConfiguration.

Parameters:

signatureConfiguration - a SignatureConfiguration object

addSignatureConfiguration

public void addSignatureConfiguration(SignatureConfiguration signatureConfiguration)

addSignatureConfiguration.

Parameters:

signatureConfiguration - a SignatureConfiguration object

setSignatureConfigurations

public void setSignatureConfigurations(List<SignatureConfiguration> signatureConfigurations)

Setter for the field signatureConfigurations.

Parameters:

signatureConfigurations - a List object

setEncryptionConfiguration

public void setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

setEncryptionConfiguration.

Parameters:

encryptionConfiguration - a EncryptionConfiguration object

addEncryptionConfiguration

public void addEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

addEncryptionConfiguration.

Parameters:

encryptionConfiguration - a EncryptionConfiguration object

setEncryptionConfigurations

public void setEncryptionConfigurations(List<EncryptionConfiguration> encryptionConfigurations)

Setter for the field encryptionConfigurations.

Parameters:

encryptionConfigurations - a List object

setExpirationTime

public void setExpirationTime(Date expirationTime)

Setter for the field expirationTime.

Parameters:

expirationTime - a Date object

getExpirationTime

public Date getExpirationTime()

Getter for the field expirationTime.

Returns:

a Date object