Package dev.paseto.jpaseto

Class KeyResolverAdapter

java.lang.Object

dev.paseto.jpaseto.KeyResolverAdapter

All Implemented Interfaces:

KeyResolver

public abstract class KeyResolverAdapter
extends java.lang.Object
implements KeyResolver

An Adapter implementation of the KeyResolver interface that allows subclasses to process only the type of paseto token that is known/expected for a particular case.

The resolvePublicKey(Version, Purpose, FooterClaims) and resolveSharedKey(Version, Purpose, FooterClaims) method implementations delegate to the resolvePublicKeyBytes(Version, Purpose, FooterClaims) and resolveSharedKeyBytes(Version, Purpose, FooterClaims) methods respectively. The latter two methods simply throw exceptions: they represent scenarios expected by calling code in known situations, and it is expected that you override the implementation in those known situations; non-overridden *KeyBytes methods indicates that the token input was unexpected.

If either resolvePublicKey(Version, Purpose, FooterClaims) and resolveSharedKey(Version, Purpose, FooterClaims) are not overridden, one (or both) of the *KeyBytes variants must be overridden depending on your expected use case. You do not have to override any method that does not represent an expected condition.

Since:

0.1

Constructor Summary

Constructors

Constructor	Description
KeyResolverAdapter()

Method Summary

Modifier and Type	Method	Description
java.security.PublicKey	resolvePublicKey(Version version, Purpose purpose, FooterClaims footer)	Returns the signing key that should be used to validate a digital signature for the paseto token.
protected byte[]	resolvePublicKeyBytes(Version version, Purpose purpose, FooterClaims footer)	Convenience method invoked by resolvePublicKey(Version, Purpose, FooterClaims) that obtains the necessary public key bytes.
javax.crypto.SecretKey	resolveSharedKey(Version version, Purpose purpose, FooterClaims footer)	Returns the signing key that should be used to validate a digital signature for the paseto token.
protected byte[]	resolveSharedKeyBytes(Version version, Purpose purpose, FooterClaims footer)	Convenience method invoked by resolveSharedKey(Version, Purpose, FooterClaims) that obtains the necessary signing key bytes.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyResolverAdapter

public KeyResolverAdapter()

Method Detail

resolvePublicKey

public java.security.PublicKey resolvePublicKey(Version version,
                                                Purpose purpose,
                                                FooterClaims footer)

Description copied from interface: KeyResolver

Returns the signing key that should be used to validate a digital signature for the paseto token.

Specified by:

resolvePublicKey in interface KeyResolver

Parameters:

version - the version of the token to be parsed

purpose - the purpose of the token to be parsed

footer - the footer containing claims or plain text of the token to be parsed

Returns:

the public key that should be used to validate a digital signature for the token.

resolveSharedKey

public javax.crypto.SecretKey resolveSharedKey(Version version,
                                               Purpose purpose,
                                               FooterClaims footer)

Description copied from interface: KeyResolver

Returns the signing key that should be used to validate a digital signature for the paseto token.

Specified by:

resolveSharedKey in interface KeyResolver

Parameters:

version - the version of the token to be parsed

purpose - the purpose of the token to be parsed

footer - the footer containing claims or plain text of the token to be parsed

Returns:

the shared key that should be used to decrypt the token.

resolvePublicKeyBytes

protected byte[] resolvePublicKeyBytes(Version version,
                                       Purpose purpose,
                                       FooterClaims footer)

Convenience method invoked by resolvePublicKey(Version, Purpose, FooterClaims) that obtains the necessary public key bytes. This implementation simply throws an exception: if the paseto token parsed is 'public'.

Parameters:

version - the version of the token to be parsed

purpose - the purpose of the token to be parsed

footer - the footer containing claims or plain text of the token to be parsed

Returns:

the signing key bytes to use to verify the paseto token signature.

resolveSharedKeyBytes

protected byte[] resolveSharedKeyBytes(Version version,
                                       Purpose purpose,
                                       FooterClaims footer)

Convenience method invoked by resolveSharedKey(Version, Purpose, FooterClaims) that obtains the necessary signing key bytes. This implementation simply throws an exception: if the paseto token parsed is 'local'.

Parameters:

version - the version of the token to be parsed

purpose - the purpose of the token to be parsed

footer - the footer containing claims or plain text of the token to be parsed

Returns:

the shared key that should be used to decrypt the token.