cz.ues.platform.security.uutoken

Class JWTTokenService

java.lang.Object

cz.ues.platform.security.uutoken.JWTTokenService

public class JWTTokenService
extends java.lang.Object

This class provides support for conversion between secured token and UUToken instance. It provides support for handling token.

Since:

UES7-10

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	JWTTokenService.TokenHolder Contains secured and plain form of UUToken.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	APPLICATION_NAME Parameter name for Application URI used in custom claims.
private static java.lang.String	BEARER_PREFIX Prefix for authorization request header field.
private static java.lang.ThreadLocal<JWTTokenService.TokenHolder>	ctxHolder Security context holder.
static java.lang.String	DEFAULT_CONFIG_PATH Path where is stored configuration
private static java.lang.String	DEFAULT_CREATOR_CLASS Class name for default token creator.
private static java.lang.String	DEFAULT_TIME_TOLERANCE This value is used for ignoring small differences between system time on different computers.
private static java.util.logging.Logger	LOGGER Logger instance.
private static java.lang.String	PAR_CREATOR_CLASS Name for token verifier class name.
private static java.lang.String	PAR_TIME_TOLERANCE Name for time tolerance..
private static java.lang.String	PARAM_CONFIG_PATH Name of system property parameter which holds path to configuration.
private static JWTTokenService	singleton Singleton instance.
private static java.lang.Object	SPACE Space used as separator in Authorization header.
private long	timeTolerance Time tolerance.
private TokenCreator	tokenCreator Instance used for token validation.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	JWTTokenService(java.util.Properties parameters) Creates a new instance of UESFormTokenProviderImpl.

Method Summary

Methods

Modifier and Type	Method and Description
private java.lang.String	appendBearerPrefix(java.lang.String securedToken) Add JWTTokenService.BEARER_PREFIX to the given value.
private java.lang.String	getApplication(ReadOnlyJWTClaimsSet claimsSet) Converts audience from the given claim set to string form.
private java.util.List<java.lang.String>	getAudiences(UUToken token) Constructs list of audiences for the specified form token.
private long	getCurrentTime() Returns current time.
java.lang.String	getInitiator() Returns initiator using JWT context stored in the thread security context holder.
private java.io.InputStream	getInputStreamForConfiguration() Returns input stream for configuration.
static JWTTokenService	getInstance() Returns instance of this class.
static JWTTokenService	getInstance(java.util.Properties parameters) Returns instance of this class.
java.lang.String	getPrincipal() Returns principal using JWT context stored in the thread security context holder.
java.lang.String	getSecuredToken(UUToken token) Converts UES form token to secured form.
java.lang.String	getSecurityRealm() Returns security realm using JWT context stored in the thread security context holder.
java.lang.String	getToken() Returns token using the thread security context holder.
private void	initTimeTolerance(java.util.Properties conf) Sets time tolerance attribute.
private void	initTokenCreator(java.util.Properties conf) Initializes token creator.
boolean	isJWTToken(java.lang.String value) Determines whether the passed string may be a JWT token (it checks expected token format but it doesn't parse the value).
private boolean	isTokenValid(UUToken token) Determines whether is the given secured token valid (i.e. it has not been modified and it is not expired).
private java.util.Properties	loadConfiguration() Loads configuration of this service.
UUToken	parseSecuredToken(java.lang.String securedToken) Parses secured token to an UUToken instance.
private java.lang.String	removeBearerPrefix(java.lang.String token) Removes JWTTokenService.BEARER_PREFIX from the given value.
void	removeToken() Removes token from the thread security context holder.
private void	setApplicationName(JWTClaimsSet claimsSet, UUToken uuToken) Restores application name from custom claims if there is no application set in the given UUToken instance.
private void	setCustomClaims(JWTClaimsSet claimsSet, UUToken result) Sets custom claims to a UUToken.
private void	setCustomClaims(UUToken token, JWTClaimsSet claimsSet) Sets additional claims to the given JWTClaimsSet instance.
void	setToken(java.lang.String securedToken) Sets token to using the thread security context holder.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final LOGGER

Logger instance.

PARAM_CONFIG_PATH

private static final PARAM_CONFIG_PATH

Name of system property parameter which holds path to configuration.

See Also:

Constant Field Values

PAR_CREATOR_CLASS

private static final PAR_CREATOR_CLASS

Name for token verifier class name.

See Also:

Constant Field Values

PAR_TIME_TOLERANCE

private static final PAR_TIME_TOLERANCE

Name for time tolerance..

See Also:

Constant Field Values

BEARER_PREFIX

private static final BEARER_PREFIX

Prefix for authorization request header field. (RFC6750).

See Also:

Constant Field Values

SPACE

private static final SPACE

Space used as separator in Authorization header.

DEFAULT_TIME_TOLERANCE

private static final DEFAULT_TIME_TOLERANCE

This value is used for ignoring small differences between system time on different computers. The value unit is a millisecond. The value should be greater than zero.

See Also:

Constant Field Values

ctxHolder

private static final ctxHolder

Security context holder. This attribute realizes the default security context holder.

DEFAULT_CONFIG_PATH

public static final DEFAULT_CONFIG_PATH

Path where is stored configuration

See Also:

Constant Field Values

APPLICATION_NAME

private static final APPLICATION_NAME

Parameter name for Application URI used in custom claims.

See Also:

Constant Field Values

DEFAULT_CREATOR_CLASS

private static final DEFAULT_CREATOR_CLASS

Class name for default token creator.

tokenCreator

private tokenCreator

Instance used for token validation.

timeTolerance

private timeTolerance

Time tolerance.

singleton

private static volatile singleton

Singleton instance.

Constructor Detail

JWTTokenService

private JWTTokenService(java.util.Properties parameters)

Creates a new instance of UESFormTokenProviderImpl.

Since:

UES7-10

Method Detail

getInstance

public static JWTTokenService getInstance()

Returns instance of this class.

Returns:

instance of this class.

Since:

UES7-10

getInstance

public static JWTTokenService getInstance(java.util.Properties parameters)

Returns instance of this class.

Parameters:

parameters - Configuration parameters.

Returns:

instance of this class.

Since:

UES7-10

initTimeTolerance

private void initTimeTolerance(java.util.Properties conf)

Sets time tolerance attribute.

Parameters:

conf - Properties with configuration.

Since:

UES7-10

initTokenCreator

private void initTokenCreator(java.util.Properties conf)

Initializes token creator.

Parameters:

conf - Configuration.

Since:

UES7-10

loadConfiguration

private java.util.Properties loadConfiguration()

Loads configuration of this service.

Returns:

Configuration.

Since:

UES7-10

getInputStreamForConfiguration

private java.io.InputStream getInputStreamForConfiguration()

Returns input stream for configuration.

Returns:

Input stream for configuration.

Since:

UES7-10

getSecuredToken

public java.lang.String getSecuredToken(UUToken token)
throws JWTTokenServiceRTException

Converts UES form token to secured form.

Parameters:

token - UES form token to be converted.

Returns:

Secured form of the given form token.

Throws:

JWTTokenServiceRTException - If the token cannot be converted.

Since:

UES7-10

parseSecuredToken

public UUToken parseSecuredToken(java.lang.String securedToken)
throws JWTTokenServiceRTException

Parses secured token to an UUToken instance.

Parameters:

token - Value to be parsed.

Returns:

Instance of UES form token or the value null if the input value is null.

Throws:

JWTTokenServiceRTException - If the secured token cannot be parsed.

Since:

UES7-10

setApplicationName

private void setApplicationName(JWTClaimsSet claimsSet,
UUToken uuToken)

Restores application name from custom claims if there is no application set in the given UUToken instance.

Parameters:

claimsSet - Claims set.

uuToken - UUToken instance where should be application name.

Since:

UES7-10

getToken

public java.lang.String getToken()

Returns token using the thread security context holder.

Returns:

JWT token.

Since:

UES7-10

setToken

public void setToken(java.lang.String securedToken)

Sets token to using the thread security context holder.

Parameters:

securedToken - JWT token.

Since:

UES7-10

removeToken

public void removeToken()

Removes token from the thread security context holder.

Since:

UES7-10

getPrincipal

public java.lang.String getPrincipal()

Returns principal using JWT context stored in the thread security context holder.

Returns:

Principal.

Since:

UES7-10

getSecurityRealm

public java.lang.String getSecurityRealm()

Returns security realm using JWT context stored in the thread security context holder.

Returns:

Security realm.

Since:

UES8-07

getInitiator

public java.lang.String getInitiator()

Returns initiator using JWT context stored in the thread security context holder.

Returns:

Initiator.

Since:

UES8-05

isJWTToken

public boolean isJWTToken(java.lang.String value)

Determines whether the passed string may be a JWT token (it checks expected token format but it doesn't parse the value).

Parameters:

value - Value to be surveyed.

Returns:

The true if the value may be a JWT token, the value false otherwise.

Since:

UES7-10

isTokenValid

private boolean isTokenValid(UUToken token)

Determines whether is the given secured token valid (i.e. it has not been modified and it is not expired).

Parameters:

securedToken - Secured token.

Returns:

The value true if the secured token is valid; the value false otherwise.

Since:

UES7-10

getCurrentTime

private long getCurrentTime()

Returns current time.

Returns:

Current time in milliseconds.

Since:

UES7-10

getAudiences

private java.util.List<java.lang.String> getAudiences(UUToken token)

Constructs list of audiences for the specified form token.

Parameters:

token - UES form token.

Returns:

List of audiences.

Since:

UES7-10

appendBearerPrefix

private java.lang.String appendBearerPrefix(java.lang.String securedToken)

Add JWTTokenService.BEARER_PREFIX to the given value.

Parameters:

securedToken - Secured token.

Returns:

Updated value.

Since:

UES7-10

removeBearerPrefix

private java.lang.String removeBearerPrefix(java.lang.String token)

Removes JWTTokenService.BEARER_PREFIX from the given value.

Parameters:

token - UUToken value.

Returns:

The token value without the prefix.

Since:

UES7-10

getApplication

private java.lang.String getApplication(ReadOnlyJWTClaimsSet claimsSet)

Converts audience from the given claim set to string form.

Parameters:

claimsSet - Claim set.

Returns:

Audience value.

Since:

UES7-10

setCustomClaims

private void setCustomClaims(UUToken token,
JWTClaimsSet claimsSet)

Sets additional claims to the given JWTClaimsSet instance.

Parameters:

claimsSet - JWTClaimsSet instance.

token - Token which contains additional claims.

Since:

UES7-10

setCustomClaims

private void setCustomClaims(JWTClaimsSet claimsSet,
UUToken result)

Sets custom claims to a UUToken.

Parameters:

claimsSet - Claims set instance.

result - UUToken instance.

Since:

UES7-10