com.fortanix.sdkms.v1.model

Class WrapKeyRequest

java.lang.Object

com.fortanix.sdkms.v1.model.WrapKeyRequest

public class WrapKeyRequest
extends Object

WrapKeyRequest

Constructor Summary

Constructors

Constructor and Description
WrapKeyRequest()

Method Summary

Modifier and Type	Method and Description
WrapKeyRequest	ad(byte[] ad)
WrapKeyRequest	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.
KeyFormat	getKeyFormat() Get keyFormat
String	getKid() The key ID (not name or description) of the key being wrapped.
CryptMode	getMode() Get mode
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()
WrapKeyRequest	iv(byte[] iv)
WrapKeyRequest	keyFormat(KeyFormat keyFormat)
WrapKeyRequest	kid(String kid)
WrapKeyRequest	mode(CryptMode mode)
void	setAd(byte[] ad)
void	setAlg(ObjectType alg)
void	setIv(byte[] iv)
void	setKeyFormat(KeyFormat keyFormat)
void	setKid(String kid)
void	setMode(CryptMode mode)
void	setTagLen(Integer tagLen)
WrapKeyRequest	tagLen(Integer tagLen)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WrapKeyRequest

public WrapKeyRequest()

Method Detail

alg

public WrapKeyRequest alg(ObjectType alg)

getAlg

public ObjectType getAlg()

Get alg

Returns:

alg

setAlg

public void setAlg(ObjectType alg)

kid

public WrapKeyRequest kid(String kid)

getKid

public String getKid()

The key ID (not name or description) of the key being wrapped.

Returns:

kid

setKid

public void setKid(String kid)

mode

public WrapKeyRequest mode(CryptMode mode)

getMode

public CryptMode getMode()

Get mode

Returns:

mode

setMode

public void setMode(CryptMode mode)

keyFormat

public WrapKeyRequest keyFormat(KeyFormat keyFormat)

getKeyFormat

public KeyFormat getKeyFormat()

Get keyFormat

Returns:

keyFormat

setKeyFormat

public void setKeyFormat(KeyFormat keyFormat)

iv

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