com.fortanix.sdkms.v1.model

Class WrapKeyRequestEx

java.lang.Object

com.fortanix.sdkms.v1.model.WrapKeyRequestEx

public class WrapKeyRequestEx
extends Object

WrapKeyRequestEx

Constructor Summary

Constructors

Constructor and Description
WrapKeyRequestEx()

Method Summary

Modifier and Type	Method and Description
WrapKeyRequestEx	ad(byte[] ad)
WrapKeyRequestEx	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
KeyFormat	getKeyFormat() Get keyFormat
CryptMode	getMode() Get mode
SobjectDescriptor	getSubject() Get subject
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()
WrapKeyRequestEx	iv(byte[] iv)
WrapKeyRequestEx	key(SobjectDescriptor key)
WrapKeyRequestEx	keyFormat(KeyFormat keyFormat)
WrapKeyRequestEx	mode(CryptMode mode)
void	setAd(byte[] ad)
void	setAlg(ObjectType alg)
void	setIv(byte[] iv)
void	setKey(SobjectDescriptor key)
void	setKeyFormat(KeyFormat keyFormat)
void	setMode(CryptMode mode)
void	setSubject(SobjectDescriptor subject)
void	setTagLen(Integer tagLen)
WrapKeyRequestEx	subject(SobjectDescriptor subject)
WrapKeyRequestEx	tagLen(Integer tagLen)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WrapKeyRequestEx

public WrapKeyRequestEx()

Method Detail

key

public WrapKeyRequestEx key(SobjectDescriptor key)

getKey

public SobjectDescriptor getKey()

Get key

Returns:

key

setKey

public void setKey(SobjectDescriptor key)

subject

public WrapKeyRequestEx subject(SobjectDescriptor subject)

getSubject

public SobjectDescriptor getSubject()

Get subject

Returns:

subject

setSubject

public void setSubject(SobjectDescriptor subject)

alg

public WrapKeyRequestEx alg(ObjectType alg)

getAlg

public ObjectType getAlg()

Get alg

Returns:

alg

setAlg

public void setAlg(ObjectType alg)

mode

public WrapKeyRequestEx mode(CryptMode mode)

getMode

public CryptMode getMode()

Get mode

Returns:

mode

setMode

public void setMode(CryptMode mode)

keyFormat

public WrapKeyRequestEx keyFormat(KeyFormat keyFormat)

getKeyFormat

public KeyFormat getKeyFormat()

Get keyFormat

Returns:

keyFormat

setKeyFormat

public void setKeyFormat(KeyFormat keyFormat)

iv

public WrapKeyRequestEx 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 WrapKeyRequestEx 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 WrapKeyRequestEx 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