com.cosmian.rest.kmip.data_structures

Class KeyWrappingData

java.lang.Object

com.cosmian.rest.kmip.data_structures.KeyWrappingData

All Implemented Interfaces:

KmipStruct

public class KeyWrappingData
extends Object
implements KmipStruct

The Key Block MAY also supply OPTIONAL information about a cryptographic key wrapping mechanism used to wrap the Key Value. This consists of a Key Wrapping Data structure. It is only used inside a Key Block. This structure contains fields for: Value Description Wrapping Method Indicates the method used to wrap the Key Value. Encryption Key Information Contains the Unique Identifier value of the encryption key and associated cryptographic parameters. MAC/Signature Key Information Contains the Unique Identifier value of the MAC/signature key and associated cryptographic parameters. MAC/Signature Contains a MAC or signature of the Key Value IV/Counter/Nonce If REQUIRED by the wrapping method. Encoding Option Specifies the encoding of the Key Material within the Key Value structure of the Key Block that has been wrapped. If No Encoding is specified, then the Key Value structure SHALL NOT contain any attributes. If wrapping is used, then the whole Key Value structure is wrapped unless otherwise specified by the Wrapping Method. The algorithms used for wrapping are given by the Cryptographic Algorithm attributes of the encryption key and/or MAC/signature key; the block-cipher mode, padding method, and hashing algorithm used for wrapping are given by the Cryptographic Parameters in the Encryption Key Information and/or MAC/Signature Key Information, or, if not present, from the Cryptographic Parameters attribute of the respective key(s). Either the Encryption Key Information or the MAC/Signature Key Information (or both) in the Key Wrapping Data structure SHALL be specified.

Constructor Summary

Constructors

Constructor and Description
KeyWrappingData()
KeyWrappingData(WrappingMethod wrapping_method, Optional<EncryptionKeyInformation> encryption_key_information, Optional<MacSignatureKeyInformation> mac_or_signature_key_information, Optional<byte[]> mac_or_signature, Optional<byte[]> iv_counter_nonce, Optional<EncodingOption> encoding_option)

Method Summary

Modifier and Type	Method and Description
KeyWrappingData	encoding_option(Optional<EncodingOption> encoding_option)
KeyWrappingData	encryption_key_information(Optional<EncryptionKeyInformation> encryption_key_information)
boolean	equals(Object o)
Optional<EncodingOption>	getEncoding_option()
Optional<EncryptionKeyInformation>	getEncryption_key_information()
Optional<byte[]>	getIv_counter_nonce()
Optional<MacSignatureKeyInformation>	getMac_or_signature_key_information()
Optional<byte[]>	getMac_or_signature()
WrappingMethod	getWrapping_method()
int	hashCode()
KeyWrappingData	iv_counter_nonce(Optional<byte[]> iv_counter_nonce)
KeyWrappingData	mac_or_signature_key_information(Optional<MacSignatureKeyInformation> mac_or_signature_key_information)
KeyWrappingData	mac_or_signature(Optional<byte[]> mac_or_signature)
void	setEncoding_option(Optional<EncodingOption> encoding_option)
void	setEncryption_key_information(Optional<EncryptionKeyInformation> encryption_key_information)
void	setIv_counter_nonce(Optional<byte[]> iv_counter_nonce)
void	setMac_or_signature_key_information(Optional<MacSignatureKeyInformation> mac_or_signature_key_information)
void	setMac_or_signature(Optional<byte[]> mac_or_signature)
void	setWrapping_method(WrappingMethod wrapping_method)
String	toString()
KeyWrappingData	wrapping_method(WrappingMethod wrapping_method)

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyWrappingData

public KeyWrappingData()

KeyWrappingData

public KeyWrappingData(WrappingMethod wrapping_method,
                       Optional<EncryptionKeyInformation> encryption_key_information,
                       Optional<MacSignatureKeyInformation> mac_or_signature_key_information,
                       Optional<byte[]> mac_or_signature,
                       Optional<byte[]> iv_counter_nonce,
                       Optional<EncodingOption> encoding_option)

Method Detail

getWrapping_method

public WrappingMethod getWrapping_method()

setWrapping_method

public void setWrapping_method(WrappingMethod wrapping_method)

getEncryption_key_information

public Optional<EncryptionKeyInformation> getEncryption_key_information()

setEncryption_key_information

public void setEncryption_key_information(Optional<EncryptionKeyInformation> encryption_key_information)

getMac_or_signature_key_information

public Optional<MacSignatureKeyInformation> getMac_or_signature_key_information()

setMac_or_signature_key_information

public void setMac_or_signature_key_information(Optional<MacSignatureKeyInformation> mac_or_signature_key_information)

getMac_or_signature

public Optional<byte[]> getMac_or_signature()

setMac_or_signature

public void setMac_or_signature(Optional<byte[]> mac_or_signature)

getIv_counter_nonce

public Optional<byte[]> getIv_counter_nonce()

setIv_counter_nonce

public void setIv_counter_nonce(Optional<byte[]> iv_counter_nonce)

getEncoding_option

public Optional<EncodingOption> getEncoding_option()

setEncoding_option

public void setEncoding_option(Optional<EncodingOption> encoding_option)

wrapping_method

public KeyWrappingData wrapping_method(WrappingMethod wrapping_method)

encryption_key_information

public KeyWrappingData encryption_key_information(Optional<EncryptionKeyInformation> encryption_key_information)

mac_or_signature_key_information

public KeyWrappingData mac_or_signature_key_information(Optional<MacSignatureKeyInformation> mac_or_signature_key_information)

mac_or_signature

public KeyWrappingData mac_or_signature(Optional<byte[]> mac_or_signature)

iv_counter_nonce

public KeyWrappingData iv_counter_nonce(Optional<byte[]> iv_counter_nonce)

encoding_option

public KeyWrappingData encoding_option(Optional<EncodingOption> encoding_option)

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