com.fortanix.sdkms.v1.model

Class EncryptRequestEx

java.lang.Object

com.fortanix.sdkms.v1.model.EncryptRequestEx

public class EncryptRequestEx
extends Object

A request to encrypt data using a symmetric or asymmetric key.

Constructor Summary

Constructors

Constructor and Description
EncryptRequestEx()

Method Summary

Modifier and Type	Method and Description
EncryptRequestEx	ad(byte[] ad)
EncryptRequestEx	alg(ObjectType alg)
boolean	equals(Object o)
byte[]	getAd() For symmetric ciphers with cipher mode GCM or CCM, this optionally specifies the authenticated data used by the cipher.
ObjectType	getAlg() Get alg
byte[]	getIv() For symmetric ciphers, this value will be used for the cipher initialization value.
SobjectDescriptor	getKey() Get key
CryptMode	getMode() Get mode
byte[]	getPlain() The plaintext to encrypt.
Integer	getTagLen() For symmetric ciphers with cipher mode GCM or CCM, this field specifies the length of the authentication tag to be produced.
int	hashCode()
EncryptRequestEx	iv(byte[] iv)
EncryptRequestEx	key(SobjectDescriptor key)
EncryptRequestEx	mode(CryptMode mode)
EncryptRequestEx	plain(byte[] plain)
void	setAd(byte[] ad)
void	setAlg(ObjectType alg)
void	setIv(byte[] iv)
void	setKey(SobjectDescriptor key)
void	setMode(CryptMode mode)
void	setPlain(byte[] plain)
void	setTagLen(Integer tagLen)
EncryptRequestEx	tagLen(Integer tagLen)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptRequestEx

public EncryptRequestEx()

Method Detail

key

public EncryptRequestEx key(SobjectDescriptor key)

getKey

public SobjectDescriptor getKey()

Get key

Returns:

key

setKey

public void setKey(SobjectDescriptor key)

alg

public EncryptRequestEx alg(ObjectType alg)

getAlg

public ObjectType getAlg()

Get alg

Returns:

alg

setAlg

public void setAlg(ObjectType alg)

plain

public EncryptRequestEx plain(byte[] plain)

getPlain

public byte[] getPlain()

The plaintext to encrypt.

Returns:

plain

setPlain

public void setPlain(byte[] plain)

mode

public EncryptRequestEx mode(CryptMode mode)

getMode

public CryptMode getMode()

Get mode

Returns:

mode

setMode

public void setMode(CryptMode mode)

iv

public EncryptRequestEx iv(byte[] iv)

getIv

public byte[] getIv()

For symmetric ciphers, this value will be used for the cipher initialization value. If not provided, DSM will generate a random iv and return it in the response. If provided, iv length must match the length required by the cipher and mode.

Returns:

iv

setIv

public void setIv(byte[] iv)

ad

public EncryptRequestEx ad(byte[] ad)

getAd

public byte[] getAd()

For symmetric ciphers with cipher mode GCM or CCM, this optionally specifies the authenticated data used by the cipher. This field must not be provided with other cipher modes.

Returns:

ad

setAd

public void setAd(byte[] ad)

tagLen

public EncryptRequestEx tagLen(Integer tagLen)

getTagLen

public Integer getTagLen()

For symmetric ciphers with cipher mode GCM or CCM, this field specifies the length of the authentication tag to be produced. This field is specified in bits (not bytes). This field is required for symmetric ciphers with cipher mode GCM or CCM. It must not be specified for asymmetric ciphers and symmetric ciphers with other cipher modes.

Returns:

tagLen

setTagLen

public void setTagLen(Integer tagLen)

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