Module io.inverno.mod.security.jose

Package io.inverno.mod.security.jose.internal.jws

Class GenericJsonJWSBuilder<A>

java.lang.Object

io.inverno.mod.security.jose.internal.AbstractJsonJOSEObjectBuilder<A,JsonJWS<A,JsonJWS.BuiltSignature<A>>,GenericJWSHeader,GenericJsonJWSBuilder<A>>

io.inverno.mod.security.jose.internal.jws.GenericJsonJWSBuilder<A>

Type Parameters:

A - the payload type

All Implemented Interfaces:

JsonJOSEObjectBuilder<A,JsonJWS<A,JsonJWS.BuiltSignature<A>>,GenericJWSHeader,GenericJsonJWSBuilder<A>>, JsonJWSBuilder<A,GenericJWSHeader,GenericJsonJWSBuilder<A>>

public class GenericJsonJWSBuilder<A>
extends AbstractJsonJOSEObjectBuilder<A,JsonJWS<A,JsonJWS.BuiltSignature<A>>,GenericJWSHeader,GenericJsonJWSBuilder<A>>
implements JsonJWSBuilder<A,GenericJWSHeader,GenericJsonJWSBuilder<A>>

Generic JSON JWS builder implementation.

Since:

1.5

Author:

Jeremy Kuhn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	GenericJsonJWSBuilder.SignatureInfo	Built signature info for building and holding signature specific information.

Field Summary

Fields inherited from class io.inverno.mod.security.jose.internal.AbstractJsonJOSEObjectBuilder

dataConversionService, jwkService, mapper, payload, protectedHeaderConfigurer, type, unprotectedHeaderConfigurer

Constructor Summary

Constructors

Constructor	Description
GenericJsonJWSBuilder(com.fasterxml.jackson.databind.ObjectMapper mapper, io.inverno.mod.security.jose.internal.converter.DataConversionService dataConversionService, JWKService jwkService, Type type)	Creates a generic JSON JWS builder.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<JsonJWS<A,JsonJWS.BuiltSignature<A>>>	build(String contentType)	Builds the JSON JOSE object using the specified payload media type.
reactor.core.publisher.Mono<JsonJWS<A,JsonJWS.BuiltSignature<A>>>	build(Function<A,reactor.core.publisher.Mono<String>> payloadEncoder)	Builds the JSON JOSE object using the specified payload encoder.
protected reactor.core.publisher.Mono<GenericJWSPayload<A>>	buildJWSPayload(Function<A,reactor.core.publisher.Mono<String>> overridingPayloadEncoder, String overridingContentType, String cty, Boolean b64)	Builds the JSON JWS.
GenericJsonJWSBuilder<A>	signature(Consumer<GenericJWSHeader> protectedHeaderConfigurer, Consumer<GenericJWSHeader> unprotectedHeaderConfigurer, org.reactivestreams.Publisher<? extends JWK> keys)	Specifies a signature to add to the resulting JSON JWS object using the specified keys.

Methods inherited from class io.inverno.mod.security.jose.internal.AbstractJsonJOSEObjectBuilder

checkPayload, getPayloadEncoder, headers, payload

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

build, headers, payload

Methods inherited from interface io.inverno.mod.security.jose.jws.JsonJWSBuilder

signature

Constructor Details

GenericJsonJWSBuilder

public GenericJsonJWSBuilder(com.fasterxml.jackson.databind.ObjectMapper mapper,
 io.inverno.mod.security.jose.internal.converter.DataConversionService dataConversionService,
 JWKService jwkService,
 Type type)

Creates a generic JSON JWS builder.

Parameters:

mapper - an object mapper

dataConversionService - a data conversion service

jwkService - a JWK service

type - the payload type

Method Details

signature

public GenericJsonJWSBuilder<A> signature(Consumer<GenericJWSHeader> protectedHeaderConfigurer,
 Consumer<GenericJWSHeader> unprotectedHeaderConfigurer,
 org.reactivestreams.Publisher<? extends JWK> keys)

Description copied from interface: JsonJWSBuilder

Specifies a signature to add to the resulting JSON JWS object using the specified keys.

The builder will use the specified keys to sign the payload, the first succeeding key will be retained and remaining keys will be ignored. It will fail if no suitable key have been specified or if they are not consistent with the JWS JOSE header resulting from the merge of the protected and unprotected headers.

Specified by:

signature in interface JsonJWSBuilder<A,GenericJWSHeader,GenericJsonJWSBuilder<A>>

Parameters:

protectedHeaderConfigurer - the protected JWE JOSE header configurer

unprotectedHeaderConfigurer - the unprotected JWE JOSE header configurer

keys - the keys to consider to sign the payload

Returns:

this builder

build

public reactor.core.publisher.Mono<JsonJWS<A,JsonJWS.BuiltSignature<A>>> build(String contentType)
                                                                        throws JWSBuildException,
JOSEObjectBuildException,
JOSEProcessingException

Description copied from interface: JsonJOSEObjectBuilder

Builds the JSON JOSE object using the specified payload media type.

The builder will use the specified media type to determine the converter to use to serialize the payload and ignore the content type specified in the JOSE headers. The operation will fail if there is no media type converters defined for that particular media type. Media types converters are provided when building the JOSE module. Please consider build method JsonJOSEObjectBuilder.build(java.util.function.Function) to provide a custom payload encoder.

Specified by:

build in interface JsonJOSEObjectBuilder<A,JsonJWS<A,JsonJWS.BuiltSignature<A>>,GenericJWSHeader,GenericJsonJWSBuilder<A>>

Parameters:

contentType - the payload media type

Returns:

a single JSON JOSE object publisher

Throws:

JOSEObjectBuildException - if there was an error building the JSON JOSE object

JOSEProcessingException - if there was a JOSE processing error

JWSBuildException

build

public reactor.core.publisher.Mono<JsonJWS<A,JsonJWS.BuiltSignature<A>>> build(Function<A,reactor.core.publisher.Mono<String>> payloadEncoder)
                                                                        throws JWSBuildException,
JOSEObjectBuildException,
JOSEProcessingException

Description copied from interface: JsonJOSEObjectBuilder

Builds the JSON JOSE object using the specified payload encoder.

The builder will use the specified payload encoder to serialize the payload and ignore the content type specified in the JOSE headers.

Specified by:

build in interface JsonJOSEObjectBuilder<A,JsonJWS<A,JsonJWS.BuiltSignature<A>>,GenericJWSHeader,GenericJsonJWSBuilder<A>>

Parameters:

payloadEncoder - a payload encoder

Returns:

a single JSON JOSE object publisher

Throws:

JOSEObjectBuildException - if there was an error building the JSON JOSE object

JOSEProcessingException - if there was a JOSE processing error

JWSBuildException

buildJWSPayload

protected reactor.core.publisher.Mono<GenericJWSPayload<A>> buildJWSPayload(Function<A,reactor.core.publisher.Mono<String>> overridingPayloadEncoder,
 String overridingContentType,
 String cty,
 Boolean b64)
                                                                     throws JWSBuildException,
JOSEObjectBuildException,
JOSEProcessingException

Builds the JSON JWS.

Parameters:

overridingPayloadEncoder - an overriding payload encoder

overridingContentType - an overriding payload content type

cty - common JSON JWS payload content type

b64 - common JSON JWS b64 parameter

Returns:

a single JSON JWS publisher

Throws:

JWSBuildException - if there was an error building the JSON JWS

JOSEObjectBuildException - if there was an error building the JSON JWS

JOSEProcessingException - if there was a JOSE processing error