io.jsonwebtoken

Interface JweHeader

All Superinterfaces:

Header, Map<String,Object>, ProtectedHeader, X509Accessor

public interface JweHeader
extends ProtectedHeader

A JWE header.

Since:

0.12.0

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from interface io.jsonwebtoken.Header

ALGORITHM, COMPRESSION_ALGORITHM, CONTENT_TYPE, DEPRECATED_COMPRESSION_ALGORITHM, JWT_TYPE, TYPE

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getAgreementPartyUInfo() Returns any information about the JWE producer for use with key agreement algorithms, or null if not present.
byte[]	getAgreementPartyVInfo() Returns any information about the JWE recipient for use with key agreement algorithms, or null if not present.
byte[]	getAuthenticationTag() Returns the 128-bit "tag" (Authentication Tag) resulting from key encryption, or null if not present.
String	getEncryptionAlgorithm() Returns the JWE enc (Encryption Algorithm) header value or null if not present.
PublicJwk<?>	getEphemeralPublicKey() Returns the epk (Ephemeral Public Key) header value created by the JWE originator for use with key agreement algorithms, or null if not present.
byte[]	getInitializationVector() Returns the 96-bit "iv" (Initialization Vector) generated during key encryption, or null if not present.
Integer	getPbes2Count() Returns the number of PBKDF2 iterations necessary to derive the key used during JWE encryption, or null if not present.
byte[]	getPbes2Salt() Returns the PBKDF2 Salt Input value necessary to derive the key used during JWE encryption, or null if not present.

Methods inherited from interface io.jsonwebtoken.ProtectedHeader

getCritical, getJwk, getJwkSetUrl, getKeyId

Methods inherited from interface io.jsonwebtoken.Header

getAlgorithm, getCompressionAlgorithm, getContentType, getType

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from interface io.jsonwebtoken.security.X509Accessor

getX509Chain, getX509Sha1Thumbprint, getX509Sha256Thumbprint, getX509Url

Method Detail

getEncryptionAlgorithm

String getEncryptionAlgorithm()

Returns the JWE enc (Encryption Algorithm) header value or null if not present.

The JWE enc (encryption algorithm) Header Parameter identifies the content encryption algorithm used to perform authenticated encryption on the plaintext to produce the ciphertext and the JWE Authentication Tag.

Note that there is no corresponding 'setter' method for this 'getter' because JJWT users set this value by supplying an AeadAlgorithm to a JwtBuilder via one of its encryptWith(SecretKey, AeadAlgorithm) or encryptWith(Key, KeyAlgorithm, AeadAlgorithm) methods. JJWT will then set this enc header value automatically to the AeadAlgorithm's getId() value during encryption.

Returns:

the JWE enc (Encryption Algorithm) header value or null if not present. This will always be non-null on validly-constructed JWE instances, but could be null during construction.

See Also:

JwtBuilder.encryptWith(SecretKey, AeadAlgorithm), JwtBuilder.encryptWith(Key, KeyAlgorithm, AeadAlgorithm)

getEphemeralPublicKey

PublicJwk<?> getEphemeralPublicKey()

Returns the epk (Ephemeral Public Key) header value created by the JWE originator for use with key agreement algorithms, or null if not present.

Note that there is no corresponding 'setter' method for this 'getter' because JJWT users set this value by supplying an ECDH-ES KeyAlgorithm to a JwtBuilder via its encryptWith(Key, KeyAlgorithm, AeadAlgorithm) method. The ECDH-ES KeyAlgorithm implementation will then set this epk header value automatically when producing the encryption key.

Returns:

the epk (Ephemeral Public Key) header value created by the JWE originator for use with key agreement algorithms, or null if not present.

See Also:

Jwts.KEY, Jwts.KEY.ECDH_ES, Jwts.KEY.ECDH_ES_A128KW, Jwts.KEY.ECDH_ES_A192KW, Jwts.KEY.ECDH_ES_A256KW

getAgreementPartyUInfo

byte[] getAgreementPartyUInfo()

Returns any information about the JWE producer for use with key agreement algorithms, or null if not present.

Returns:

any information about the JWE producer for use with key agreement algorithms, or null if not present.

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

getAgreementPartyVInfo

byte[] getAgreementPartyVInfo()

Returns any information about the JWE recipient for use with key agreement algorithms, or null if not present.

Returns:

any information about the JWE recipient for use with key agreement algorithms, or null if not present.

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

getInitializationVector

byte[] getInitializationVector()

Returns the 96-bit "iv" (Initialization Vector) generated during key encryption, or null if not present. Set by AES GCM KeyAlgorithm implementations.

Note that there is no corresponding 'setter' method for this 'getter' because JJWT users set this value by supplying an AES GCM Wrap KeyAlgorithm to a JwtBuilder via its encryptWith(Key, KeyAlgorithm, AeadAlgorithm) method. The AES GCM Wrap KeyAlgorithm implementation will then set this iv header value automatically when producing the encryption key.

Returns:

the 96-bit initialization vector generated during key encryption, or null if not present.

See Also:

Jwts.KEY.A128GCMKW, Jwts.KEY.A192GCMKW, Jwts.KEY.A256GCMKW

getAuthenticationTag

byte[] getAuthenticationTag()

Returns the 128-bit "tag" (Authentication Tag) resulting from key encryption, or null if not present.

Note that there is no corresponding 'setter' method for this 'getter' because JJWT users set this value by supplying an AES GCM Wrap KeyAlgorithm to a JwtBuilder via its encryptWith(Key, KeyAlgorithm, AeadAlgorithm) method. The AES GCM Wrap KeyAlgorithm implementation will then set this tag header value automatically when producing the encryption key.

Returns:

the 128-bit authentication tag resulting from key encryption, or null if not present.

See Also:

Jwts.KEY.A128GCMKW, Jwts.KEY.A192GCMKW, Jwts.KEY.A256GCMKW

getPbes2Count

Integer getPbes2Count()

Returns the number of PBKDF2 iterations necessary to derive the key used during JWE encryption, or null if not present. Used with password-based KeyAlgorithms.

Returns:

the number of PBKDF2 iterations necessary to derive the key used during JWE encryption, or null if not present.

See Also:

JWE p2c (PBES2 Count) Header Parameter, Jwts.KEY.PBES2_HS256_A128KW, Jwts.KEY.PBES2_HS384_A192KW, Jwts.KEY.PBES2_HS512_A256KW

getPbes2Salt

byte[] getPbes2Salt()

Returns the PBKDF2 Salt Input value necessary to derive the key used during JWE encryption, or null if not present.

Note that there is no corresponding 'setter' method for this 'getter' because JJWT users set this value by supplying a password-based KeyAlgorithm to a JwtBuilder via its encryptWith(Key, KeyAlgorithm, AeadAlgorithm) method. The password-based KeyAlgorithm implementation will then set this p2s header value automatically when producing the encryption key.

Returns:

the PBKDF2 Salt Input value necessary to derive the key used during JWE encryption, or null if not present.

See Also:

JWE p2s (PBES2 Salt Input) Header Parameter, Jwts.KEY.PBES2_HS256_A128KW, Jwts.KEY.PBES2_HS384_A192KW, Jwts.KEY.PBES2_HS512_A256KW