io.jsonwebtoken

Interface JweHeaderMutator<T extends JweHeaderMutator<T>>

Type Parameters:

T - the mutator subtype, for method chaining

All Superinterfaces:

HeaderMutator<T>, MapMutator<String,Object,T>, ProtectedHeaderMutator<T>, X509Mutator<T>

All Known Subinterfaces:

JwtBuilder.BuilderHeader, Jwts.HeaderBuilder

public interface JweHeaderMutator<T extends JweHeaderMutator<T>>
extends ProtectedHeaderMutator<T>

Mutation (modifications) to a JweHeader instance.

Since:

0.12.0

Method Summary

Methods

Modifier and Type	Method and Description
T	agreementPartyUInfo(byte[] info) Sets any information about the JWE producer for use with key agreement algorithms.
T	agreementPartyUInfo(String info) Sets any information about the JWE producer for use with key agreement algorithms.
T	agreementPartyVInfo(byte[] info) Sets any information about the JWE recipient for use with key agreement algorithms.
T	agreementPartyVInfo(String info) Sets any information about the JWE recipient for use with key agreement algorithms.
T	pbes2Count(int count) Sets the number of PBKDF2 iterations necessary to derive the key used during JWE encryption.

Methods inherited from interface io.jsonwebtoken.ProtectedHeaderMutator

critical, jwk, jwkSetUrl, keyId, setAlgorithm, setKeyId

Methods inherited from interface io.jsonwebtoken.HeaderMutator

contentType, setCompressionAlgorithm, setContentType, setType, type

Methods inherited from interface io.jsonwebtoken.lang.MapMutator

add, add, delete, empty

Methods inherited from interface io.jsonwebtoken.security.X509Mutator

x509Chain, x509Sha1Thumbprint, x509Sha256Thumbprint, x509Url

Method Detail

agreementPartyUInfo

T agreementPartyUInfo(byte[] info)

Sets any information about the JWE producer for use with key agreement algorithms. A null or empty value removes the property from the JSON map.

Parameters:

info - information about the JWE producer to use with key agreement algorithms.

Returns:

the header for method chaining.

See Also:

JWE apu (Agreement PartyUInfo) Header Parameter, Jwts.KEY.ECDH_ES, Jwts.KEY.ECDH_ES_A128KW, Jwts.KEY.ECDH_ES_A192KW, Jwts.KEY.ECDH_ES_A256KW

agreementPartyUInfo

T agreementPartyUInfo(String info)

Sets any information about the JWE producer for use with key agreement algorithms. A null value removes the property from the JSON map.

If not null, this is a convenience method that calls the equivalent of the following:

 agreementPartyUInfo(info.getBytes(StandardCharsets.UTF_8))

Parameters:

info - information about the JWE producer to use with key agreement algorithms.

Returns:

the header for method chaining.

See Also:

JWE apu (Agreement PartyUInfo) Header Parameter, Jwts.KEY.ECDH_ES, Jwts.KEY.ECDH_ES_A128KW, Jwts.KEY.ECDH_ES_A192KW, Jwts.KEY.ECDH_ES_A256KW

agreementPartyVInfo

T agreementPartyVInfo(byte[] info)

Sets any information about the JWE recipient for use with key agreement algorithms. A null value removes the property from the JSON map.

Parameters:

info - information about the JWE recipient to use with key agreement algorithms.

Returns:

the header for method chaining.

See Also:

JWE apv (Agreement PartyVInfo) Header Parameter, Jwts.KEY.ECDH_ES, Jwts.KEY.ECDH_ES_A128KW, Jwts.KEY.ECDH_ES_A192KW, Jwts.KEY.ECDH_ES_A256KW

agreementPartyVInfo

T agreementPartyVInfo(String info)

Sets any information about the JWE recipient for use with key agreement algorithms. A null value removes the property from the JSON map.

If not null, this is a convenience method that calls the equivalent of the following:

 setAgreementPartVUInfo(info.getBytes(StandardCharsets.UTF_8))

Parameters:

info - information about the JWE recipient to use with key agreement algorithms.

Returns:

the header for method chaining.

See Also:

JWE apv (Agreement PartyVInfo) Header Parameter, Jwts.KEY.ECDH_ES, Jwts.KEY.ECDH_ES_A128KW, Jwts.KEY.ECDH_ES_A192KW, Jwts.KEY.ECDH_ES_A256KW

pbes2Count

T pbes2Count(int count)

Sets the number of PBKDF2 iterations necessary to derive the key used during JWE encryption. If this value is not set when a password-based KeyAlgorithm is used, JJWT will automatically choose a suitable number of iterations based on OWASP PBKDF2 Iteration Recommendations.

Minimum Count

IllegalArgumentException will be thrown during encryption if a specified count is less than 1000 (one thousand), which is the minimum number recommended by the JWA specification. Anything less is susceptible to security attacks so the default PBKDF2 KeyAlgorithm implementations reject such values.

Parameters:

count - the number of PBKDF2 iterations necessary to derive the key used during JWE encryption, must be greater than or equal to 1000 (one thousand).

Returns:

the header for method chaining

See Also:

JWE p2c (PBES2 Count) Header Parameter, Jwts.KEY.PBES2_HS256_A128KW, Jwts.KEY.PBES2_HS384_A192KW, Jwts.KEY.PBES2_HS512_A256KW, OWASP PBKDF2 Iteration Recommendations