io.inverno.mod.security.jose.internal.jwk.ec.GenericECJWKBuilder

All Implemented Interfaces:: ECJWKBuilder<GenericECJWK,GenericECJWKBuilder>, JWKBuilder<GenericECJWK,GenericECJWKBuilder>, X509JWKBuilder<ECPublicKey,ECPrivateKey,GenericECJWK,GenericECJWKBuilder>, Cloneable

public class GenericECJWKBuilder extends AbstractX509JWKBuilder<ECPublicKey,ECPrivateKey,GenericECJWK,GenericECJWKBuilder> implements ECJWKBuilder<GenericECJWK,GenericECJWKBuilder>

Generic Elliptic 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.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

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

Creates a generic EC JWK builder.

GenericECJWKBuilder(JOSEConfiguration configuration, JWKStore jwkStore, JWKKeyResolver keyResolver, JWKURLResolver urlResolver, X509JWKCertPathValidator certPathValidator, Map<String,Object> parameters)

Creates a generic EC JWK builder initialized with the specified parameters map.
Method Summary

Modifier and Type

Method

Description

GenericECJWKBuilder

algorithm(String alg)

Specifies the algorithm intended for use with the key.

GenericECJWKBuilder

curve(String crv)

Specifies the Elliptic curve JWA name.

protected reactor.core.publisher.Mono<GenericECJWK>

doBuild()

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

GenericECJWKBuilder

eccPrivateKey(String d)

Specifies the ECC private key encoded as Base64URL.

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.

protected void

set(String field, Object value)

Sets the specified parameter into the builder.

GenericECJWKBuilder

xCoordinate(String x)

Specifies the X coordinate encoded as Base64URL.

GenericECJWKBuilder

yCoordinate(String y)

Specifies the Y coordinate encoded as Base64URL.

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

Methods inherited from interface io.inverno.mod.security.jose.jwk.X509JWKBuilder
x509CertificateChain, x509CertificateSHA1Thumbprint, x509CertificateSHA256Thumbprint, x509CertificateURL

Constructor Details
- GenericECJWKBuilder
  
  public GenericECJWKBuilder(JOSEConfiguration configuration, JWKStore jwkStore, JWKKeyResolver keyResolver, JWKURLResolver urlResolver, X509JWKCertPathValidator certPathValidator)
  
  Creates a generic EC 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
- GenericECJWKBuilder
  
  public GenericECJWKBuilder(JOSEConfiguration configuration, JWKStore jwkStore, JWKKeyResolver keyResolver, JWKURLResolver urlResolver, X509JWKCertPathValidator certPathValidator, Map<String,Object> parameters) throws JWKReadException
  
  Creates a generic EC 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<ECPublicKey,ECPrivateKey,GenericECJWK,GenericECJWKBuilder>
  
  Parameters:
  
  field - the parameter name
  
  value - the parameter value
  
  Throws:
  
  JWKReadException - if there was an error reading the value
- algorithm
  
  public GenericECJWKBuilder algorithm(String alg)
  
  Description copied from interface: JWKBuilder
  
  Specifies the algorithm intended for use with the key.
  
  Specified by:
  
  algorithm in interface JWKBuilder<GenericECJWK,GenericECJWKBuilder>
  
  Overrides:
  
  algorithm in class AbstractJWKBuilder<GenericECJWK,GenericECJWKBuilder>
  
  Parameters:
  
  alg - a JWA algorithm
  
  Returns:
  
  this builder
- curve
  
  public GenericECJWKBuilder curve(String crv)
  
  Description copied from interface: ECJWKBuilder
  
  Specifies the Elliptic curve JWA name.
  
  Specified by:
  
  curve in interface ECJWKBuilder<GenericECJWK,GenericECJWKBuilder>
  
  Parameters:
  
  crv - the JWA Elliptic curve name
  
  Returns:
  
  this builder
- xCoordinate
  
  public GenericECJWKBuilder xCoordinate(String x)
  
  Description copied from interface: ECJWKBuilder
  
  Specifies the X coordinate encoded as Base64URL.
  
  Specified by:
  
  xCoordinate in interface ECJWKBuilder<GenericECJWK,GenericECJWKBuilder>
  
  Parameters:
  
  x - the Base64URL encoded X coordinate with no padding
  
  Returns:
  
  this builder
- yCoordinate
  
  public GenericECJWKBuilder yCoordinate(String y)
  
  Description copied from interface: ECJWKBuilder
  
  Specifies the Y coordinate encoded as Base64URL.
  
  Specified by:
  
  yCoordinate in interface ECJWKBuilder<GenericECJWK,GenericECJWKBuilder>
  
  Parameters:
  
  y - the Base64URL encoded Y coordinate with no padding
  
  Returns:
  
  this builder
- eccPrivateKey
  
  public GenericECJWKBuilder eccPrivateKey(String d)
  
  Description copied from interface: ECJWKBuilder
  
  Specifies the ECC private key encoded as Base64URL.
  
  Specified by:
  
  eccPrivateKey in interface ECJWKBuilder<GenericECJWK,GenericECJWKBuilder>
  
  Parameters:
  
  d - the Base64URL encoded ECC 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<ECPublicKey,ECPrivateKey,GenericECJWK,GenericECJWKBuilder>
  
  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<GenericECJWK,GenericECJWKBuilder>
  
  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<ECPublicKey,ECPrivateKey,GenericECJWK,GenericECJWKBuilder>
  
  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
- 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<ECPublicKey,ECPrivateKey,GenericECJWK,GenericECJWKBuilder>
  
  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<GenericECJWK> 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<GenericECJWK,GenericECJWKBuilder>
  
  Returns:
  
  a single JWK publisher
  
  Throws:
  
  JWKBuildException - if there was an error building the JWK
  
  JWKProcessingException - if there was a JWK processing error

Class GenericECJWKBuilder

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Constructor Details

GenericECJWKBuilder

GenericECJWKBuilder

Method Details

set

algorithm

curve

xCoordinate

yCoordinate

eccPrivateKey

resolveFromJWKStore

resolveKey

resolveCertificate

resolve

doBuild