Module io.inverno.mod.security.jose

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

Class GenericEdECJWKBuilder

java.lang.Object

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

io.inverno.mod.security.jose.internal.jwk.AbstractX509JWKBuilder<A,B,C,D>

io.inverno.mod.security.jose.internal.jwk.okp.AbstractOKPJWKBuilder<EdECPublicKey,EdECPrivateKey,GenericEdECJWK,GenericEdECJWKBuilder>

io.inverno.mod.security.jose.internal.jwk.okp.GenericEdECJWKBuilder

All Implemented Interfaces:

JWKBuilder<GenericEdECJWK,GenericEdECJWKBuilder>, EdECJWKBuilder<GenericEdECJWK,GenericEdECJWKBuilder>, OKPJWKBuilder<EdECPublicKey,EdECPrivateKey,GenericEdECJWK,GenericEdECJWKBuilder>, X509JWKBuilder<EdECPublicKey,EdECPrivateKey,GenericEdECJWK,GenericEdECJWKBuilder>, Cloneable

public class GenericEdECJWKBuilder
extends AbstractOKPJWKBuilder<EdECPublicKey,EdECPrivateKey,GenericEdECJWK,GenericEdECJWKBuilder>
implements EdECJWKBuilder<GenericEdECJWK,GenericEdECJWKBuilder>

Generic Edward-Curve JSON Web Key builder implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

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

curve, d, x

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

certificate, certPathValidator, keyTrusted, urlResolver, x5c, x5t, x5t_S256, x5u

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
GenericEdECJWKBuilder(JOSEConfiguration configuration, JWKStore jwkStore, JWKKeyResolver keyResolver, JWKURLResolver urlResolver, X509JWKCertPathValidator certPathValidator)	Creates a generic EdEC JWK builder.
GenericEdECJWKBuilder(JOSEConfiguration configuration, JWKStore jwkStore, JWKKeyResolver keyResolver, JWKURLResolver urlResolver, X509JWKCertPathValidator certPathValidator, Map<String,Object> parameters)	Creates a generic EdEC JWK builder initialized with the specified parameters map.

Method Summary

Modifier and Type	Method	Description
protected reactor.core.publisher.Mono<GenericEdECJWK>	doBuild()	Builds the JWK after all checks and processing have terminated successfully.
protected reactor.core.publisher.Mono<Void>	resolve()	Resolves the JWK to build.
protected reactor.core.publisher.Mono<Void>	resolveCertificate(X509Certificate certificate)	Resolves the specified certificate into the builder.
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.

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

curve, privateKey, publicKey, set

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

x509CertificateChain, x509CertificateSHA1Thumbprint, x509CertificateSHA256Thumbprint, x509CertificateURL

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

algorithm, 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

algorithm, build, keyId, keyOperations, publicKeyUse

Methods inherited from interface io.inverno.mod.security.jose.jwk.okp.OKPJWKBuilder

curve, privateKey, publicKey

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

x509CertificateChain, x509CertificateSHA1Thumbprint, x509CertificateSHA256Thumbprint, x509CertificateURL

Constructor Details

GenericEdECJWKBuilder

public GenericEdECJWKBuilder(JOSEConfiguration configuration,
 JWKStore jwkStore,
 JWKKeyResolver keyResolver,
 JWKURLResolver urlResolver,
 X509JWKCertPathValidator certPathValidator)

Creates a generic EdEC JWK builder.

Parameters:

configuration - the JOSE module configuration

jwkStore - a JWK store

keyResolver - a JWK key resolver

urlResolver - a JWK URL resolver

certPathValidator - an X.509 certificate path validator

GenericEdECJWKBuilder

public GenericEdECJWKBuilder(JOSEConfiguration configuration,
 JWKStore jwkStore,
 JWKKeyResolver keyResolver,
 JWKURLResolver urlResolver,
 X509JWKCertPathValidator certPathValidator,
 Map<String,Object> parameters)
                      throws JWKReadException

Creates a generic EdEC JWK builder initialized with the specified parameters map.

Parameters:

configuration - the JOSE module configuration

jwkStore - a JWK store

keyResolver - a JWK key resolver

urlResolver - a JWK URL resolver

certPathValidator - an X.509 certificate path validator

parameters - a parameters map used to initialize the builder

Throws:

JWKReadException - if there was an error reading the parameters map

Method Details

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<GenericEdECJWK,GenericEdECJWKBuilder>

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

resolveCertificate

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

Description copied from class: AbstractX509JWKBuilder

Resolves the specified certificate into the builder.

This method basically verifies that the certificate is valid and consistent with the builder's parameters and eventually populates the builder with the certificate key.

Overrides:

resolveCertificate in class AbstractX509JWKBuilder<EdECPublicKey,EdECPrivateKey,GenericEdECJWK,GenericEdECJWKBuilder>

Parameters:

certificate - a certificate

Returns:

an empty single publisher which completes in error if the resolved key is invalid or inconsistent with the builder's parameters

Throws:

JWKBuildException - if there was an error building the JWK

JWKResolveException - if there was an error resolving the certificate

JWKProcessingException - if there was a JWK processing error

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 AbstractOKPJWKBuilder<EdECPublicKey,EdECPrivateKey,GenericEdECJWK,GenericEdECJWKBuilder>

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

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 AbstractOKPJWKBuilder<EdECPublicKey,EdECPrivateKey,GenericEdECJWK,GenericEdECJWKBuilder>

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

protected reactor.core.publisher.Mono<GenericEdECJWK> 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<GenericEdECJWK,GenericEdECJWKBuilder>

Returns:

a single JWK publisher

Throws:

JWKBuildException - if there was an error building the JWK

JWKProcessingException - if there was a JWK processing error