Module iu.util.crypt.impl

Package iu.crypt

Class JwsBuilder

java.lang.Object

iu.crypt.JwsBuilder

All Implemented Interfaces:

WebCryptoHeader.Builder<JwsBuilder>, WebSignature.Builder<JwsBuilder>

public class JwsBuilder
extends Object
implements WebSignature.Builder<JwsBuilder>

Collects inputs for Jws encrypted messages.

Field Summary

Fields

Modifier and Type	Field	Description
static final IuJsonAdapter<WebSignedPayload>	JSON	IuJsonAdapter

Constructor Summary

Constructors

Constructor	Description
JwsBuilder(WebKey.Algorithm algorithm)	Constructor.

Method Summary

Modifier and Type	Method	Description
JwsBuilder	compact()	Protects all header parameters except jwk and verifies inputs are valid for JWE compact serialization.
JwsBuilder	contentType(String contentType)	Sets the header content type parameter value.
JwsBuilder	crit(String... parameterNames)	Sets critical parameter names.
JwsBuilder	key(WebKey key)	The key to use for encrypting or signing.
JwsBuilder	keyId(String keyId)	Sets the key ID relative to WebCryptoHeader.getKeySetUri() corresponding to a JWKS key entry.
JwsBuilder	next(WebKey.Algorithm algorithm)	Enqueues the current signature and resets the builder for the next entry.
<T> JwsBuilder	param(WebCryptoHeader.Param param, T value)	Sets a registered parameter value
<T> JwsBuilder	param(String name, T value)	Sets an extended parameter value
static JwsSignedPayload	parse(String jws)	Parses JWS signed payload from serialized form
JwsBuilder	protect(WebCryptoHeader.Param... params)	Defines registered protected header parameters.
JwsBuilder	protect(String... params)	Defines extended protected header parameters.
WebSignedPayload	sign(InputStream in)	Signs a raw data read from from an InputStream
JwsBuilder	type(String type)	Sets the header type parameter value.
JwsBuilder	wellKnown(WebKey key)	Sets the key to include with the header.
JwsBuilder	wellKnown(URI uri)	Sets the URI where JWKS well-known key data can be retrieved.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.iu.crypt.WebSignature.Builder

sign, sign

Field Details

JSON

public static final IuJsonAdapter<WebSignedPayload> JSON

IuJsonAdapter

Constructor Details

JwsBuilder

public JwsBuilder(WebKey.Algorithm algorithm)

Constructor.

Parameters:

algorithm - WebKey.Algorithm

Method Details

parse

public static JwsSignedPayload parse(String jws)

Parses JWS signed payload from serialized form

Parameters:

jws - compact or JSON serialized from

Returns:

JWS signed payload

next

public JwsBuilder next(WebKey.Algorithm algorithm)

Description copied from interface: WebSignature.Builder

Enqueues the current signature and resets the builder for the next entry.

Specified by:

next in interface WebSignature.Builder<JwsBuilder>

Parameters:

algorithm - WebKey.Algorithm

Returns:

WebSignature.Builder

compact

public JwsBuilder compact()

Description copied from interface: WebSignature.Builder

Protects all header parameters except jwk and verifies inputs are valid for JWE compact serialization.

Specified by:

compact in interface WebSignature.Builder<JwsBuilder>

Returns:

this

protect

public JwsBuilder protect(WebCryptoHeader.Param... params)

Description copied from interface: WebSignature.Builder

Defines registered protected header parameters.

Specified by:

protect in interface WebSignature.Builder<JwsBuilder>

Parameters:

params - protected header parameters

Returns:

this

protect

public JwsBuilder protect(String... params)

Description copied from interface: WebSignature.Builder

Defines extended protected header parameters.

Specified by:

protect in interface WebSignature.Builder<JwsBuilder>

Parameters:

params - protected header parameters

Returns:

this

keyId

public JwsBuilder keyId(String keyId)

Description copied from interface: WebCryptoHeader.Builder

Sets the key ID relative to WebCryptoHeader.getKeySetUri() corresponding to a JWKS key entry.

Specified by:

keyId in interface WebCryptoHeader.Builder<JwsBuilder>

Parameters:

keyId - key ID

Returns:

this

wellKnown

public JwsBuilder wellKnown(URI uri)

Description copied from interface: WebCryptoHeader.Builder

Sets the URI where JWKS well-known key data can be retrieved.

Specified by:

wellKnown in interface WebCryptoHeader.Builder<JwsBuilder>

Parameters:

uri - JWKS URI

Returns:

this

wellKnown

public JwsBuilder wellKnown(WebKey key)

Description copied from interface: WebCryptoHeader.Builder

Sets the key to include with the header.

Specified by:

wellKnown in interface WebCryptoHeader.Builder<JwsBuilder>

Parameters:

key - may include private/secret key data to use for encryption/signing; only WebKey.wellKnown() will be included in the header.

Returns:

this

key

public JwsBuilder key(WebKey key)

Description copied from interface: WebCryptoHeader.Builder

The key to use for encrypting or signing.

Specified by:

key in interface WebCryptoHeader.Builder<JwsBuilder>

Parameters:

key - key to use for encryption or signing; will not be included in the header. Use WebCryptoHeader.Builder.wellKnown(WebKey) to set the key and include well-known component in the header.

Returns:

this

type

public JwsBuilder type(String type)

Description copied from interface: WebCryptoHeader.Builder

Sets the header type parameter value.

Specified by:

type in interface WebCryptoHeader.Builder<JwsBuilder>

Parameters:

type - header type parameter value.

Returns:

this

contentType

public JwsBuilder contentType(String contentType)

Description copied from interface: WebCryptoHeader.Builder

Sets the header content type parameter value.

Specified by:

contentType in interface WebCryptoHeader.Builder<JwsBuilder>

Parameters:

contentType - header type parameter value.

Returns:

this

crit

public JwsBuilder crit(String... parameterNames)

Description copied from interface: WebCryptoHeader.Builder

Sets critical parameter names.

Specified by:

crit in interface WebCryptoHeader.Builder<JwsBuilder>

Parameters:

parameterNames - critical parameter names

Returns:

this

param

public <T> JwsBuilder param(WebCryptoHeader.Param param,
 T value)

Description copied from interface: WebCryptoHeader.Builder

Sets a registered parameter value

Specified by:

param in interface WebCryptoHeader.Builder<JwsBuilder>

Type Parameters:

T - value type

Parameters:

param - parameter

value - parameter value

Returns:

this

param

public <T> JwsBuilder param(String name,
 T value)

Description copied from interface: WebCryptoHeader.Builder

Sets an extended parameter value

Specified by:

param in interface WebCryptoHeader.Builder<JwsBuilder>

Type Parameters:

T - value type

Parameters:

name - parameter name

value - parameter value

Returns:

this

sign

public WebSignedPayload sign(InputStream in)

Description copied from interface: WebSignature.Builder

Signs a raw data read from from an InputStream

Specified by:

sign in interface WebSignature.Builder<JwsBuilder>

Parameters:

in - stream of data to sign

Returns:

signed data