Module io.inverno.mod.security.jose

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

Class AbstractJWKBuilder<A extends JWK,B extends AbstractJWKBuilder<A,B>>

java.lang.Object

io.inverno.mod.security.jose.internal.jwk.AbstractJWKBuilder<A,B>

Type Parameters:

A - the JWK type

B - the JWK builder type

All Implemented Interfaces:

JWKBuilder<A,B>, Cloneable

Direct Known Subclasses:

AbstractX509JWKBuilder, GenericOCTJWKBuilder, GenericPBES2JWKBuilder

public abstract class AbstractJWKBuilder<A extends JWK,B extends AbstractJWKBuilder<A,B>>
extends Object
implements JWKBuilder<A,B>, Cloneable

Base JSON Web Key builder 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 JOSEConfiguration	configuration	The JOSE module configuration.
protected final JWKStore	jwkStore	The JWK Key store.
protected Key	key	The underlying key.
protected Set<String>	key_ops	The Key Operations parameter as defined by RFC7517 Section 4.3.
protected final JWKKeyResolver	keyResolver	The JWK Key resolver.
protected String	kid	The Key id parameter as defined by RFC7517 Section 4.5.
protected String	use	The Public Key Use parameter as defined by RFC7517 Section 4.2.

Constructor Summary

Constructors

Constructor	Description
AbstractJWKBuilder(JOSEConfiguration configuration, JWKStore jwkStore, JWKKeyResolver keyResolver)	Creates a JWK builder.
AbstractJWKBuilder(JOSEConfiguration configuration, JWKStore jwkStore, JWKKeyResolver keyResolver, Map<String,Object> parameters)	Creates a JWK builder initialized with the specified parameters map.

Method Summary

Modifier and Type	Method	Description
B	algorithm(String alg)	Specifies the algorithm intended for use with the key.
reactor.core.publisher.Mono<A>	build()	Returns a single publisher that builds the key.
protected abstract reactor.core.publisher.Mono<A>	doBuild()	Builds the JWK after all checks and processing have terminated successfully.
B	keyId(String kid)	Specified the key id that uniquely identifies the key.
B	keyOperations(String... key_ops)	Specifies the set of key operations for which the key is intended to be used.
B	publicKeyUse(String use)	Specifies the public key use.
protected reactor.core.publisher.Mono<Void>	resolve()	Resolves the JWK to build.
protected reactor.core.publisher.Mono<JWK>	resolveFromJWKStore()	Tries to resolve the JWK from the JWK store.
protected abstract reactor.core.publisher.Mono<Void>	resolveKey(Key key)	Resolves the specified key into the builder.
protected void	set(String name, Object value)	Sets the specified parameter into the builder.

Methods inherited from class java.lang.Object

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

Field Details

configuration

protected final JOSEConfiguration configuration

The JOSE module configuration.

jwkStore

protected final JWKStore jwkStore

The JWK Key store.

keyResolver

protected final JWKKeyResolver keyResolver

The JWK Key resolver.

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.

key

protected volatile Key key

The underlying key.

Constructor Details

AbstractJWKBuilder

public AbstractJWKBuilder(JOSEConfiguration configuration,
 JWKStore jwkStore,
 JWKKeyResolver keyResolver)

Creates a JWK builder.

Parameters:

configuration - the JOSE module configuration

jwkStore - a JWK store

keyResolver - a JWK key resolver

AbstractJWKBuilder

public AbstractJWKBuilder(JOSEConfiguration configuration,
 JWKStore jwkStore,
 JWKKeyResolver keyResolver,
 Map<String,Object> parameters)
                   throws JWKReadException

Creates a JWK builder initialized with the specified parameters map.

Parameters:

configuration - the JOSE module configuration

jwkStore - a JWK store

keyResolver - a JWK key resolver

parameters - a parameters map used to initialize the builder

Throws:

JWKReadException - if there was an error reading the parameters map

Method Details

set

protected void set(String name,
 Object value)
            throws JWKReadException

Sets the specified parameter into the builder.

Unsupported parameters are ignored.

Parameters:

name - the parameter name

value - the parameter value

Throws:

JWKReadException - if there was an error reading the value

publicKeyUse

public B publicKeyUse(String use)

Description copied from interface: JWKBuilder

Specifies the public key use.

Specified by:

publicKeyUse in interface JWKBuilder<A extends JWK,B extends AbstractJWKBuilder<A,B>>

Parameters:

use - the public key use

Returns:

this builder

keyOperations

public B keyOperations(String... key_ops)

Description copied from interface: JWKBuilder

Specifies the set of key operations for which the key is intended to be used.

Specified by:

keyOperations in interface JWKBuilder<A extends JWK,B extends AbstractJWKBuilder<A,B>>

Parameters:

key_ops - a list of key operations

Returns:

this builder

algorithm

public B algorithm(String alg)

Description copied from interface: JWKBuilder

Specifies the algorithm intended for use with the key.

Specified by:

algorithm in interface JWKBuilder<A extends JWK,B extends AbstractJWKBuilder<A,B>>

Parameters:

alg - a JWA algorithm

Returns:

this builder

keyId

public B keyId(String kid)

Description copied from interface: JWKBuilder

Specified the key id that uniquely identifies the key.

Specified by:

keyId in interface JWKBuilder<A extends JWK,B extends AbstractJWKBuilder<A,B>>

Parameters:

kid - a unique key id

Returns:

this builder

build

public reactor.core.publisher.Mono<A> build()
                                     throws JWKBuildException,
JWKResolveException,
JWKProcessingException

Description copied from interface: JWKBuilder

Returns a single publisher that builds the key.

Specified by:

build in interface JWKBuilder<A extends JWK,B extends AbstractJWKBuilder<A,B>>

Returns:

a single key publisher

Throws:

JWKBuildException - if there was an error building the key

JWKResolveException - if there was an error resolving the key

JWKProcessingException - if there was an error processing the key

resolveFromJWKStore

protected reactor.core.publisher.Mono<JWK> resolveFromJWKStore()
                                                        throws JWKResolveException

Tries to resolve the JWK from the JWK store.

Returns:

a single JWK publisher or an empty publisher if there's no JWK corresponding to the builder's parameters in the JWK store

Throws:

JWKResolveException - if there was an error accessing the JWK store

resolve

protected reactor.core.publisher.Mono<Void> resolve()
                                             throws JWKBuildException,
JWKResolveException,
JWKProcessingException

Resolves the JWK to build.

This method basically resolves resources such as keys or certificates and verifies that the builder's parameters are consistent.

Returns:

an empty single publisher which completes in error if the key is not consistent with the builder's parameters

Throws:

JWKBuildException - if there was an error building the JWK

JWKResolveException - if there was an error resolving the JWK

JWKProcessingException - if there was a JWK processing error

resolveKey

protected abstract reactor.core.publisher.Mono<Void> resolveKey(Key key)
                                                         throws JWKBuildException,
JWKResolveException,
JWKProcessingException

Resolves the specified key into the builder.

This method basically verifies that the key is valid and consistent with the builder's parameters and eventually populates the builder with the key.

Parameters:

key - a key

Returns:

an empty single publisher which completes in error if the key is not consistent with the builder's parameters

Throws:

JWKBuildException - if there was an error building the JWK

JWKResolveException - if there was an error resolving the key

JWKProcessingException - if there was a JWK processing error

doBuild

protected abstract reactor.core.publisher.Mono<A> doBuild()
                                                   throws JWKBuildException,
JWKProcessingException

Builds the JWK after all checks and processing have terminated successfully.

Returns:

a single JWK publisher

Throws:

JWKBuildException - if there was an error building the JWK

JWKProcessingException - if there was a JWK processing error