Package org.jose4j.jwe

Class JsonWebEncryption

java.lang.Object

org.jose4j.jwx.JsonWebStructure

org.jose4j.jwe.JsonWebEncryption

public class JsonWebEncryption
extends JsonWebStructure

Field Summary

Fields

Modifier and Type	Field	Description
static final short	COMPACT_SERIALIZATION_PARTS

Fields inherited from class org.jose4j.jwx.JsonWebStructure

doKeyValidation, headers, rawCompactSerialization

Constructor Summary

Constructors

Constructor	Description
JsonWebEncryption()

Method Summary

Modifier and Type	Method	Description
void	enableDefaultCompression()
KeyManagementAlgorithm	getAlgorithm()
KeyManagementAlgorithm	getAlgorithmNoConstraintCheck()
String	getCompactSerialization()
String	getCompressionAlgorithmHeaderParameter()
ContentEncryptionAlgorithm	getContentEncryptionAlgorithm()
byte[]	getContentEncryptionKey()
byte[]	getEncryptedKey()
String	getEncryptionMethodHeaderParameter()
byte[]	getIv()
KeyManagementAlgorithm	getKeyManagementModeAlgorithm()
String	getPayload()
byte[]	getPlaintextBytes()
String	getPlaintextString()
CryptoPrimitive	prepareDecryptingPrimitive()	Create, initialize and return the CryptoPrimitive that this JWE instance will use for agreement or decryption of the content encryption key.
protected void	setCompactSerializationParts(String[] parts)
void	setCompressionAlgorithmHeaderParameter(String zip)
void	setContentEncryptionAlgorithmConstraints(AlgorithmConstraints contentEncryptionAlgorithmConstraints)
void	setContentEncryptionKey(byte[] contentEncryptionKey)
void	setEncodedContentEncryptionKey(String encodedContentEncryptionKey)
void	setEncodedIv(String encodedIv)
void	setEncryptionMethodHeaderParameter(String enc)
void	setIv(byte[] iv)
void	setPayload(String payload)
void	setPlaintext(byte[] plaintext)
void	setPlaintext(String plaintext)
void	setPlainTextCharEncoding(String plaintextCharEncoding)

Methods inherited from class org.jose4j.jwx.JsonWebStructure

checkCrit, checkNotEmptyPart, fromCompactSerialization, getAlgorithmConstraints, getAlgorithmHeaderValue, getCertificateChainHeaderValue, getContentTypeHeaderValue, getEncodedHeader, getHeader, getHeader, getHeaders, getIntegrity, getJwkHeader, getKey, getKeyIdHeaderValue, getLeafCertificateHeaderValue, getObjectHeader, getProviderCtx, getX509CertSha1ThumbprintHeaderValue, getX509CertSha256ThumbprintHeaderValue, isDoKeyValidation, isSupportedCriticalHeader, onNewKey, setAlgorithmConstraints, setAlgorithmHeaderValue, setCertificateChainHeaderValue, setCompactSerialization, setContentTypeHeaderValue, setCriticalHeaderNames, setDoKeyValidation, setEncodedHeader, setHeader, setHeader, setIntegrity, setJwkHeader, setKey, setKeyIdHeaderValue, setKnownCriticalHeaders, setProviderContext, setX509CertSha1ThumbprintHeaderValue, setX509CertSha1ThumbprintHeaderValue, setX509CertSha256ThumbprintHeaderValue, setX509CertSha256ThumbprintHeaderValue, toString

Methods inherited from class java.lang.Object

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

Field Details

COMPACT_SERIALIZATION_PARTS

public static final short COMPACT_SERIALIZATION_PARTS

See Also:

• Constant Field Values

Constructor Details

JsonWebEncryption

public JsonWebEncryption()

Method Details

setPlainTextCharEncoding

public void setPlainTextCharEncoding(String plaintextCharEncoding)

setPlaintext

public void setPlaintext(byte[] plaintext)

setPlaintext

public void setPlaintext(String plaintext)

getPlaintextString

public String getPlaintextString()
                          throws JoseException

Throws:

JoseException

getPlaintextBytes

public byte[] getPlaintextBytes()
                         throws JoseException

Throws:

JoseException

getPayload

public String getPayload()
                  throws JoseException

Specified by:

getPayload in class JsonWebStructure

Throws:

JoseException

setPayload

public void setPayload(String payload)

Specified by:

setPayload in class JsonWebStructure

setEncryptionMethodHeaderParameter

public void setEncryptionMethodHeaderParameter(String enc)

getEncryptionMethodHeaderParameter

public String getEncryptionMethodHeaderParameter()

setCompressionAlgorithmHeaderParameter

public void setCompressionAlgorithmHeaderParameter(String zip)

getCompressionAlgorithmHeaderParameter

public String getCompressionAlgorithmHeaderParameter()

enableDefaultCompression

public void enableDefaultCompression()

setContentEncryptionAlgorithmConstraints

public void setContentEncryptionAlgorithmConstraints(AlgorithmConstraints contentEncryptionAlgorithmConstraints)

getContentEncryptionAlgorithm

public ContentEncryptionAlgorithm getContentEncryptionAlgorithm()
                                                         throws InvalidAlgorithmException

Throws:

InvalidAlgorithmException

getKeyManagementModeAlgorithm

public KeyManagementAlgorithm getKeyManagementModeAlgorithm()
                                                     throws InvalidAlgorithmException

Throws:

InvalidAlgorithmException

getAlgorithmNoConstraintCheck

public KeyManagementAlgorithm getAlgorithmNoConstraintCheck()
                                                     throws InvalidAlgorithmException

Specified by:

getAlgorithmNoConstraintCheck in class JsonWebStructure

Throws:

InvalidAlgorithmException

getAlgorithm

public KeyManagementAlgorithm getAlgorithm()
                                    throws InvalidAlgorithmException

Specified by:

getAlgorithm in class JsonWebStructure

Throws:

InvalidAlgorithmException

setCompactSerializationParts

protected void setCompactSerializationParts(String[] parts)
                                     throws JoseException

Specified by:

setCompactSerializationParts in class JsonWebStructure

Throws:

JoseException

prepareDecryptingPrimitive

public CryptoPrimitive prepareDecryptingPrimitive()
                                           throws JoseException

Create, initialize and return the CryptoPrimitive that this JWE instance will use for agreement or decryption of the content encryption key. This can optionally be called after setting the key (and maybe ProviderContext) but before getting the payload (which is when the decryption magic happens). This method provides access to the underlying primitive instance (e.g. a Cipher), which allows execution of the operation to be gated by some approval or authorization. For example, signing on Android with a key that was set to require user authentication when created needs a biometric prompt to allow the signature to execute with the key.

Returns:

a CryptoPrimitive containing either a Cipher, KeyAgreement, etc., or null

Throws:

JoseException - if an error condition is encountered during the initialization process

getEncryptedKey

public byte[] getEncryptedKey()

getCompactSerialization

public String getCompactSerialization()
                               throws JoseException

Specified by:

getCompactSerialization in class JsonWebStructure

Throws:

JoseException

getContentEncryptionKey

public byte[] getContentEncryptionKey()

setContentEncryptionKey

public void setContentEncryptionKey(byte[] contentEncryptionKey)

setEncodedContentEncryptionKey

public void setEncodedContentEncryptionKey(String encodedContentEncryptionKey)

getIv

public byte[] getIv()

setIv

public void setIv(byte[] iv)

setEncodedIv

public void setEncodedIv(String encodedIv)