Module io.inverno.mod.security.jose

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

Class GenericPBES2JWKGenerator

java.lang.Object

io.inverno.mod.security.jose.internal.jwk.AbstractJWKGenerator<GenericPBES2JWK,GenericPBES2JWKGenerator>

io.inverno.mod.security.jose.internal.jwk.pbes2.GenericPBES2JWKGenerator

All Implemented Interfaces:

JWKGenerator<GenericPBES2JWK,GenericPBES2JWKGenerator>, PBES2JWKGenerator<GenericPBES2JWK,GenericPBES2JWKGenerator>

public class GenericPBES2JWKGenerator
extends AbstractJWKGenerator<GenericPBES2JWK,GenericPBES2JWKGenerator>
implements PBES2JWKGenerator<GenericPBES2JWK,GenericPBES2JWKGenerator>

Generic Password-based JSON Web Key generator implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

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

alg, key_ops, kid, use

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GenericPBES2JWKGenerator	algorithm(String alg)	Specifies the algorithm intended for use with the key.
protected reactor.core.publisher.Mono<GenericPBES2JWK>	doGenerate()	Generates the JWK after all checks and processing have terminated successfully.
GenericPBES2JWKGenerator	length(int length)	Specifies the length of the password to generate in bytes.
GenericPBES2JWKGenerator	randomStringGenerator(org.apache.commons.text.RandomStringGenerator randomStringGenerator)	Specifies the random string generator to use to generate the password.
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

Constructor Details

GenericPBES2JWKGenerator

public GenericPBES2JWKGenerator()

Creates a generic PBES2 JWK generator.

GenericPBES2JWKGenerator

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

Creates a generic PBES2 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<GenericPBES2JWK,GenericPBES2JWKGenerator>

Parameters:

field - the parameter name

value - the parameter value

Throws:

JWKGenerateException - if there was an error reading the value

algorithm

public GenericPBES2JWKGenerator algorithm(String alg)

Description copied from interface: JWKGenerator

Specifies the algorithm intended for use with the key.

Specified by:

algorithm in interface JWKGenerator<GenericPBES2JWK,GenericPBES2JWKGenerator>

Overrides:

algorithm in class AbstractJWKGenerator<GenericPBES2JWK,GenericPBES2JWKGenerator>

Parameters:

alg - a JWA algorithm

Returns:

this generator

length

public GenericPBES2JWKGenerator length(int length)

Description copied from interface: PBES2JWKGenerator

Specifies the length of the password to generate in bytes.

Specified by:

length in interface PBES2JWKGenerator<GenericPBES2JWK,GenericPBES2JWKGenerator>

Parameters:

length - the length of the password in bytes

Returns:

this builder

randomStringGenerator

public GenericPBES2JWKGenerator randomStringGenerator(org.apache.commons.text.RandomStringGenerator randomStringGenerator)

Description copied from interface: PBES2JWKGenerator

Specifies the random string generator to use to generate the password.

If not specified a default random string generator will be used.

Specified by:

randomStringGenerator in interface PBES2JWKGenerator<GenericPBES2JWK,GenericPBES2JWKGenerator>

Parameters:

randomStringGenerator - a random string generator

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<GenericPBES2JWK,GenericPBES2JWKGenerator>

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<GenericPBES2JWK> 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<GenericPBES2JWK,GenericPBES2JWKGenerator>

Returns:

a single JWK publisher

Throws:

JWKGenerateException - if there was an error generating the JWK

JWKProcessingException - if there was a JWK processing error