com.fortanix.sdkms.v1.model

Class DecryptRequest

java.lang.Object

com.fortanix.sdkms.v1.model.DecryptRequest

public class DecryptRequest
extends Object

Mode and iv are required fields for symmetric key algorithms and ad and tag are required fields for GCM or CCM modes.

Constructor Summary

Constructors

Constructor and Description
DecryptRequest()

Method Summary

Modifier and Type	Method and Description
DecryptRequest	ad(byte[] ad)
DecryptRequest	alg(ObjectType alg)
DecryptRequest	cipher(byte[] cipher)
boolean	equals(Object o)
byte[]	getAd() The authenticated data used with this ciphertext and authentication tag.
ObjectType	getAlg() Get alg
byte[]	getCipher() The ciphertext to decrypt.
byte[]	getIv() The initialization value used to encrypt this ciphertext.
Boolean	getMasked() This flag is only useful with DECRYPT permission.
CryptMode	getMode() Get mode
byte[]	getTag() The authentication tag used with this ciphertext and authenticated data.
int	hashCode()
DecryptRequest	iv(byte[] iv)
DecryptRequest	masked(Boolean masked)
DecryptRequest	mode(CryptMode mode)
void	setAd(byte[] ad)
void	setAlg(ObjectType alg)
void	setCipher(byte[] cipher)
void	setIv(byte[] iv)
void	setMasked(Boolean masked)
void	setMode(CryptMode mode)
void	setTag(byte[] tag)
DecryptRequest	tag(byte[] tag)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DecryptRequest

public DecryptRequest()

Method Detail

alg

public DecryptRequest alg(ObjectType alg)

getAlg

public ObjectType getAlg()

Get alg

Returns:

alg

setAlg

public void setAlg(ObjectType alg)

cipher

public DecryptRequest cipher(byte[] cipher)

getCipher

public byte[] getCipher()

The ciphertext to decrypt.

Returns:

cipher

setCipher

public void setCipher(byte[] cipher)

mode

public DecryptRequest mode(CryptMode mode)

getMode

public CryptMode getMode()

Get mode

Returns:

mode

setMode

public void setMode(CryptMode mode)

iv

public DecryptRequest iv(byte[] iv)

getIv

public byte[] getIv()

The initialization value used to encrypt this ciphertext. This field is required for symmetric ciphers, and ignored for asymmetric ciphers.

Returns:

iv

setIv

public void setIv(byte[] iv)

ad

public DecryptRequest ad(byte[] ad)

getAd

public byte[] getAd()

The authenticated data used with this ciphertext and authentication tag. This field is required for symmetric ciphers using cipher mode GCM or CCM, and must not be specified for all other ciphers.

Returns:

ad

setAd

public void setAd(byte[] ad)

tag

public DecryptRequest tag(byte[] tag)

getTag

public byte[] getTag()

The authentication tag used with this ciphertext and authenticated data. This field is required for symmetric ciphers using cipher mode GCM or CCM, and must not be specified for all other ciphers.

Returns:

tag

setTag

public void setTag(byte[] tag)

masked

public DecryptRequest masked(Boolean masked)

getMasked

public Boolean getMasked()

This flag is only useful with DECRYPT permission. When this flag is true, decryption returns masked output. Setting it to false is equivalent to not using this flag. With MASKDECRYPT permission, this flag is ignored.

Returns:

masked

setMasked

public void setMasked(Boolean masked)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object