Package se.swedenconnect.security.credential.nimbus

Class JwkTransformerFunction

java.lang.Object

se.swedenconnect.security.credential.nimbus.JwkTransformerFunction

All Implemented Interfaces:

Function<PkiCredential,JWK>

public class JwkTransformerFunction
extends Object
implements Function<PkiCredential,JWK>

A function that transforms a PkiCredential into an JWK.

Author:

Martin Lindström

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JwkTransformerFunction.DefaultKeyIdFunction	Default implementation of the function that returns the key id (JWT kid property).

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<PkiCredential,Algorithm>	defaultAlgorithmFunction	Default algorithm for getting the JOSE algorithm.
static final Function<PkiCredential,Set<KeyOperation>>	defaultKeyOpsFunction	Default function for getting the key operation property.
static final Function<PkiCredential,KeyUse>	defaultKeyUseFunction	Default function for getting the key use.

Constructor Summary

Constructors

Constructor	Description
JwkTransformerFunction()	Constructor.

Method Summary

Modifier and Type	Method	Description
JWK	apply(PkiCredential credential)	Transforms the supplied PkiCredential into an JWK.
static JwkTransformerFunction	function()	Creates a JwkTransformerFunction with default settings.
JwkTransformerFunction	serializable()	Customizes the function to remove the KeyStore of any created JWK which makes keys unserializable.
void	setAlgorithmFunction(Function<PkiCredential,Algorithm> algorithmFunction)	Deprecated, for removal: This API element is subject to removal in a future version. use withAlgorithmFunction(Function) instead
void	setKeyIdFunction(Function<PkiCredential,String> keyIdFunction)	Deprecated, for removal: This API element is subject to removal in a future version. use withKeyIdFunction(Function) instead
void	setKeyOpsFunction(Function<PkiCredential,Set<KeyOperation>> keyOpsFunction)	Deprecated, for removal: This API element is subject to removal in a future version. use withKeyOpsFunction(Function) instead
void	setKeyUseFunction(Function<PkiCredential,KeyUse> keyUseFunction)	Deprecated, for removal: This API element is subject to removal in a future version. use withKeyUseFunction(Function) instead
JwkTransformerFunction	withAlgorithmFunction(Function<PkiCredential,Algorithm> algorithmFunction)	Customizes this function with a function that returns the JOSE algorithm.
JwkTransformerFunction	withEcKeyCustomizer(Function<ECKey.Builder,ECKey.Builder> customizer)	Customizes this function with a generic function that may modify EC keys.
JwkTransformerFunction	withKeyIdFunction(Function<PkiCredential,String> keyIdFunction)	Customizes the function with a custom function for calculating the key ID property (JWK kid property).
JwkTransformerFunction	withKeyOpsFunction(Function<PkiCredential,Set<KeyOperation>> keyOpsFunction)	Customizes this function with a function that returns a set of KeyOperations.
JwkTransformerFunction	withKeyUseFunction(Function<PkiCredential,KeyUse> keyUseFunction)	Customizes this function with a function for getting the key use property (JWK use property).
JwkTransformerFunction	withRsaCustomizer(Function<RSAKey.Builder,RSAKey.Builder> customizer)	Customizes this function with a generic function that may modify RSA keys.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Field Details

defaultKeyUseFunction

public static final Function<PkiCredential,KeyUse> defaultKeyUseFunction

Default function for getting the key use. Note that if key ops are set, no use is returned.

defaultKeyOpsFunction

public static final Function<PkiCredential,Set<KeyOperation>> defaultKeyOpsFunction

Default function for getting the key operation property.

defaultAlgorithmFunction

public static final Function<PkiCredential,Algorithm> defaultAlgorithmFunction

Default algorithm for getting the JOSE algorithm.

Constructor Details

JwkTransformerFunction

public JwkTransformerFunction()

Constructor.

Method Details

function

@Nonnull
public static JwkTransformerFunction function()

Creates a JwkTransformerFunction with default settings.

Returns:

a JwkTransformerFunction

apply

@Nonnull
public JWK apply(@Nonnull
 PkiCredential credential)

Transforms the supplied PkiCredential into an JWK.

Specified by:

apply in interface Function<PkiCredential,JWK>

withRsaCustomizer

@Nonnull
public JwkTransformerFunction withRsaCustomizer(@Nonnull
 Function<RSAKey.Builder,RSAKey.Builder> customizer)

Customizes this function with a generic function that may modify RSA keys.

Parameters:

customizer - to apply after default properties is set for key

Returns:

this instance

withEcKeyCustomizer

@Nonnull
public JwkTransformerFunction withEcKeyCustomizer(@Nonnull
 Function<ECKey.Builder,ECKey.Builder> customizer)

Customizes this function with a generic function that may modify EC keys.

Parameters:

customizer - to apply after default properties is set for key

Returns:

this instance

serializable

@Nonnull
public JwkTransformerFunction serializable()

Customizes the function to remove the KeyStore of any created JWK which makes keys unserializable.

Returns:

this instance

withKeyIdFunction

@Nonnull
public JwkTransformerFunction withKeyIdFunction(@Nonnull
 Function<PkiCredential,String> keyIdFunction)

Customizes the function with a custom function for calculating the key ID property (JWK kid property).

The default implementation is JwkTransformerFunction.DefaultKeyIdFunction.

Parameters:

keyIdFunction - the function

Returns:

this instance

setKeyIdFunction

@Deprecated(since="2.1.0",
            forRemoval=true)
public void setKeyIdFunction(@Nonnull
 Function<PkiCredential,String> keyIdFunction)

Deprecated, for removal: This API element is subject to removal in a future version.

use withKeyIdFunction(Function) instead

Assigns the function that returns the key ID property (JWK kid property).

The default implementation is JwkTransformerFunction.DefaultKeyIdFunction.

Parameters:

keyIdFunction - the function

withKeyUseFunction

@Nonnull
public JwkTransformerFunction withKeyUseFunction(@Nonnull
 Function<PkiCredential,KeyUse> keyUseFunction)

Customizes this function with a function for getting the key use property (JWK use property).

The default implementation is defaultKeyUseFunction.

Parameters:

keyUseFunction - the function

Returns:

this instance

setKeyUseFunction

@Deprecated(since="2.1.0",
            forRemoval=true)
public void setKeyUseFunction(@Nonnull
 Function<PkiCredential,KeyUse> keyUseFunction)

Deprecated, for removal: This API element is subject to removal in a future version.

use withKeyUseFunction(Function) instead

Assigns the function that returns the key use property (JWK use property).

The default implementation is defaultKeyUseFunction.

Parameters:

keyUseFunction - the function

withKeyOpsFunction

public JwkTransformerFunction withKeyOpsFunction(@Nonnull
 Function<PkiCredential,Set<KeyOperation>> keyOpsFunction)

Customizes this function with a function that returns a set of KeyOperations.

The default implementation is defaultKeyOpsFunction.

Parameters:

keyOpsFunction - the function

Returns:

this instance

setKeyOpsFunction

@Deprecated(since="2.1.0",
            forRemoval=true)
public void setKeyOpsFunction(@Nonnull
 Function<PkiCredential,Set<KeyOperation>> keyOpsFunction)

Deprecated, for removal: This API element is subject to removal in a future version.

use withKeyOpsFunction(Function) instead

Assigns the function that returns a set of KeyOperations.

The default implementation is defaultKeyOpsFunction.

Parameters:

keyOpsFunction - the function

withAlgorithmFunction

@Nonnull
public JwkTransformerFunction withAlgorithmFunction(@Nonnull
 Function<PkiCredential,Algorithm> algorithmFunction)

Customizes this function with a function that returns the JOSE algorithm.

The default implementation is defaultAlgorithmFunction.

Parameters:

algorithmFunction - the function

Returns:

this instance

setAlgorithmFunction

@Deprecated(since="2.1.0",
            forRemoval=true)
public void setAlgorithmFunction(@Nonnull
 Function<PkiCredential,Algorithm> algorithmFunction)

Deprecated, for removal: This API element is subject to removal in a future version.

use withAlgorithmFunction(Function) instead

Assigns the function that returns the JOSE algorithm.

The default implementation is defaultAlgorithmFunction.

Parameters:

algorithmFunction - the function