Module io.inverno.mod.security.jose

Package io.inverno.mod.security.jose.internal.jwk

Class AbstractJWK

java.lang.Object

io.inverno.mod.security.jose.internal.jwk.AbstractJWK

All Implemented Interfaces:

JWK

Direct Known Subclasses:

AbstractX509JWK, GenericOCTJWK, GenericPBES2JWK

public abstract class AbstractJWK
extends Object
implements JWK

Base JSON Web Key implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
protected String	alg	The Algorithm parameter as defined by RFC7517 Section 4.4.
protected final Key	key	The underlying key.
protected Set<String>	key_ops	The Key Operations parameter as defined by RFC7517 Section 4.3.
protected String	kid	The Key id parameter as defined by RFC7517 Section 4.5.
protected final String	kty	The key type parameter as defined by RFC7517 Section 4.1.
protected boolean	trusted	Indicates whether the JWK can be trusted.
protected String	use	The Public Key Use parameter as defined by RFC7517 Section 4.2.

Fields inherited from interface io.inverno.mod.security.jose.jwk.JWK

KEY_OP_DECRYPT, KEY_OP_DERIVE_BITS, KEY_OP_DERIVE_KEY, KEY_OP_ENCRYPT, KEY_OP_SIGN, KEY_OP_UNWRAP_KEY, KEY_OP_VERIFY, KEY_OP_WRAP_KEY, USE_ENC, USE_SIG

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJWK(String kty)	Creates an untrusted JWK.
protected	AbstractJWK(String kty, Key key, boolean trusted)	Creates a JWK with the specified key.

Method Summary

Modifier and Type	Method	Description
protected void	checkEncryption(JWAAlgorithm<?> algorithm)	Checks that the key and the specified algorithm supports encryption operations.
protected void	checkKeyManagement(JWAAlgorithm<?> algorithm)	Checks that the key and the specified algorithm supports key management operations.
protected void	checkSignature(JWAAlgorithm<?> algorithm)	Checks that the key and the specified algorithm supports signature operations.
JWACipher	cipher()	Returns a cipher using this JWK.
JWACipher	cipher(String alg)	Returns a cipher using this JWK and the specified algorithm.
boolean	equals(Object obj)
String	getAlgorithm()	Returns the algorithm intended for use with the key.
static MessageDigest	getDefaultThumbprintDigest()	Returns the default message digest to generate JWK thumbprint.
Key	getKey()	Returns the key.
String	getKeyId()	Returns the key id.
Set<String>	getKeyOperations()	Returns the set of key operations.
String	getKeyType()	Returns the key type.
String	getPublicKeyUse()	Returns the public key use.
int	hashCode()
boolean	isTrusted()	Determines whether this key is trusted.
JWAKeyManager	keyManager()	Returns a key manager using this JWK.
JWAKeyManager	keyManager(String alg)	Returns a key manager using this JWK and the specified algorithm.
void	setAlgorithm(String alg)	Sets the algorithm intended for use with the key.
void	setKeyId(String kid)	Sets the id of the key.
void	setKeyOperations(Set<String> key_ops)	Sets the key operations for which the key is intended to be used.
void	setPublicKeyUse(String use)	Sets the intended use of the public key: signature (sig) or encryption (enc).
JWASigner	signer()	Returns a signer using this JWK.
JWASigner	signer(String alg)	Returns a signer using this JWK and the specified algorithm.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.inverno.mod.security.jose.jwk.JWK

minify, supportsAlgorithm, toJWKThumbprint, toJWKThumbprint, toPublicJWK, trust

Field Details

key

protected final Key key

The underlying key.

kty

protected final String kty

The key type parameter as defined by RFC7517 Section 4.1.

use

protected String use

The Public Key Use parameter as defined by RFC7517 Section 4.2.

key_ops

protected Set<String> key_ops

The Key Operations parameter as defined by RFC7517 Section 4.3.

alg

protected String alg

The Algorithm parameter as defined by RFC7517 Section 4.4.

kid

protected String kid

The Key id parameter as defined by RFC7517 Section 4.5.

trusted

protected boolean trusted

Indicates whether the JWK can be trusted.

Constructor Details

AbstractJWK

protected AbstractJWK(String kty)
               throws JWKProcessingException

Creates an untrusted JWK.

Parameters:

kty - the key type

Throws:

JWKProcessingException - if the key type is blank

AbstractJWK

protected AbstractJWK(String kty,
 Key key,
 boolean trusted)
               throws JWKProcessingException

Creates a JWK with the specified key.

Parameters:

kty - the key type

key - a key

trusted - true to create a trusted JWK, false otherwise

Throws:

JWKProcessingException - if the key type is blank

Method Details

getDefaultThumbprintDigest

public static MessageDigest getDefaultThumbprintDigest()

Returns the default message digest to generate JWK thumbprint.

Returns:

a message digest

getKeyType

public String getKeyType()

Description copied from interface: JWK

Returns the key type.

Specified by:

getKeyType in interface JWK

Returns:

the key type

getPublicKeyUse

public String getPublicKeyUse()

Description copied from interface: JWK

Returns the public key use.

Specified by:

getPublicKeyUse in interface JWK

Returns:

the public key use

setPublicKeyUse

public void setPublicKeyUse(String use)

Sets the intended use of the public key: signature (sig) or encryption (enc).

Parameters:

use - the public key use

getKeyOperations

public Set<String> getKeyOperations()

Description copied from interface: JWK

Returns the set of key operations.

Specified by:

getKeyOperations in interface JWK

Returns:

the set of key operations

setKeyOperations

public void setKeyOperations(Set<String> key_ops)

Sets the key operations for which the key is intended to be used.

Parameters:

key_ops - a set of key operations

getAlgorithm

public String getAlgorithm()

Description copied from interface: JWK

Returns the algorithm intended for use with the key.

Specified by:

getAlgorithm in interface JWK

Returns:

the key algorithm

setAlgorithm

public void setAlgorithm(String alg)

Sets the algorithm intended for use with the key.

Parameters:

alg - the JWA algorithm

getKeyId

public String getKeyId()

Description copied from interface: JWK

Returns the key id.

Specified by:

getKeyId in interface JWK

Returns:

the key id

setKeyId

public void setKeyId(String kid)

Sets the id of the key.

Parameters:

kid - the key id

getKey

public Key getKey()

Returns the key.

Returns:

a key

isTrusted

public boolean isTrusted()

Description copied from interface: JWK

Determines whether this key is trusted.

Untrusted keys are typically resolved from unsecured JOSE headers (e.g. no x5c, no x5u...), the are excluded when reading a JOSE object for obvious security reasons.

Implementations can rely on trust stores or certificate paths validation to determine whether a key is trusted. It is also possible to explicitly trust a key by invoking the JWK.trust(). method.

Specified by:

isTrusted in interface JWK

Returns:

true if the key is trusted, false otherwise.

signer

public JWASigner signer()
                 throws JWKProcessingException

Description copied from interface: JWK

Returns a signer using this JWK.

Specified by:

signer in interface JWK

Returns:

a signer

Throws:

JWKProcessingException - if the JWK does not support signature operations (i.e. missing algorithm, algorithm is not a signature algorithm...)

signer

public JWASigner signer(String alg)
                 throws JWKProcessingException

Description copied from interface: JWK

Returns a signer using this JWK and the specified algorithm.

Specified by:

signer in interface JWK

Parameters:

alg - a JWA signature algorithm

Returns:

a signer

Throws:

JWKProcessingException - if the JWK does not support signature operations or if the specified algorithm is not a supported signature algorithm

checkSignature

protected void checkSignature(JWAAlgorithm<?> algorithm)
                       throws JWKProcessingException

Checks that the key and the specified algorithm supports signature operations.

Parameters:

algorithm - a JWA algorithm

Throws:

JWKProcessingException - if the key and/or the specified algorithm do not support signature operations

cipher

public JWACipher cipher()
                 throws JWKProcessingException

Description copied from interface: JWK

Returns a cipher using this JWK.

Specified by:

cipher in interface JWK

Returns:

a cipher

Throws:

JWKProcessingException - if the JWK does not support encryption operations (i.e. missing algorithm, algorithm is not an encryption algorithm...)

cipher

public JWACipher cipher(String alg)
                 throws JWKProcessingException

Description copied from interface: JWK

Returns a cipher using this JWK and the specified algorithm.

Specified by:

cipher in interface JWK

Parameters:

alg - a JWA encryption algorithm

Returns:

a cipher

Throws:

JWKProcessingException - if the JWK does not support encryption operations or if the specified algorithm is not a supported encryption algorithm

checkEncryption

protected void checkEncryption(JWAAlgorithm<?> algorithm)
                        throws JWKProcessingException

Checks that the key and the specified algorithm supports encryption operations.

Parameters:

algorithm - a JWA algorithm

Throws:

JWKProcessingException - if the key and/or the specified algorithm do not support encryption operations

keyManager

public JWAKeyManager keyManager()
                         throws JWKProcessingException

Description copied from interface: JWK

Returns a key manager using this JWK.

Specified by:

keyManager in interface JWK

Returns:

a key manager

Throws:

JWKProcessingException - if the JWK does not support key management operations (i.e. missing algorithm, algorithm is not a key management algorithm...)

keyManager

public JWAKeyManager keyManager(String alg)
                         throws JWKProcessingException

Description copied from interface: JWK

Returns a key manager using this JWK and the specified algorithm.

Specified by:

keyManager in interface JWK

Parameters:

alg - a JWA key management algorithm

Returns:

a key manager

Throws:

JWKProcessingException - if the JWK does not support key management operations or if the specified algorithm is not a supported key management algorithm

checkKeyManagement

protected void checkKeyManagement(JWAAlgorithm<?> algorithm)
                           throws JWKProcessingException

Checks that the key and the specified algorithm supports key management operations.

Parameters:

algorithm - a JWA algorithm

Throws:

JWKProcessingException - if the key and/or the specified algorithm do not support key management operations

hashCode

public int hashCode()

Specified by:

hashCode in interface JWK

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface JWK

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object