Module io.inverno.mod.security.jose

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

Class AbstractOKPJWKBuilder<A extends PublicKey,B extends PrivateKey,C extends OKPJWK<A,B>,D extends AbstractOKPJWKBuilder<A,B,C,D>>

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<A,B,C,D>

Type Parameters:

A - the public key type

B - the private key type

C - the Octet Key Pair JWK type

D - the Octet Key Pair JWK builder type

All Implemented Interfaces:

JWKBuilder<C,D>, OKPJWKBuilder<A,B,C,D>, X509JWKBuilder<A,B,C,D>, Cloneable

Direct Known Subclasses:

GenericEdECJWKBuilder, GenericXECJWKBuilder

public abstract class AbstractOKPJWKBuilder<A extends PublicKey,B extends PrivateKey,C extends OKPJWK<A,B>,D extends AbstractOKPJWKBuilder<A,B,C,D>>
extends AbstractX509JWKBuilder<A,B,C,D>
implements OKPJWKBuilder<A,B,C,D>

Base Octet Key Pair JWON Web Key builder implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields

Modifier and Type	Field	Description
protected OKPCurve	curve	The Curve parameter as defined by RFC8037 Section 3.
protected String	d	The private key parameter as defined by RFC8037 Section 3.
protected String	x	The public key parameter as defined by RFC8037 Section 3.

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

Method Summary

Modifier and Type	Method	Description
D	curve(String crv)	Specifies the Elliptic curve JWA name.
D	privateKey(String d)	Specifies the private key encoded as Base64URL.
D	publicKey(String x)	Specifies the public key 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 void	set(String field, Object value)	Sets the specified parameter into the builder.

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

resolveCertificate, x509CertificateChain, x509CertificateSHA1Thumbprint, x509CertificateSHA256Thumbprint, x509CertificateURL

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

algorithm, build, doBuild, keyId, keyOperations, publicKeyUse, resolveKey

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.X509JWKBuilder

x509CertificateChain, x509CertificateSHA1Thumbprint, x509CertificateSHA256Thumbprint, x509CertificateURL

Field Details

curve

protected OKPCurve curve

The Curve parameter as defined by RFC8037 Section 3.

x

protected String x

The public key parameter as defined by RFC8037 Section 3.

d

protected String d

The private key parameter as defined by RFC8037 Section 3.

Constructor Details

AbstractOKPJWKBuilder

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

Creates a generic OKP 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

AbstractOKPJWKBuilder

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

Creates a generic OKP 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

set

protected void set(String field,
 Object value)
            throws JWKReadException

Description copied from class: AbstractX509JWKBuilder

Sets the specified parameter into the builder.

Unsupported parameters are ignored.

Overrides:

set in class AbstractX509JWKBuilder<A extends PublicKey,B extends PrivateKey,C extends OKPJWK<A,B>,D extends AbstractOKPJWKBuilder<A,B,C,D>>

Parameters:

field - the parameter name

value - the parameter value

Throws:

JWKReadException - if there was an error reading the value

curve

public D curve(String crv)

Description copied from interface: OKPJWKBuilder

Specifies the Elliptic curve JWA name.

Specified by:

curve in interface OKPJWKBuilder<A extends PublicKey,B extends PrivateKey,C extends OKPJWK<A,B>,D extends AbstractOKPJWKBuilder<A,B,C,D>>

Parameters:

crv - the JWA Elliptic curve name

Returns:

this builder

publicKey

public D publicKey(String x)

Description copied from interface: OKPJWKBuilder

Specifies the public key encoded as Base64URL.

Specified by:

publicKey in interface OKPJWKBuilder<A extends PublicKey,B extends PrivateKey,C extends OKPJWK<A,B>,D extends AbstractOKPJWKBuilder<A,B,C,D>>

Parameters:

x - the Base64URL encoded public key with no padding

Returns:

this builder

privateKey

public D privateKey(String d)

Description copied from interface: OKPJWKBuilder

Specifies the private key encoded as Base64URL.

Specified by:

privateKey in interface OKPJWKBuilder<A extends PublicKey,B extends PrivateKey,C extends OKPJWK<A,B>,D extends AbstractOKPJWKBuilder<A,B,C,D>>

Parameters:

d - the Base64URL encoded private key 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 AbstractX509JWKBuilder<A extends PublicKey,B extends PrivateKey,C extends OKPJWK<A,B>,D extends AbstractOKPJWKBuilder<A,B,C,D>>

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 AbstractX509JWKBuilder<A extends PublicKey,B extends PrivateKey,C extends OKPJWK<A,B>,D extends AbstractOKPJWKBuilder<A,B,C,D>>

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