com.fortanix.sdkms.v1.model

Class WrapKeyParams

java.lang.Object

com.fortanix.sdkms.v1.model.WrapKeyParams

public class WrapKeyParams
extends Object

Security Object wrapping parameters

Constructor Summary

Constructors

Constructor and Description
WrapKeyParams()

Method Summary

Modifier and Type	Method and Description
WrapKeyParams	ad(byte[] ad)
WrapKeyParams	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
CipherMode	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()
WrapKeyParams	iv(byte[] iv)
WrapKeyParams	key(SobjectDescriptor key)
WrapKeyParams	mode(CipherMode mode)
void	setAd(byte[] ad)
void	setAlg(ObjectType alg)
void	setIv(byte[] iv)
void	setKey(SobjectDescriptor key)
void	setMode(CipherMode mode)
void	setTagLen(Integer tagLen)
WrapKeyParams	tagLen(Integer tagLen)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WrapKeyParams

public WrapKeyParams()

Method Detail

key

public WrapKeyParams key(SobjectDescriptor key)

getKey

public SobjectDescriptor getKey()

Get key

Returns:

key

setKey

public void setKey(SobjectDescriptor key)

alg

public WrapKeyParams alg(ObjectType alg)

getAlg

public ObjectType getAlg()

Get alg

Returns:

alg

setAlg

public void setAlg(ObjectType alg)

mode

public WrapKeyParams mode(CipherMode mode)

getMode

public CipherMode getMode()

Get mode

Returns:

mode

setMode

public void setMode(CipherMode mode)

iv

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