io.inverno.mod.security.jose.internal.jwe.RecipientJWEBuilder<A>

Type Parameters:: A - the payload type

All Implemented Interfaces:: JOSEObjectBuilder<A,JWEHeader,JWE<A>,GenericJWEHeader,GenericJWEBuilder<A>>, JWEBuilder<A,GenericJWEHeader,GenericJWEBuilder<A>>

public class RecipientJWEBuilder<A> extends GenericJWEBuilder<A>

JSON JWE recipient specific JWE builder used to build recipient specific JWE when building a JSON JWE.

Since:: 1.5
Author:: Jeremy Kuhn

Field Summary

Fields inherited from class io.inverno.mod.security.jose.internal.jwe.GenericJWEBuilder
headerConfigurer

Fields inherited from class io.inverno.mod.security.jose.internal.AbstractJOSEObjectBuilder
dataConversionService, jwkService, keys, mapper, payload, type
Constructor Summary

Constructors

Constructor

Description

RecipientJWEBuilder(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, List<JWEZip> zips, GenericJWEHeader protectedJWEHeader, GenericJWEHeader recipientJWEHeader, GenericJWEHeader jweHeader, GenericJWEPayload<A> jwePayload, byte[] aad)

Creates a JSON JWE recipient builder.

RecipientJWEBuilder(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, List<JWEZip> zips, GenericJWEHeader protectedJWEHeader, GenericJWEHeader recipientJWEHeader, GenericJWEHeader jweHeader, GenericJWEPayload<A> jwePayload, byte[] aad, JWK cek, JWACipher.EncryptedData zipAndEncryptedPayload)

Creates a JSON JWE recipient builder.
Method Summary

Modifier and Type

Method

Description

protected void

amendJWEHeader(GenericJWEHeader header, Map<String,Object> moreHeaderParameters, Set<String> processedParameters)

Amends the JWE header with custom parameters and processed parameters output by key management and encryption algorithms.

protected GenericJWEHeader

buildJWEHeader()

Builds the JWE header.

protected reactor.core.publisher.Mono<GenericJWEPayload<A>>

buildJWEPayload(Function<A,reactor.core.publisher.Mono<String>> overridingPayloadEncoder, String overridingContentType, GenericJWEHeader jweHeader)

Builds the JWE payload.

protected reactor.core.publisher.Flux<? extends JWK>

generateCEK(GenericJWEHeader jweHeader)

Generates Content Encryption Keys used to encrypt the payload.

protected byte[]

getAdditionalAuthenticationData(GenericJWEHeader jweHeader)

Returns additional authentication data.

GenericJWEBuilder<A>

header(Consumer<GenericJWEHeader> configurer)

Specifies the JOSE header.

GenericJWEBuilder<A>

payload(A payload)

Specifies the JOSE object payload.

protected JWACipher.EncryptedData

zipAndEncryptPayload(GenericJWEHeader jweHeader, GenericJWEPayload<A> jwePayload, JWEZip payloadZip, JWK cek)

Compresses and encrypt the JWE payload.

Methods inherited from class io.inverno.mod.security.jose.internal.jwe.GenericJWEBuilder
build, build, checkHeader, getPayloadZip, getProcessedParameters, secureRandom

Methods inherited from class io.inverno.mod.security.jose.internal.AbstractJOSEObjectBuilder
checkPayload, getKeys, getPayloadEncoder

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.JOSEObjectBuilder
build

Constructor Details
- RecipientJWEBuilder
  
  public RecipientJWEBuilder(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, List<JWEZip> zips, GenericJWEHeader protectedJWEHeader, GenericJWEHeader recipientJWEHeader, GenericJWEHeader jweHeader, GenericJWEPayload<A> jwePayload, byte[] aad)
  
  Creates a JSON JWE recipient builder.
  
  Parameters:
  
  mapper - an object mapper
  
  dataConversionService - a data conversion service
  
  jwkService - a JWK service
  
  type - the payload type
  
  keys - the recipient specific keys to consider to secure the CEK
  
  zips - a list of supported JWE compression algorithms
  
  protectedJWEHeader - the JSON JWE protected header
  
  recipientJWEHeader - the JSON JWE unprotected header
  
  jweHeader - the recipient JWE header
  
  jwePayload - the JSON JWE payload
  
  aad - the additional authentication data
- RecipientJWEBuilder
  
  public RecipientJWEBuilder(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, List<JWEZip> zips, GenericJWEHeader protectedJWEHeader, GenericJWEHeader recipientJWEHeader, GenericJWEHeader jweHeader, GenericJWEPayload<A> jwePayload, byte[] aad, JWK cek, JWACipher.EncryptedData zipAndEncryptedPayload)
  
  Creates a JSON JWE recipient builder.
  
  Parameters:
  
  mapper - an object mapper
  
  dataConversionService - a data conversion service
  
  jwkService - a JWK service
  
  type - the payload type
  
  keys - the recipient specific keys to consider to secure the CEK
  
  zips - a list of supported JWE compression algorithms
  
  protectedJWEHeader - the JSON JWE protected header
  
  recipientJWEHeader - the JSON JWE unprotected header
  
  jweHeader - the recipient JWE header
  
  jwePayload - the JSON JWE payload
  
  aad - the additional authentication data
  
  cek - the JSON JWE Content Encryption key
  
  zipAndEncryptedPayload - the encrypted payload
Method Details
- header
  
  public GenericJWEBuilder<A> header(Consumer<GenericJWEHeader> configurer)
  
  Description copied from interface: JOSEObjectBuilder
  
  Specifies the JOSE header.
  
  Specified by:
  
  header in interface JOSEObjectBuilder<A,JWEHeader,JWE<A>,GenericJWEHeader,GenericJWEBuilder<A>>
  
  Overrides:
  
  header in class GenericJWEBuilder<A>
  
  Parameters:
  
  configurer - a JOSE header configurer
  
  Returns:
  
  this builder
- payload
  
  public GenericJWEBuilder<A> payload(A payload)
  
  Description copied from interface: JOSEObjectBuilder
  
  Specifies the JOSE object payload.
  
  Specified by:
  
  payload in interface JOSEObjectBuilder<A,JWEHeader,JWE<A>,GenericJWEHeader,GenericJWEBuilder<A>>
  
  Overrides:
  
  payload in class AbstractJOSEObjectBuilder<A,JWEHeader,JWE<A>,GenericJWEHeader,GenericJWEBuilder<A>>
  
  Parameters:
  
  payload - a payload
  
  Returns:
  
  this builder
- buildJWEHeader
  
  protected GenericJWEHeader buildJWEHeader() throws JWEBuildException, JOSEObjectBuildException, JOSEProcessingException
  
  Description copied from class: GenericJWEBuilder
  
  Builds the JWE header.
  
  Overrides:
  
  buildJWEHeader in class GenericJWEBuilder<A>
  
  Returns:
  
  the JWE header
  
  Throws:
  
  JWEBuildException - if there was an error building the JWE header
  
  JOSEObjectBuildException - if there was an error building the JWE header
  
  JOSEProcessingException - if there was a JOSE processing error
- buildJWEPayload
  
  protected reactor.core.publisher.Mono<GenericJWEPayload<A>> buildJWEPayload(Function<A,reactor.core.publisher.Mono<String>> overridingPayloadEncoder, String overridingContentType, GenericJWEHeader jweHeader) throws JWEBuildException, JOSEObjectBuildException, JOSEProcessingException
  
  Description copied from class: GenericJWEBuilder
  
  Builds the JWE payload.
  
  Overrides:
  
  buildJWEPayload in class GenericJWEBuilder<A>
  
  Parameters:
  
  overridingPayloadEncoder - an overriding payload encoder
  
  overridingContentType - an overriding payload content type
  
  jweHeader - the JWE header
  
  Returns:
  
  a single JWE payload publisher
  
  Throws:
  
  JWEBuildException - if there was an error building the JWE payload
  
  JOSEObjectBuildException - if there was an error building the JWE payload
  
  JOSEProcessingException - if there was a JOSE processing error
- generateCEK
  
  protected reactor.core.publisher.Flux<? extends JWK> generateCEK(GenericJWEHeader jweHeader) throws JWKGenerateException
  
  Description copied from class: GenericJWEBuilder
  
  Generates Content Encryption Keys used to encrypt the payload.
  
  This can result in multiple keys depending on the target encryption algorithm and the JWK service setup, the first succeeding key will be retained and the others dropped before they are generated.
  
  Overrides:
  
  generateCEK in class GenericJWEBuilder<A>
  
  Parameters:
  
  jweHeader - the JWE header
  
  Returns:
  
  a JWK publisher
  
  Throws:
  
  JWKGenerateException - if no CEK corresponding to the encryption algorithm could be generated
- amendJWEHeader
  
  protected void amendJWEHeader(GenericJWEHeader header, Map<String,Object> moreHeaderParameters, Set<String> processedParameters) throws JWEBuildException, JOSEObjectBuildException, JOSEProcessingException
  
  Description copied from class: GenericJWEBuilder
  
  Amends the JWE header with custom parameters and processed parameters output by key management and encryption algorithms.
  
  Overrides:
  
  amendJWEHeader in class GenericJWEBuilder<A>
  
  Parameters:
  
  header - the JWE header
  
  moreHeaderParameters - custom parameters
  
  processedParameters - processed parameters
  
  Throws:
  
  JWEBuildException - if there was an error amending the JWE header
  
  JOSEObjectBuildException - if there was an error amending the JWE header
  
  JOSEProcessingException - if there was a JOSE processing error
- getAdditionalAuthenticationData
  
  protected byte[] getAdditionalAuthenticationData(GenericJWEHeader jweHeader)
  
  Description copied from class: GenericJWEBuilder
  
  Returns additional authentication data.
  
  For a compact JWE it should be ASCII(Encoded Protected Header). For a JSON JWE it should be ASCII(Encoded Protected Header || '.' || BASE64URL(JWE AAD)).
  
  Overrides:
  
  getAdditionalAuthenticationData in class GenericJWEBuilder<A>
  
  Parameters:
  
  jweHeader - the JWE header
  
  Returns:
  
  the additional authentication data
- zipAndEncryptPayload
  
  protected JWACipher.EncryptedData zipAndEncryptPayload(GenericJWEHeader jweHeader, GenericJWEPayload<A> jwePayload, JWEZip payloadZip, JWK cek) throws JWKProcessingException, JWEZipException, JWACipherException
  
  Description copied from class: GenericJWEBuilder
  
  Compresses and encrypt the JWE payload.
  
  Overrides:
  
  zipAndEncryptPayload in class GenericJWEBuilder<A>
  
  Parameters:
  
  jweHeader - the JWE header
  
  jwePayload - the JWE payload
  
  payloadZip - the JWE payload compression algorithm
  
  cek - the Content Encryption Key
  
  Returns:
  
  encrypted data
  
  Throws:
  
  JWKProcessingException - if there was an error obtaining the cipher instance
  
  JWEZipException - if there was an error compressing the payload
  
  JWACipherException - if there was an error encrypting the payload

Class RecipientJWEBuilder<A>

Field Summary

Fields inherited from class io.inverno.mod.security.jose.internal.jwe.GenericJWEBuilder

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

Constructor Summary

Method Summary

Methods inherited from class io.inverno.mod.security.jose.internal.jwe.GenericJWEBuilder

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

Methods inherited from class java.lang.Object

Methods inherited from interface io.inverno.mod.security.jose.JOSEObjectBuilder

Constructor Details

RecipientJWEBuilder

RecipientJWEBuilder

Method Details

header

payload

buildJWEHeader

buildJWEPayload

generateCEK

amendJWEHeader

getAdditionalAuthenticationData

zipAndEncryptPayload