Module io.inverno.mod.security.jose

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

Class GenericJWSReader<A>

java.lang.Object

io.inverno.mod.security.jose.internal.AbstractJOSEObjectReader<A,JWSHeader,JWS<A>,GenericJWSReader<A>>

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

Type Parameters:

A - the payload type

All Implemented Interfaces:

JOSEObjectReader<A,JWSHeader,JWS<A>,GenericJWSReader<A>>, JWSReader<A,GenericJWSReader<A>>

Direct Known Subclasses:

SignatureJWSReader

public class GenericJWSReader<A>
extends AbstractJOSEObjectReader<A,JWSHeader,JWS<A>,GenericJWSReader<A>>
implements JWSReader<A,GenericJWSReader<A>>

Generic JSON Web Signature compact reader implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

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

applicationProcessedParameters, dataConversionService, jwkService, keys, mapper, type

Constructor Summary

Constructors

Constructor	Description
GenericJWSReader(com.fasterxml.jackson.databind.ObjectMapper mapper, io.inverno.mod.security.jose.internal.converter.DataConversionService dataConversionService, JWKService jwkService, Type type, org.reactivestreams.Publisher<? extends JWK> keys)	Creates a generic JWS reader.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<JWS<A>>	read(String compact, String contentType)	Reads the specified compact representation using the specified payload media type and returns the corresponding JOSE object.
reactor.core.publisher.Mono<JWS<A>>	read(String compact, Function<String,reactor.core.publisher.Mono<A>> payloadDecoder)	Reads the specified compact representation using the specified payload decoder and returns the corresponding JOSE object.
protected GenericJWSHeader	readJWSHeader(String encodedHeader)	Reads the JWS header.
protected reactor.core.publisher.Mono<GenericJWSPayload<A>>	readJWSPayload(String encodedPayload, Function<String,reactor.core.publisher.Mono<A>> overridingPayloadDecoder, String overridingContentType, GenericJWSHeader jwsHeader)	Reads the JWS payload.

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

checkCriticalParameters, checkHeader, getKeys, getPayloadDecoder, getProcessedParameters, processedParameters

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

processedParameters, read

Constructor Details

GenericJWSReader

public GenericJWSReader(com.fasterxml.jackson.databind.ObjectMapper mapper,
 io.inverno.mod.security.jose.internal.converter.DataConversionService dataConversionService,
 JWKService jwkService,
 Type type,
 org.reactivestreams.Publisher<? extends JWK> keys)

Creates a generic JWS reader.

Parameters:

mapper - an object mapper

dataConversionService - a data conversion service

jwkService - a JWK service

type - the payload type

keys - the keys to consider to verify the JWS

Method Details

read

public reactor.core.publisher.Mono<JWS<A>> read(String compact,
 String contentType)
                                         throws JWSReadException,
JWSBuildException,
JOSEObjectReadException,
JOSEObjectBuildException,
JOSEProcessingException

Description copied from interface: JOSEObjectReader

Reads the specified compact representation using the specified payload media type and returns the corresponding JOSE object.

The reader will use the specified media type to determine the converter to use to deserialize the payload and ignore the content type specified in the JOSE header. 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 read method JOSEObjectReader.read(java.lang.String, java.util.function.Function) to provide a custom payload decoder.

Specified by:

read in interface JOSEObjectReader<A,JWSHeader,JWS<A>,GenericJWSReader<A>>

Parameters:

compact - a JOSE object compact representation

contentType - the expected payload media type

Returns:

a single JOSE object publisher

Throws:

JOSEObjectReadException - if there was an error reading the JOSE object

JOSEObjectBuildException - if there was an error building the JOSE object

JOSEProcessingException - if there was a JOSE processing error

JWSReadException

JWSBuildException

read

public reactor.core.publisher.Mono<JWS<A>> read(String compact,
 Function<String,reactor.core.publisher.Mono<A>> payloadDecoder)
                                         throws JWSReadException,
JWSBuildException,
JOSEObjectReadException,
JOSEObjectBuildException,
JOSEProcessingException

Description copied from interface: JOSEObjectReader

Reads the specified compact representation using the specified payload decoder and returns the corresponding JOSE object.

The reader will use the specified payload decoder to deserialize the payload and ignore the content type specified in the JOSE header.

Specified by:

read in interface JOSEObjectReader<A,JWSHeader,JWS<A>,GenericJWSReader<A>>

Parameters:

compact - a JOSE object compact representation

payloadDecoder - a payload decoder

Returns:

a single JOSE object publisher

Throws:

JOSEObjectReadException - if there was an error reading the JOSE object

JOSEObjectBuildException - if there was an error building the JOSE object

JOSEProcessingException - if there was a JOSE processing error

JWSReadException

JWSBuildException

readJWSHeader

protected GenericJWSHeader readJWSHeader(String encodedHeader)
                                  throws JWSReadException,
JOSEObjectReadException,
JOSEProcessingException

Reads the JWS header.

Parameters:

encodedHeader - the Base64URL encoded JWS header

Returns:

the JWS header

Throws:

JWSReadException - if there was an error reading the JWS header

JOSEObjectReadException - if there was an error reading the JWS header

JOSEProcessingException - if there was a JOSE processing error

readJWSPayload

protected reactor.core.publisher.Mono<GenericJWSPayload<A>> readJWSPayload(String encodedPayload,
 Function<String,reactor.core.publisher.Mono<A>> overridingPayloadDecoder,
 String overridingContentType,
 GenericJWSHeader jwsHeader)
                                                                    throws JWSReadException,
JOSEObjectReadException,
JOSEProcessingException

Reads the JWS payload.

Parameters:

encodedPayload - the Base64URL encoded payload

overridingPayloadDecoder - an overriding payload decoder

overridingContentType - an overriding payload content type

jwsHeader - the JWS header

Returns:

a single JWS payload publisher

Throws:

JWSReadException - if there was an error reading the JWS payload

JOSEObjectReadException - if there was an error reading the JWS payload

JOSEProcessingException - if there was a JOSE processing error