org.forgerock.jaspi.modules.session.jwt

Interface JwtCryptographyHandler

All Known Implementing Classes:

KeyStoreJwtCryptographyHandler, SecretsProviderJwtCryptographyHandler

public interface JwtCryptographyHandler

An abstraction of the cryptographic operations that the JWT session modules will need to do to create a read JWTs.

Method Summary

Modifier and Type	Method and Description
void	decrypt(EncryptedThenSignedJwt jwt) Decrypt the JWT.
void	initialize(Map<String,Object> options) Initialise the handler.
EncryptedJwtBuilder	jwe(JwtBuilderFactory jwtbuilder) Apply encryption to the JWT.
EncryptedThenSignedJwtBuilder	sign(EncryptedJwtBuilder jwtbuilder) Sign the JWT.
boolean	verify(EncryptedThenSignedJwt jwt) Verify the JWT.

Method Detail

initialize

void initialize(Map<String,Object> options)
         throws AuthenticationException

Initialise the handler.

Parameters:

options - The options to be used.

Throws:

AuthenticationException - If the options are invalid.

verify

boolean verify(EncryptedThenSignedJwt jwt)

Verify the JWT.

Parameters:

jwt - The JWT.

Returns:

true if the JWT is valid.

decrypt

void decrypt(EncryptedThenSignedJwt jwt)

Decrypt the JWT.

Parameters:

jwt - The JWT.

jwe

EncryptedJwtBuilder jwe(JwtBuilderFactory jwtbuilder)

Apply encryption to the JWT.

Parameters:

jwtbuilder - The JWT builder.

Returns:

The JWT builder after applying encryption.

sign

EncryptedThenSignedJwtBuilder sign(EncryptedJwtBuilder jwtbuilder)

Sign the JWT.

Parameters:

jwtbuilder - The JWT builder.

Returns:

The JWT builder after signing.