com.nimbusds.jose

Class JWECryptoParts

java.lang.Object

com.nimbusds.jose.JWECryptoParts

@Immutable
public final class JWECryptoParts
extends Object

The cryptographic parts of a JSON Web Encryption (JWE) object. This class is an immutable wrapper for returning the cipher text, initialisation vector (IV), encrypted key and authentication authTag from JWEEncrypter implementations.

Version:

2014-07-11

Author:

Vladimir Dzhuvinov

Constructor Summary

Constructors

Constructor and Description
JWECryptoParts(Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authenticationTag) Creates a new cryptographic JWE parts instance.
JWECryptoParts(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authenticationTag) Creates a new cryptographic JWE parts instance.

Method Summary

Methods

Modifier and Type	Method and Description
Base64URL	getAuthenticationTag() Gets the authentication tag.
Base64URL	getCipherText() Gets the cipher text.
Base64URL	getEncryptedKey() Gets the encrypted key.
JWEHeader	getHeader() Gets the modified JWE header.
Base64URL	getInitializationVector() Gets the initialisation vector (IV).

Methods inherited from class java.lang.Object

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

Constructor Detail

JWECryptoParts

public JWECryptoParts(Base64URL encryptedKey,
              Base64URL iv,
              Base64URL cipherText,
              Base64URL authenticationTag)

Creates a new cryptographic JWE parts instance.

Parameters:

encryptedKey - The encrypted key, null if not required by the encryption algorithm.

iv - The initialisation vector (IV), null if not required by the encryption algorithm.

cipherText - The cipher text. Must not be null.

authenticationTag - The authentication tag, null if the JWE algorithm provides built-in integrity check.

JWECryptoParts

public JWECryptoParts(JWEHeader header,
              Base64URL encryptedKey,
              Base64URL iv,
              Base64URL cipherText,
              Base64URL authenticationTag)

Creates a new cryptographic JWE parts instance.

Parameters:

header - The modified JWE header, null if not.

encryptedKey - The encrypted key, null if not required by the encryption algorithm.

iv - The initialisation vector (IV), null if not required by the encryption algorithm.

cipherText - The cipher text. Must not be null.

authenticationTag - The authentication tag, null if the JWE algorithm provides built-in integrity check.

Method Detail

getHeader

public JWEHeader getHeader()

Gets the modified JWE header.

Returns:

The modified JWE header, null of not.

getEncryptedKey

public Base64URL getEncryptedKey()

Gets the encrypted key.

Returns:

The encrypted key, null if not required by the JWE algorithm.

getInitializationVector

public Base64URL getInitializationVector()

Gets the initialisation vector (IV).

Returns:

The initialisation vector (IV), null if not required by the JWE algorithm.

getCipherText

public Base64URL getCipherText()

Gets the cipher text.

Returns:

The cipher text.

getAuthenticationTag

public Base64URL getAuthenticationTag()

Gets the authentication tag.

Returns:

The authentication tag, null if the encryption algorithm provides built-in integrity checking.