software.sandc.springframework.security.jwt.consumer

Interface JWTConsumer

All Known Subinterfaces:

JWTAuthority

All Known Implementing Classes:

DefaultJWTAuthority, DefaultJWTConsumer

public interface JWTConsumer

JWTConsumer is the core component of spring security JWT extension. It is responsible for validate tokens and handle authentication requests.

Author:

selimok

Method Summary

Modifier and Type	Method and Description
JWTContext	authenticateJWTRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Authenticate HTTP request if the request contains JWT and related tokens are valid. The created JWTAuthentication object (which is also the part of JWTContext) is implicitly attached into SecurityContextHolder to inform spring security about the authenticated user.
JWTContext	validate(TokenContainer tokenContainer, Parameters parameters) Validate tokens given in a TokenContainer instance.

Method Detail

authenticateJWTRequest

JWTContext authenticateJWTRequest(javax.servlet.http.HttpServletRequest request,
                                  javax.servlet.http.HttpServletResponse response)

Authenticate HTTP request if the request contains JWT and related tokens are valid.

The created JWTAuthentication object (which is also the part of JWTContext) is implicitly attached into SecurityContextHolder to inform spring security about the authenticated user.

Parameters:

request - HTTP request

response - HTTP response

Returns:

A fully fledged JWTContext object.

validate

JWTContext validate(TokenContainer tokenContainer,
                    Parameters parameters)
             throws InvalidTokenException,
                    ExpiredTokenException

Validate tokens given in a TokenContainer instance. Validation procedure checks both JWT integrity and also XSRF (a.k.a CSRF) token validity.

Parameters:

tokenContainer - TokenContainer instance which contains JWT and XSRF tokens.

parameters - Additional parameters to customize processing of the request. Possible parameters and their effects may differ depending on specific implementation. The parameters may be empty or null.

Returns:

A fully fledged JWTContext object.

Throws:

InvalidTokenException - if the token is not valid or its integrity is not ensured.

ExpiredTokenException - if the token is expired.