Module io.inverno.mod.security.jose

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

Class GenericECJWKGenerator

java.lang.Object

io.inverno.mod.security.jose.internal.jwk.AbstractJWKGenerator<C,D>

io.inverno.mod.security.jose.internal.jwk.AbstractX509JWKGenerator<ECPublicKey,ECPrivateKey,GenericECJWK,GenericECJWKGenerator>

io.inverno.mod.security.jose.internal.jwk.ec.GenericECJWKGenerator

All Implemented Interfaces:

ECJWKGenerator<GenericECJWK,GenericECJWKGenerator>, JWKGenerator<GenericECJWK,GenericECJWKGenerator>, X509JWKGenerator<ECPublicKey,ECPrivateKey,GenericECJWK,GenericECJWKGenerator>

public class GenericECJWKGenerator
extends AbstractX509JWKGenerator<ECPublicKey,ECPrivateKey,GenericECJWK,GenericECJWKGenerator>
implements ECJWKGenerator<GenericECJWK,GenericECJWKGenerator>

Generic Elliptic Curve JSON Web Key generator implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
static final ECCurve	DEFAULT_CURVE	The default Elliptic curve.

Fields inherited from class io.inverno.mod.security.jose.internal.jwk.AbstractJWKGenerator

alg, key_ops, kid, use

Constructor Summary

Constructors

Constructor	Description
GenericECJWKGenerator()	Creates a generic EC JWK generator.
GenericECJWKGenerator(Map<String,Object> parameters)	Creates a generic EC JWK generator initialized with the specified parameters map.

Method Summary

Modifier and Type	Method	Description
GenericECJWKGenerator	algorithm(String alg)	Specifies the algorithm intended for use with the key.
GenericECJWKGenerator	curve(String crv)	Specifies the Elliptic curve JWA name.
protected reactor.core.publisher.Mono<GenericECJWK>	doGenerate()	Generates the JWK after all checks and processing have terminated successfully.
protected void	set(String field, 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 io.inverno.mod.security.jose.internal.jwk.AbstractJWKGenerator

generate, keyId, keyOperations, publicKeyUse

Methods inherited from class java.lang.Object

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

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

generate, keyId, keyOperations, publicKeyUse

Field Details

DEFAULT_CURVE

public static final ECCurve DEFAULT_CURVE

The default Elliptic curve.

Constructor Details

GenericECJWKGenerator

public GenericECJWKGenerator()

Creates a generic EC JWK generator.

GenericECJWKGenerator

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

Creates a generic EC 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 field,
 Object value)
            throws JWKGenerateException

Description copied from class: AbstractJWKGenerator

Sets the specified parameter into the generator.

Unsupported parameters are ignored.

Overrides:

set in class AbstractJWKGenerator<GenericECJWK,GenericECJWKGenerator>

Parameters:

field - the parameter name

value - the parameter value

Throws:

JWKGenerateException - if there was an error reading the value

algorithm

public GenericECJWKGenerator algorithm(String alg)

Description copied from interface: JWKGenerator

Specifies the algorithm intended for use with the key.

Specified by:

algorithm in interface JWKGenerator<GenericECJWK,GenericECJWKGenerator>

Overrides:

algorithm in class AbstractJWKGenerator<GenericECJWK,GenericECJWKGenerator>

Parameters:

alg - a JWA algorithm

Returns:

this generator

curve

public GenericECJWKGenerator curve(String crv)

Description copied from interface: ECJWKGenerator

Specifies the Elliptic curve JWA name.

Specified by:

curve in interface ECJWKGenerator<GenericECJWK,GenericECJWKGenerator>

Parameters:

crv - the Elliptic curve JWA name

Returns:

this generator

verify

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

Description copied from class: AbstractJWKGenerator

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

Overrides:

verify in class AbstractJWKGenerator<GenericECJWK,GenericECJWKGenerator>

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 reactor.core.publisher.Mono<GenericECJWK> doGenerate()
                                                        throws JWKGenerateException,
JWKProcessingException

Description copied from class: AbstractJWKGenerator

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

Specified by:

doGenerate in class AbstractJWKGenerator<GenericECJWK,GenericECJWKGenerator>

Returns:

a single JWK publisher

Throws:

JWKGenerateException - if there was an error generating the JWK

JWKProcessingException - if there was a JWK processing error