com.amazon.simplesignin.ssitoken

Interface ISSITokenValidator<T extends SSITokenMetadata>

All Known Implementing Classes:

SSITokenV1Validator

public interface ISSITokenValidator<T extends SSITokenMetadata>

ISSITokenGenerator defines contract for SSI token decoding and validation APIs.

Method Summary

Modifier and Type	Method and Description
SSITokenInfo<T>	decodeAndVerifyToken(SSIToken ssiToken, IRequestContext requestContext) Decodes an SSIToken and additionally verifies that token signature is valid and token usage is within its validity window.
SSITokenInfo<T>	decodeToken(SSIToken ssiToken, IRequestContext requestContext) Decodes an SSIToken.
SSITokenSchema	getTokenSchema() Returns SSITokenSchema associated with this instance.

Method Detail

getTokenSchema

SSITokenSchema getTokenSchema()

Returns SSITokenSchema associated with this instance.

Returns:

SSITokenSchema.

decodeToken

SSITokenInfo<T> decodeToken(SSIToken ssiToken,
                            IRequestContext requestContext)
                     throws TokenException

Decodes an SSIToken.

Parameters:

ssiToken - SSI token to decode.

requestContext - IRequestContext object which holds additional contextual information about the request.

Returns:

SSITokenInfo.

Throws:

InvalidTokenException - is thrown when the token cannot be decoded when it's malformed.

TokenException - is thrown to indicate other unexpected errors encountered while decoding token.

decodeAndVerifyToken

SSITokenInfo<T> decodeAndVerifyToken(SSIToken ssiToken,
                                     IRequestContext requestContext)
                              throws TokenException

Decodes an SSIToken and additionally verifies that token signature is valid and token usage is within its validity window.

Parameters:

ssiToken - SSI token to decode.

requestContext - IRequestContext object which holds additional contextual information about the request.

Returns:

SSITokenInfo.

Throws:

InvalidTokenException - is thrown when the token cannot be decoded when it's malformed.

InvalidSignatureException - is thrown when the token signature could not be verified.

TokenException - is thrown to indicate other unexpected errors encountered while decoding token.