Module io.inverno.mod.security.jose

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

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

java.lang.Object

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

Type Parameters:

A - the JWK type

B - the JWK generator type

All Implemented Interfaces:

JWKGenerator<A,B>

Direct Known Subclasses:

AbstractX509JWKGenerator, GenericOCTJWKGenerator, GenericPBES2JWKGenerator

public abstract class AbstractJWKGenerator<A extends JWK,B extends AbstractJWKGenerator<A,B>>
extends Object
implements JWKGenerator<A,B>

Base JSON Web Key generator 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 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 String	use	The Public Key Use parameter as defined by RFC7517 Section 4.2.

Constructor Summary

Constructors

Constructor	Description
AbstractJWKGenerator()	Creates JWK generator.
AbstractJWKGenerator(Map<String,Object> parameters)	Creates JWK generator 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.
protected abstract reactor.core.publisher.Mono<A>	doGenerate()	Generates the JWK after all checks and processing have terminated successfully.
reactor.core.publisher.Mono<A>	generate()	Returns a single publisher that generates a new key.
B	keyId(String kid)	Specifies 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 void	set(String name, Object value)	Sets the specified parameter into the generator.
protected reactor.core.publisher.Mono<Void>	verify()	Verifies that the generator's parameters are consistent and that we can proceed with the generation of the key.

Methods inherited from class java.lang.Object

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

Field Details

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.

Constructor Details

AbstractJWKGenerator

public AbstractJWKGenerator()

Creates JWK generator.

AbstractJWKGenerator

public AbstractJWKGenerator(Map<String,Object> parameters)
                     throws JWKGenerateException

Creates JWK generator initialized with the specified parameters map.

Parameters:

parameters - a parameters map used to initialize the generator

Throws:

JWKGenerateException - if there was an error reading the parameters map

Method Details

set

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

Sets the specified parameter into the generator.

Unsupported parameters are ignored.

Parameters:

name - the parameter name

value - the parameter value

Throws:

JWKGenerateException - if there was an error reading the value

publicKeyUse

public B publicKeyUse(String use)

Description copied from interface: JWKGenerator

Specifies the public key use.

Specified by:

publicKeyUse in interface JWKGenerator<A extends JWK,B extends AbstractJWKGenerator<A,B>>

Parameters:

use - the public key use

Returns:

this generator

keyOperations

public B keyOperations(String... key_ops)

Description copied from interface: JWKGenerator

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

Specified by:

keyOperations in interface JWKGenerator<A extends JWK,B extends AbstractJWKGenerator<A,B>>

Parameters:

key_ops - a list of key operations

Returns:

this generator

keyId

public B keyId(String kid)

Description copied from interface: JWKGenerator

Specifies the key id that uniquely identifies the key.

Specified by:

keyId in interface JWKGenerator<A extends JWK,B extends AbstractJWKGenerator<A,B>>

Parameters:

kid - a unique key id

Returns:

this generator

algorithm

public B algorithm(String alg)

Description copied from interface: JWKGenerator

Specifies the algorithm intended for use with the key.

Specified by:

algorithm in interface JWKGenerator<A extends JWK,B extends AbstractJWKGenerator<A,B>>

Parameters:

alg - a JWA algorithm

Returns:

this generator

generate

public reactor.core.publisher.Mono<A> generate()
                                        throws JWKGenerateException,
JWKProcessingException

Description copied from interface: JWKGenerator

Returns a single publisher that generates a new key.

Specified by:

generate in interface JWKGenerator<A extends JWK,B extends AbstractJWKGenerator<A,B>>

Returns:

a single key publisher

Throws:

JWKGenerateException - if there was an error generating the key

JWKProcessingException - if there was a processing error

verify

protected reactor.core.publisher.Mono<Void> verify()
                                            throws JWKGenerateException,
JWKProcessingException

Verifies that the generator's parameters are consistent and that we can proceed with the generation of the key.

Returns:

an empty single publisher which completes in error if generator's parameters are invalid or inconsistent

Throws:

JWKGenerateException - if there was an error generating the JWK

JWKProcessingException - if there was a JWK processing error

doGenerate

protected abstract reactor.core.publisher.Mono<A> doGenerate()
                                                      throws JWKGenerateException,
JWKProcessingException

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

Returns:

a single JWK publisher

Throws:

JWKGenerateException - if there was an error generating the JWK

JWKProcessingException - if there was a JWK processing error