com.fortanix.sdkms.v1.model

Class EncryptInitRequest

java.lang.Object

com.fortanix.sdkms.v1.model.EncryptInitRequest

public class EncryptInitRequest
extends Object

alg is required. mode is required for symmetric algorithms.

Constructor Summary

Constructors

Constructor and Description
EncryptInitRequest()

Method Summary

Modifier and Type	Method and Description
EncryptInitRequest	ad(byte[] ad)
EncryptInitRequest	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.
CipherMode	getMode() Get mode
int	hashCode()
EncryptInitRequest	iv(byte[] iv)
EncryptInitRequest	mode(CipherMode mode)
void	setAd(byte[] ad)
void	setAlg(ObjectType alg)
void	setIv(byte[] iv)
void	setMode(CipherMode mode)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

EncryptInitRequest

public EncryptInitRequest()

Method Detail

alg

public EncryptInitRequest alg(ObjectType alg)

getAlg

public ObjectType getAlg()

Get alg

Returns:

alg

setAlg

public void setAlg(ObjectType alg)

mode

public EncryptInitRequest mode(CipherMode mode)

getMode

public CipherMode getMode()

Get mode

Returns:

mode

setMode

public void setMode(CipherMode mode)

iv

public EncryptInitRequest 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 EncryptInitRequest 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)

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