Module io.inverno.mod.security.jose

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

Class GenericJsonJWS.GenericReadSignature<A>

java.lang.Object

io.inverno.mod.security.jose.internal.jws.GenericJsonJWS.AbstractSignature<A>

io.inverno.mod.security.jose.internal.jws.GenericJsonJWS.GenericReadSignature<A>

Type Parameters:

A - the payload type

All Implemented Interfaces:

JsonJWS.ReadSignature<A>, JsonJWS.Signature<A>

Enclosing class:

GenericJsonJWS<A,B extends JsonJWS.Signature<A>>

public static class GenericJsonJWS.GenericReadSignature<A>
extends GenericJsonJWS.AbstractSignature<A>
implements JsonJWS.ReadSignature<A>

Generic read signature implementation.

Since:

1.5

Author:

Jeremy Kuhn

Field Summary

Fields inherited from class io.inverno.mod.security.jose.internal.jws.GenericJsonJWS.AbstractSignature

protectedHeader, unprotectedHeader

Constructor Summary

Constructors

Constructor	Description
GenericReadSignature(JWSHeader protectedHeader, JWSHeader unprotectedHeader, String signature, Function<org.reactivestreams.Publisher<? extends JWK>,reactor.core.publisher.Mono<JWS<A>>> jwsFactory)	Creates a JSON JWS read signature.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getSignature()	Returns the signature encoded as Base64URL.
int	hashCode()
reactor.core.publisher.Mono<JWS<A>>	readJWS()	Returns the signature JWS publisher.
reactor.core.publisher.Mono<JWS<A>>	readJWS(org.reactivestreams.Publisher<? extends JWK> keys)	Returns the signature JWS publisher with the specified keys.

Methods inherited from class io.inverno.mod.security.jose.internal.jws.GenericJsonJWS.AbstractSignature

getEncodedProtectedHeader, getProtectedHeader, getUnprotectedHeader

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.inverno.mod.security.jose.jws.JsonJWS.Signature

getProtectedHeader, getUnprotectedHeader

Constructor Details

GenericReadSignature

public GenericReadSignature(JWSHeader protectedHeader,
 JWSHeader unprotectedHeader,
 String signature,
 Function<org.reactivestreams.Publisher<? extends JWK>,reactor.core.publisher.Mono<JWS<A>>> jwsFactory)

Creates a JSON JWS read signature.

Parameters:

protectedHeader - the signature specific protected JWS header

unprotectedHeader - the signature specific unprotected JWS header

signature - the signature specific Base64URL encoded signature without padding

jwsFactory - the signature JWS factory used to verify signature JWS

Method Details

getSignature

public String getSignature()

Description copied from interface: JsonJWS.Signature

Returns the signature encoded as Base64URL.

Specified by:

getSignature in interface JsonJWS.Signature<A>

Returns:

the Base64URL encoded signature with no padding

readJWS

public reactor.core.publisher.Mono<JWS<A>> readJWS()
                                            throws JWSReadException,
JWSBuildException,
JOSEObjectReadException,
JOSEObjectBuildException,
JOSEProcessingException

Description copied from interface: JsonJWS.ReadSignature

Returns the signature JWS publisher.

The resulting publisher will try to resolve the JWK to use for validating the signature based on the JWS JOSE header resulting from the merge of the protected and unprotected headers. It will fail if it wasn't able to find a suitable key.

Specified by:

readJWS in interface JsonJWS.ReadSignature<A>

Returns:

a JWS publisher for validating the recipient JWS

Throws:

JWSReadException - if there was an error reading the recipient JWS

JWSBuildException - if there was an error building the recipient JWS

JOSEObjectReadException - if there was a JOSE object reading error

JOSEObjectBuildException - if there was a JOSE object building error

JOSEProcessingException - if there was a JOSE processing error

readJWS

public reactor.core.publisher.Mono<JWS<A>> readJWS(org.reactivestreams.Publisher<? extends JWK> keys)
                                            throws JWSReadException,
JWSBuildException,
JOSEObjectReadException,
JOSEObjectBuildException,
JOSEProcessingException

Description copied from interface: JsonJWS.ReadSignature

Returns the signature JWS publisher with the specified keys.

The resulting publisher will use the specified keys for validating the signature, 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:

readJWS in interface JsonJWS.ReadSignature<A>

Parameters:

keys - the keys to consider to decrypt the recipient content encryption key

Returns:

a JWS publisher for validating the recipient JWS

Throws:

JWSReadException - if there was an error reading the recipient JWS

JWSBuildException - if there was an error building the recipient JWS

JOSEObjectReadException - if there was a JOSE object reading error

JOSEObjectBuildException - if there was a JOSE object building error

JOSEProcessingException - if there was a JOSE processing error

hashCode

public int hashCode()

Specified by:

hashCode in interface JsonJWS.Signature<A>

Overrides:

hashCode in class GenericJsonJWS.AbstractSignature<A>

equals

public boolean equals(Object obj)

Specified by:

equals in interface JsonJWS.Signature<A>

Overrides:

equals in class GenericJsonJWS.AbstractSignature<A>