Uses of Class
com.nimbusds.jose.JWEHeader

Packages that use JWEHeader

Package	Description
com.nimbusds.jose	Base Javascript Object Signing and Encryption (JOSE) interfaces and classes.
com.nimbusds.jose.crypto	Implementations of standard Javascript Object Signing and Encryption (JOSE) algorithms.
com.nimbusds.jose.crypto.factories	JWS signer, JWS verifier, JWE encrypter and JWE decrypter factory implementations.
com.nimbusds.jose.crypto.impl	Cryptographic primitives for JWS signers, JWS verifiers, JWE encrypters and JWE decrypters in the com.nimbusds.jose.crypto package.
com.nimbusds.jose.jwk	JSON Web Key (JWK) classes.
com.nimbusds.jose.proc	Framework for application-specific verification and decryption of JOSE objects (with arbitrary payloads).
com.nimbusds.jwt	JSON Web Token (JWT) interfaces and classes.

Uses of JWEHeader in com.nimbusds.jose

Methods in com.nimbusds.jose that return JWEHeader

Modifier and Type	Method	Description
JWEHeader	JWEHeader.Builder.build()	Builds a new JWE header.
JWEHeader	JWECryptoParts.getHeader()	Gets the modified JWE header.
JWEHeader	JWEObject.getHeader()
JWEHeader	JWEObjectJSON.getHeader()	Returns the JWE protected header of this JWE object.
static JWEHeader	JWEHeader.parse(Base64URL base64URL)	Parses a JWE header from the specified Base64URL.
static JWEHeader	JWEHeader.parse(String jsonString)	Parses a JWE header from the specified JSON object string.
static JWEHeader	JWEHeader.parse(String jsonString, Base64URL parsedBase64URL)	Parses a JWE header from the specified JSON object string.
static JWEHeader	JWEHeader.parse(Map<String,Object> jsonObject)	Parses a JWE header from the specified JSON object.
static JWEHeader	JWEHeader.parse(Map<String,Object> jsonObject, Base64URL parsedBase64URL)	Parses a JWE header from the specified JSON object.

Methods in com.nimbusds.jose with parameters of type JWEHeader

Modifier and Type	Method	Description
byte[]	JWEDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, byte[] aad)	Decrypts the specified cipher text of a JWE Object.
JWECryptoParts	JWEEncrypter.encrypt(JWEHeader header, byte[] clearText, byte[] aad)	Encrypts the specified clear text of a JWE object.

Constructors in com.nimbusds.jose with parameters of type JWEHeader

Constructor	Description
Builder(JWEHeader jweHeader)	Creates a new JWE header builder with the parameters from the specified header.
JWECryptoParts(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authenticationTag)	Creates a new cryptographic JWE parts instance.
JWEHeader(JWEHeader jweHeader)	Deep copy constructor.
JWEObject(JWEHeader header, Payload payload)	Creates a new to-be-encrypted JSON Web Encryption (JWE) object with the specified header and payload.
JWEObjectJSON(JWEHeader header, Payload payload)	Creates a new to-be-encrypted JSON Web Encryption (JWE) object with the specified JWE protected header and payload.
JWEObjectJSON(JWEHeader header, Payload payload, UnprotectedHeader unprotectedHeader, byte[] aad)	Creates a new to-be-encrypted JSON Web Encryption (JWE) object with the specified JWE protected header, payload and Additional Authenticated Data (AAD).
JWEObjectJSON(JWEHeader header, Base64URL cipherText, Base64URL iv, Base64URL authTag, List<JWEObjectJSON.Recipient> recipients, UnprotectedHeader unprotectedHeader, byte[] aad)	Creates a new encrypted JSON Web Encryption (JWE) object.

Uses of JWEHeader in com.nimbusds.jose.crypto

Methods in com.nimbusds.jose.crypto with parameters of type JWEHeader

Modifier and Type	Method	Description
byte[]	AESDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Deprecated.
byte[]	AESDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, byte[] aad)
byte[]	DirectDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Deprecated.
byte[]	DirectDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, byte[] aad)
byte[]	ECDH1PUDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Deprecated.
byte[]	ECDH1PUDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, byte[] aad)
byte[]	ECDH1PUX25519Decrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Deprecated.
byte[]	ECDH1PUX25519Decrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, byte[] aad)
byte[]	ECDHDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Deprecated.
byte[]	ECDHDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, byte[] aad)
byte[]	MultiDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Deprecated.
byte[]	MultiDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, byte[] aad)
byte[]	PasswordBasedDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Deprecated.
byte[]	PasswordBasedDecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, byte[] aad)
byte[]	RSADecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Deprecated.
byte[]	RSADecrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, byte[] aad)
byte[]	X25519Decrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Deprecated.
byte[]	X25519Decrypter.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, byte[] aad)
JWECryptoParts	AESEncrypter.encrypt(JWEHeader header, byte[] clearText)	Deprecated.
JWECryptoParts	AESEncrypter.encrypt(JWEHeader header, byte[] clearText, byte[] aad)
JWECryptoParts	DirectEncrypter.encrypt(JWEHeader header, byte[] clearText)	Deprecated.
JWECryptoParts	DirectEncrypter.encrypt(JWEHeader header, byte[] clearText, byte[] aad)
JWECryptoParts	ECDH1PUEncrypter.encrypt(JWEHeader header, byte[] clearText)	Deprecated.
JWECryptoParts	ECDH1PUEncrypter.encrypt(JWEHeader header, byte[] clearText, byte[] aad)
JWECryptoParts	ECDH1PUX25519Encrypter.encrypt(JWEHeader header, byte[] clearText)	Deprecated.
JWECryptoParts	ECDH1PUX25519Encrypter.encrypt(JWEHeader header, byte[] clearText, byte[] aad)
JWECryptoParts	ECDHEncrypter.encrypt(JWEHeader header, byte[] clearText)	Deprecated.
JWECryptoParts	ECDHEncrypter.encrypt(JWEHeader header, byte[] clearText, byte[] aad)
JWECryptoParts	MultiEncrypter.encrypt(JWEHeader header, byte[] clearText)	Deprecated.
JWECryptoParts	MultiEncrypter.encrypt(JWEHeader header, byte[] clearText, byte[] aad)
JWECryptoParts	PasswordBasedEncrypter.encrypt(JWEHeader header, byte[] clearText)	Deprecated.
JWECryptoParts	PasswordBasedEncrypter.encrypt(JWEHeader header, byte[] clearText, byte[] aad)
JWECryptoParts	RSAEncrypter.encrypt(JWEHeader header, byte[] clearText)	Deprecated.
JWECryptoParts	RSAEncrypter.encrypt(JWEHeader header, byte[] clearText, byte[] aad)
JWECryptoParts	X25519Encrypter.encrypt(JWEHeader header, byte[] clearText)	Deprecated.
JWECryptoParts	X25519Encrypter.encrypt(JWEHeader header, byte[] clearText, byte[] aad)

Uses of JWEHeader in com.nimbusds.jose.crypto.factories

Methods in com.nimbusds.jose.crypto.factories with parameters of type JWEHeader

Modifier and Type	Method	Description
JWEDecrypter	DefaultJWEDecrypterFactory.createJWEDecrypter(JWEHeader header, Key key)

Uses of JWEHeader in com.nimbusds.jose.crypto.impl

Methods in com.nimbusds.jose.crypto.impl with parameters of type JWEHeader

Modifier and Type	Method	Description
static byte[]	DeflateHelper.applyCompression(JWEHeader jweHeader, byte[] bytes)	Applies compression to the specified plain text if requested.
static byte[]	DeflateHelper.applyDecompression(JWEHeader jweHeader, byte[] bytes)	Applies decompression to the specified plain text if requested.
static byte[]	AAD.compute(JWEHeader jweHeader)	Computes the Additional Authenticated Data (AAD) for the specified JWE header.
static byte[]	ContentCryptoProvider.decrypt(JWEHeader header, byte[] aad, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, SecretKey cek, JWEJCAContext jcaProvider)	Decrypts the specified cipher text.
static byte[]	ContentCryptoProvider.decrypt(JWEHeader header, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, SecretKey cek, JWEJCAContext jcaProvider)	Decrypts the specified cipher text.
static byte[]	AESCBC.decryptWithConcatKDF(JWEHeader header, SecretKey secretKey, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag, Provider ceProvider, Provider macProvider)	Decrypts the specified cipher text using the deprecated concat KDF from JOSE draft suite 09.
protected byte[]	ECDH1PUCryptoProvider.decryptWithZ(JWEHeader header, byte[] aad, SecretKey Z, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Decrypts the encrypted JWE parts using the specified shared secret ("Z").
protected byte[]	ECDHCryptoProvider.decryptWithZ(JWEHeader header, byte[] aad, SecretKey Z, Base64URL encryptedKey, Base64URL iv, Base64URL cipherText, Base64URL authTag)	Decrypts the encrypted JWE parts using the specified shared secret ("Z").
static SecretKey	ECDH.deriveSharedKey(JWEHeader header, SecretKey Z, ConcatKDF concatKDF)	Derives a shared key (via concat KDF).
static SecretKey	ECDH1PU.deriveSharedKey(JWEHeader header, SecretKey Z, ConcatKDF concatKDF)	Derives a shared key (via concat KDF).
static SecretKey	ECDH1PU.deriveSharedKey(JWEHeader header, SecretKey Z, Base64URL tag, ConcatKDF concatKDF)	Derives a shared key (via concat KDF).
static JWECryptoParts	ContentCryptoProvider.encrypt(JWEHeader header, byte[] clearText, byte[] aad, SecretKey cek, Base64URL encryptedKey, JWEJCAContext jcaProvider)	Encrypts the specified clear text (content).
static JWECryptoParts	ContentCryptoProvider.encrypt(JWEHeader header, byte[] clearText, SecretKey cek, Base64URL encryptedKey, JWEJCAContext jcaProvider)	Encrypts the specified clear text (content).
static AuthenticatedCipherText	AESCBC.encryptWithConcatKDF(JWEHeader header, SecretKey secretKey, Base64URL encryptedKey, byte[] iv, byte[] plainText, Provider ceProvider, Provider macProvider)	Encrypts the specified plain text using the deprecated concat KDF from JOSE draft suite 09.
protected JWECryptoParts	ECDH1PUCryptoProvider.encryptWithZ(JWEHeader header, SecretKey Z, byte[] clearText, byte[] aad)	Encrypts the specified plaintext using the specified shared secret ("Z").
protected JWECryptoParts	ECDHCryptoProvider.encryptWithZ(JWEHeader header, SecretKey Z, byte[] clearText, byte[] aad)	Encrypts the specified plaintext using the specified shared secret ("Z").
void	CriticalHeaderParamsDeferral.ensureHeaderPasses(JWEHeader header)	Throws a JOSE exception if the specified JWE header doesn't pass the critical header parameters check.
static JWEAlgorithm	JWEHeaderValidation.getAlgorithmAndEnsureNotNull(JWEHeader jweHeader)	Gets the JWE algorithm of the specified header and ensure it is not null.

Uses of JWEHeader in com.nimbusds.jose.jwk

Methods in com.nimbusds.jose.jwk with parameters of type JWEHeader

Modifier and Type	Method	Description
static JWKMatcher	JWKMatcher.forJWEHeader(JWEHeader jweHeader)	Returns a JWKMatcher based on the given JWEHeader.

Uses of JWEHeader in com.nimbusds.jose.proc

Methods in com.nimbusds.jose.proc with parameters of type JWEHeader

Modifier and Type	Method	Description
JWEDecrypter	JWEDecrypterFactory.createJWEDecrypter(JWEHeader header, Key key)	Creates a new JWE decrypter for the specified header and key.
protected JWKMatcher	JWEDecryptionKeySelector.createJWKMatcher(JWEHeader jweHeader)	Creates a JWK matcher for the expected JWE algorithms and the specified JWE header.
List<Key>	JWEDecryptionKeySelector.selectJWEKeys(JWEHeader jweHeader, C context)
List<? extends Key>	JWEKeySelector.selectJWEKeys(JWEHeader header, C context)	Selects key candidates for decrypting a JWE object.

Uses of JWEHeader in com.nimbusds.jwt

Constructors in com.nimbusds.jwt with parameters of type JWEHeader

Constructor	Description
EncryptedJWT(JWEHeader header, JWTClaimsSet claimsSet)	Creates a new to-be-encrypted JSON Web Token (JWT) with the specified header and claims set.