Package se.swedenconnect.security.credential.nimbus

Class JwkMetadataProperties

java.lang.Object

se.swedenconnect.security.credential.nimbus.JwkMetadataProperties

public class JwkMetadataProperties
extends Object

Symbolic constants for storing JWK properties in a PkiCredential.Metadata object. The class also offers utility methods for setting and getting JWK related properties.

Author:

Martin Lindström

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOSE_ALGORITHM_PROPERTY	Property name for the JOSE algorithm metadata property.
static final String	KEY_OPS_PROPERTY	Property name for the key operations metadata property.
static final String	KEY_USE_PROPERTY	Property name for the key use metadata property.

Method Summary

Modifier and Type	Method	Description
static Algorithm	getJoseAlgorithm(PkiCredential.Metadata metadata)	Gets the value of the "jose-alg" property.
static Set<KeyOperation>	getKeyOps(PkiCredential.Metadata metadata)	Gets the value for the "key-ops" property.
static KeyUse	getKeyUse(PkiCredential.Metadata metadata)	Gets the value of the "key-use".
static void	setJoseAlgorithm(PkiCredential.Metadata metadata, Algorithm joseAlgorithm)	Utility method that assigns the "jose-alg".
static void	setJoseAlgorithm(PkiCredential.Metadata metadata, String joseAlgorithm)	Utility method that assigns the "jose-alg".
static void	setKeyOps(PkiCredential.Metadata metadata, String keyOps)	Utility method that assigns the "key-ops".
static void	setKeyOps(PkiCredential.Metadata metadata, List<String> keyOps)	Utility method that assigns the "key-ops".
static void	setKeyOps(PkiCredential.Metadata metadata, Set<KeyOperation> keyOps)	Utility method that assigns the "key-ops".
static void	setKeyUse(PkiCredential.Metadata metadata, KeyUse keyUse)	Utility method that is used to assign the "key-use" property.
static void	setKeyUse(PkiCredential.Metadata metadata, String keyUse)	Utility method that is used to assign the "key-use" property.

Methods inherited from class java.lang.Object

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

Field Details

KEY_USE_PROPERTY

public static final String KEY_USE_PROPERTY

Property name for the key use metadata property. Maps to JWK's use property. Should hold a KeyUse or a String.

See Also:

• Constant Field Values

KEY_OPS_PROPERTY

public static final String KEY_OPS_PROPERTY

Property name for the key operations metadata property. Maps to JWK's ops property. Should hold a Set of KeyOperations or a comma-separated list of Strings.

See Also:

• Constant Field Values

JOSE_ALGORITHM_PROPERTY

public static final String JOSE_ALGORITHM_PROPERTY

Property name for the JOSE algorithm metadata property. Maps to JWK's alg property. Should hold a Algorithm or a String representation.

See Also:

• Constant Field Values

Method Details

setKeyUse

public static void setKeyUse(@Nonnull
 PkiCredential.Metadata metadata,
 @Nullable
 String keyUse)

Utility method that is used to assign the "key-use" property. See setKeyUse(PkiCredential.Metadata, KeyUse).

Parameters:

metadata - the Metadata object

keyUse - the key use string

setKeyUse

public static void setKeyUse(@Nonnull
 PkiCredential.Metadata metadata,
 @Nullable
 KeyUse keyUse)

Utility method that is used to assign the "key-use" property.

As a side-effect, the method will also update the PkiCredential.Metadata.USAGE_PROPERTY. KeyUse.SIGNATURE maps to PkiCredential.Metadata.USAGE_SIGNING and KeyUse.ENCRYPTION maps to PkiCredential.Metadata.USAGE_ENCRYPTION.

If the supplied KeyUse is KeyUse.SIGNATURE or KeyUse.ENCRYPTION

Parameters:

metadata - the Metadata object

keyUse - the key use

getKeyUse

@Nullable
public static KeyUse getKeyUse(@Nonnull
 PkiCredential.Metadata metadata)

Gets the value of the "key-use".

If no value is stored for the "key-use", but a value exists for PkiCredential.Metadata.USAGE_PROPERTY, this value is mapped to a KeyUse.

Parameters:

metadata - the Metadata object

Returns:

a KeyUse or null

setKeyOps

public static void setKeyOps(@Nonnull
 PkiCredential.Metadata metadata,
 @Nullable
 List<String> keyOps)
                      throws IllegalArgumentException

Utility method that assigns the "key-ops". See setKeyOps(PkiCredential.Metadata, Set).

Parameters:

metadata - the Metadata object

keyOps - a list of key operations (or null for resetting the property)

Throws:

IllegalArgumentException - for invalid key operations, see KeyOperation.parse(List)

setKeyOps

public static void setKeyOps(@Nonnull
 PkiCredential.Metadata metadata,
 @Nullable
 String keyOps)
                      throws IllegalArgumentException

Utility method that assigns the "key-ops". See setKeyOps(PkiCredential.Metadata, Set).

Parameters:

metadata - the Metadata object

keyOps - a comma-separated list of key operation strings (or null for resetting the property)

Throws:

IllegalArgumentException - for invalid key operations, see KeyOperation.parse(List)

setKeyOps

public static void setKeyOps(@Nonnull
 PkiCredential.Metadata metadata,
 @Nullable
 Set<KeyOperation> keyOps)

Utility method that assigns the "key-ops".

Parameters:

metadata - the Metadata object

keyOps - a set of key operations (or null for resetting the property)

getKeyOps

@Nullable
public static Set<KeyOperation> getKeyOps(@Nonnull
 PkiCredential.Metadata metadata)

Gets the value for the "key-ops" property.

Parameters:

metadata - the Metadata object

Returns:

a set of KeyOperations, or null

setJoseAlgorithm

public static void setJoseAlgorithm(@Nonnull
 PkiCredential.Metadata metadata,
 @Nullable
 String joseAlgorithm)

Utility method that assigns the "jose-alg".

Parameters:

metadata - the Metadata object

joseAlgorithm - the string representation of the JOSE algorithm

setJoseAlgorithm

public static void setJoseAlgorithm(@Nonnull
 PkiCredential.Metadata metadata,
 @Nullable
 Algorithm joseAlgorithm)

Utility method that assigns the "jose-alg". See setJoseAlgorithm(PkiCredential.Metadata, String).

Parameters:

metadata - the Metadata object

joseAlgorithm - the JOSE algorithm

getJoseAlgorithm

@Nullable
public static Algorithm getJoseAlgorithm(@Nonnull
 PkiCredential.Metadata metadata)

Gets the value of the "jose-alg" property.

Parameters:

metadata - the Metadata object

Returns:

the JOSE Algorithm or null