Module io.inverno.mod.security.jose

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

Class GenericOCTJWKGenerator

java.lang.Object

io.inverno.mod.security.jose.internal.jwk.AbstractJWKGenerator<GenericOCTJWK,GenericOCTJWKGenerator>

io.inverno.mod.security.jose.internal.jwk.oct.GenericOCTJWKGenerator

All Implemented Interfaces:

JWKGenerator<GenericOCTJWK,GenericOCTJWKGenerator>, OCTJWKGenerator<GenericOCTJWK,GenericOCTJWKGenerator>

public class GenericOCTJWKGenerator
extends AbstractJWKGenerator<GenericOCTJWK,GenericOCTJWKGenerator>
implements OCTJWKGenerator<GenericOCTJWK,GenericOCTJWKGenerator>

Generic Octet JSON Web Key generator implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_KEY_SIZE	The default key size.
static final int	MINIMUM_KEY_SIZE	The minimum key size.

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

alg, key_ops, kid, use

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GenericOCTJWKGenerator	algorithm(String alg)	Specifies the algorithm intended for use with the key.
reactor.core.publisher.Mono<GenericOCTJWK>	doGenerate()	Generates the JWK after all checks and processing have terminated successfully.
GenericOCTJWKGenerator	keySize(int keySize)	Specifies the size of the key to generate in bytes.
GenericOCTJWKGenerator	secureRandom(SecureRandom secureRandom)	Specifies the secure random to use to generate the key.
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

MINIMUM_KEY_SIZE

public static final int MINIMUM_KEY_SIZE

The minimum key size.

See Also:

• Constant Field Values

DEFAULT_KEY_SIZE

public static final int DEFAULT_KEY_SIZE

The default key size.

See Also:

• Constant Field Values

Constructor Details

GenericOCTJWKGenerator

public GenericOCTJWKGenerator()

Creates a generic OCT JWK generator.

GenericOCTJWKGenerator

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

Creates a generic OCT 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<GenericOCTJWK,GenericOCTJWKGenerator>

Parameters:

field - the parameter name

value - the parameter value

Throws:

JWKGenerateException - if there was an error reading the value

algorithm

public GenericOCTJWKGenerator algorithm(String alg)

Description copied from interface: JWKGenerator

Specifies the algorithm intended for use with the key.

Specified by:

algorithm in interface JWKGenerator<GenericOCTJWK,GenericOCTJWKGenerator>

Overrides:

algorithm in class AbstractJWKGenerator<GenericOCTJWK,GenericOCTJWKGenerator>

Parameters:

alg - a JWA algorithm

Returns:

this generator

keySize

public GenericOCTJWKGenerator keySize(int keySize)

Description copied from interface: OCTJWKGenerator

Specifies the size of the key to generate in bytes.

Specified by:

keySize in interface OCTJWKGenerator<GenericOCTJWK,GenericOCTJWKGenerator>

Parameters:

keySize - the size of the key in bytes

Returns:

this generator

secureRandom

public GenericOCTJWKGenerator secureRandom(SecureRandom secureRandom)

Description copied from interface: OCTJWKGenerator

Specifies the secure random to use to generate the key.

If not specified a default secure random will be used.

Specified by:

secureRandom in interface OCTJWKGenerator<GenericOCTJWK,GenericOCTJWKGenerator>

Parameters:

secureRandom - a secure random

Returns:

this builder

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<GenericOCTJWK,GenericOCTJWKGenerator>

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

public reactor.core.publisher.Mono<GenericOCTJWK> 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<GenericOCTJWK,GenericOCTJWKGenerator>

Returns:

a single JWK publisher

Throws:

JWKGenerateException - if there was an error generating the JWK

JWKProcessingException - if there was a JWK processing error