Module io.inverno.mod.security.jose

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

Class GenericOCTJWKFactory

java.lang.Object

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

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

All Implemented Interfaces:

JWKFactory<GenericOCTJWK,GenericOCTJWKBuilder,GenericOCTJWKGenerator>, OCTJWKFactory<GenericOCTJWK,GenericOCTJWKBuilder,GenericOCTJWKGenerator>

public class GenericOCTJWKFactory
extends AbstractJWKFactory<GenericOCTJWK,GenericOCTJWKBuilder,GenericOCTJWKGenerator>
implements OCTJWKFactory<GenericOCTJWK,GenericOCTJWKBuilder,GenericOCTJWKGenerator>

Generic Octet JSON Web Key factory implementation.

It supports the OCT key type and the following algorithms:

• HS256
• HS384
• HS512
• A128KW
• A256KW
• A512KW
• A128GCMKW
• A192GCMKW
• A256GCMKW
• A128GCM
• A192GCM
• A256GCM
• A128CBC-HS256
• A192CBC-HS384
• A256CBC-HS512

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

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

configuration, jwkStore, keyResolver, mapper

Constructor Summary

Constructors

Constructor	Description
GenericOCTJWKFactory(JOSEConfiguration configuration, JWKStore jwkStore, JWKKeyResolver keyResolver, com.fasterxml.jackson.databind.ObjectMapper mapper)	Creates a generic OCT JWK factory.

Method Summary

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

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

Constructor Details

GenericOCTJWKFactory

public GenericOCTJWKFactory(JOSEConfiguration configuration,
 JWKStore jwkStore,
 JWKKeyResolver keyResolver,
 com.fasterxml.jackson.databind.ObjectMapper mapper)

Creates a generic OCT JWK factory.

Parameters:

configuration - the JOSE module configuration

jwkStore - a JWK store

keyResolver - a JWK key resolver

mapper - an object mapper

Method Details

supports

public boolean supports(String kty)

Description copied from interface: JWKFactory

Determines whether the factory supports the specified key type.

Specified by:

supports in interface JWKFactory<GenericOCTJWK,GenericOCTJWKBuilder,GenericOCTJWKGenerator>

Parameters:

kty - a JWA key type

Returns:

true if the factory supports the key type, false otherwise

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<GenericOCTJWK,GenericOCTJWKBuilder,GenericOCTJWKGenerator>

Parameters:

alg - a JWA algorithm

Returns:

true if the factory supports the algorithm, false otherwise

builder

public GenericOCTJWKBuilder 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<GenericOCTJWK,GenericOCTJWKBuilder,GenericOCTJWKGenerator>

Returns:

a new JWK builder

builder

public GenericOCTJWKBuilder 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<GenericOCTJWK,GenericOCTJWKBuilder,GenericOCTJWKGenerator>

Parameters:

parameters - a parameters map

Returns:

a new JWK builder

Throws:

JWKReadException

generator

public GenericOCTJWKGenerator 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<GenericOCTJWK,GenericOCTJWKBuilder,GenericOCTJWKGenerator>

Returns:

a new JWK generator

generator

public GenericOCTJWKGenerator 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<GenericOCTJWK,GenericOCTJWKBuilder,GenericOCTJWKGenerator>

Parameters:

alg - a JWK algorithm

parameters - a parameters map

Returns:

a new JWK generator

Throws:

JWKGenerateException