Module io.inverno.mod.security.jose

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

Class GenericXECJWKFactory

java.lang.Object

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

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

io.inverno.mod.security.jose.internal.jwk.okp.AbstractOKPJWKFactory<XECPublicKey,XECPrivateKey,GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>

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

All Implemented Interfaces:

JWKFactory<GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>, OKPJWKFactory<XECPublicKey,XECPrivateKey,GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>, XECJWKFactory<GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>, X509JWKFactory<XECPublicKey,XECPrivateKey,GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>

public class GenericXECJWKFactory
extends AbstractOKPJWKFactory<XECPublicKey,XECPrivateKey,GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>
implements XECJWKFactory<GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>

Generic Extended Elliptic Curve JSON Web Key factory implementation.

It supports the OKP key type and the following algorithms:

• ECDH-ES with extended elliptic curve X25519 or X448
• ECDH-ES+A128KW with extended elliptic curve X25519 or X448
• ECDH-ES+A192KW with extended elliptic curve X25519 or X448
• ECDH-ES+A256KW with extended elliptic curve X25519 or X448

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

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

certPathValidator, urlResolver

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

configuration, jwkStore, keyResolver, mapper

Constructor Summary

Constructors

Constructor	Description
GenericXECJWKFactory(JOSEConfiguration configuration, JWKStore jwkStore, JWKKeyResolver keyResolver, com.fasterxml.jackson.databind.ObjectMapper mapper, SwitchableJWKURLResolver urlResolver, X509JWKCertPathValidator certPathValidator)	Creates a generic XEC JWK factory.

Method Summary

Modifier and Type	Method	Description
GenericXECJWKBuilder	builder()	Returns a new JWK builder for the key type supported by the factory.
GenericXECJWKBuilder	builder(Map<String,Object> parameters)	Returns a new JWK builder initialized with the specified parameters map.
GenericXECJWKGenerator	generator()	Returns a new JWK builder for the key type supported by the factory.
GenericXECJWKGenerator	generator(String alg, Map<String,Object> parameters)	Returns a new JWK generator initialized with the specified parameters map.
boolean	supportsAlgorithm(String alg)	Determines whether the factory supports the specified algorithm.

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

supports

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

generate, read, read

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

generate, read, read, supports

Constructor Details

GenericXECJWKFactory

public GenericXECJWKFactory(JOSEConfiguration configuration,
 JWKStore jwkStore,
 JWKKeyResolver keyResolver,
 com.fasterxml.jackson.databind.ObjectMapper mapper,
 SwitchableJWKURLResolver urlResolver,
 X509JWKCertPathValidator certPathValidator)

Creates a generic XEC JWK factory.

Parameters:

configuration - the JOSE module configuration

jwkStore - a JWK store

keyResolver - a JWK key resolver

mapper - an object mapper

urlResolver - a JWK URL resolver

certPathValidator - an X.509 certificate path validator

Method Details

supportsAlgorithm

public boolean supportsAlgorithm(String alg)

Description copied from interface: JWKFactory

Determines whether the factory supports the specified algorithm.

Specified by:

supportsAlgorithm in interface JWKFactory<GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>

Parameters:

alg - a JWA algorithm

Returns:

true if the factory supports the algorithm, false otherwise

builder

public GenericXECJWKBuilder builder()

Description copied from interface: JWKFactory

Returns a new JWK builder for the key type supported by the factory.

Specified by:

builder in interface JWKFactory<GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>

Returns:

a new JWK builder

builder

public GenericXECJWKBuilder builder(Map<String,Object> parameters)
                             throws JWKReadException

Description copied from class: AbstractJWKFactory

Returns a new JWK builder initialized with the specified parameters map.

Specified by:

builder in class AbstractJWKFactory<GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>

Parameters:

parameters - a parameters map

Returns:

a new JWK builder

Throws:

JWKReadException

generator

public GenericXECJWKGenerator generator()

Description copied from interface: JWKFactory

Returns a new JWK builder for the key type supported by the factory.

Specified by:

generator in interface JWKFactory<GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>

Returns:

a new JWK generator

generator

public GenericXECJWKGenerator generator(String alg,
 Map<String,Object> parameters)
                                 throws JWKGenerateException

Description copied from class: AbstractJWKFactory

Returns a new JWK generator initialized with the specified parameters map.

Specified by:

generator in class AbstractJWKFactory<GenericXECJWK,GenericXECJWKBuilder,GenericXECJWKGenerator>

Parameters:

alg - a JWK algorithm

parameters - a parameters map

Returns:

a new JWK generator

Throws:

JWKGenerateException