Module io.inverno.mod.security.jose

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

Class GenericOCTJWKBuilder

java.lang.Object

io.inverno.mod.security.jose.internal.jwk.AbstractJWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>

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

All Implemented Interfaces:

JWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>, OCTJWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>, Cloneable

public class GenericOCTJWKBuilder
extends AbstractJWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>
implements OCTJWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>

Generic Octet JSON Web Key builder implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

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

alg, configuration, jwkStore, key, key_ops, keyResolver, kid, use

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
GenericOCTJWKBuilder	algorithm(String alg)	Specifies the algorithm intended for use with the key.
reactor.core.publisher.Mono<GenericOCTJWK>	doBuild()	Builds the JWK after all checks and processing have terminated successfully.
GenericOCTJWKBuilder	keyValue(String k)	Specifies the key value encoded as Base64URL.
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 reactor.core.publisher.Mono<Void>	resolveKey(Key key)	Resolves the specified key into the builder.
protected void	set(String field, Object value)	Sets the specified parameter into the builder.

Methods inherited from class io.inverno.mod.security.jose.internal.jwk.AbstractJWKBuilder

build, 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.JWKBuilder

build, keyId, keyOperations, publicKeyUse

Constructor Details

GenericOCTJWKBuilder

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

Creates a generic OCT JWK builder.

Parameters:

configuration - the JOSE module configuration

jwkStore - a JWK store

keyResolver - a JWK key resolver

GenericOCTJWKBuilder

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

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

Description copied from class: AbstractJWKBuilder

Sets the specified parameter into the builder.

Unsupported parameters are ignored.

Overrides:

set in class AbstractJWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>

Parameters:

field - the parameter name

value - the parameter value

Throws:

JWKReadException - if there was an error reading the value

algorithm

public GenericOCTJWKBuilder algorithm(String alg)

Description copied from interface: JWKBuilder

Specifies the algorithm intended for use with the key.

Specified by:

algorithm in interface JWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>

Overrides:

algorithm in class AbstractJWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>

Parameters:

alg - a JWA algorithm

Returns:

this builder

keyValue

public GenericOCTJWKBuilder keyValue(String k)

Description copied from interface: OCTJWKBuilder

Specifies the key value encoded as Base64URL.

Specified by:

keyValue in interface OCTJWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>

Parameters:

k - the Base64URL encoded key value with no padding

Returns:

this builder

resolveFromJWKStore

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

Description copied from class: AbstractJWKBuilder

Tries to resolve the JWK from the JWK store.

Overrides:

resolveFromJWKStore in class AbstractJWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>

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

resolveKey

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

Description copied from class: AbstractJWKBuilder

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.

Specified by:

resolveKey in class AbstractJWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>

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

resolve

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

Description copied from class: AbstractJWKBuilder

Resolves the JWK to build.

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

Overrides:

resolve in class AbstractJWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>

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

doBuild

public reactor.core.publisher.Mono<GenericOCTJWK> doBuild()
                                                   throws JWKBuildException,
JWKProcessingException

Description copied from class: AbstractJWKBuilder

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

Specified by:

doBuild in class AbstractJWKBuilder<GenericOCTJWK,GenericOCTJWKBuilder>

Returns:

a single JWK publisher

Throws:

JWKBuildException - if there was an error building the JWK

JWKProcessingException - if there was a JWK processing error