com.cosmian.rest.kmip.operations

Class Encrypt

java.lang.Object

com.cosmian.rest.kmip.operations.Encrypt

All Implemented Interfaces:

KmipStruct

public class Encrypt
extends Object
implements KmipStruct

This operation requests the server to perform an encryption operation on the provided data using a Managed Cryptographic Object as the key for the encryption operation. The request contains information about the cryptographic parameters (mode and padding method), the data to be encrypted, and the IV/Counter/Nonce to use. The cryptographic parameters MAY be omitted from the request as they can be specified as associated attributes of the Managed Cryptographic Object. The IV/Counter/Nonce MAY also be omitted from the request if the cryptographic parameters indicate that the server shall generate a Random IV on behalf of the client or the encryption algorithm does not need an IV/Counter/Nonce. The server does not store or otherwise manage the IV/Counter/Nonce. If the Managed Cryptographic Object referenced has a Usage Limits attribute then the server SHALL obtain an allocation from the current Usage Limits value prior to performing the encryption operation. If the allocation is unable to be obtained the operation SHALL return with a result status of Operation Failed and result reason of Permission Denied. The response contains the Unique Identifier of the Managed Cryptographic Object used as the key and the result of the encryption operation. The success or failure of the operation is indicated by the Result Status (and if failure the Result Reason) in the response header

Constructor Summary

Constructors

Constructor and Description
Encrypt()
Encrypt(Optional<String> unique_identifier, Optional<CryptographicParameters> cryptographic_parameters, Optional<byte[]> data, Optional<byte[]> iv_counter_nonce, Optional<byte[]> correlation_value, Optional<Boolean> init_indicator, Optional<Boolean> final_indicator, Optional<byte[]> authenticated_encryption_additional_data)
Encrypt(String unique_identifier, byte[] data, Optional<byte[]> iv_counter_nonce, Optional<byte[]> authenticated_encryption_additional_data)

Method Summary

Modifier and Type	Method and Description
Encrypt	authenticated_encryption_additional_data(Optional<byte[]> authenticated_encryption_additional_data)
Encrypt	correlation_value(Optional<byte[]> correlation_value)
Encrypt	cryptographic_parameters(Optional<CryptographicParameters> cryptographic_parameters)
Encrypt	data(Optional<byte[]> data)
boolean	equals(Object o)
Encrypt	final_indicator(Optional<Boolean> final_indicator)
Optional<byte[]>	getAuthenticated_encryption_additional_data()
Optional<byte[]>	getCorrelation_value()
Optional<CryptographicParameters>	getCryptographic_parameters()
Optional<byte[]>	getData()
Optional<Boolean>	getFinal_indicator()
Optional<Boolean>	getInit_indicator()
Optional<byte[]>	getIv_counter_nonce()
Optional<String>	getUnique_identifier()
int	hashCode()
Encrypt	init_indicator(Optional<Boolean> init_indicator)
Encrypt	iv_counter_nonce(Optional<byte[]> iv_counter_nonce)
void	setAuthenticated_encryption_additional_data(Optional<byte[]> authenticated_encryption_additional_data)
void	setCorrelation_value(Optional<byte[]> correlation_value)
void	setCryptographic_parameters(Optional<CryptographicParameters> cryptographic_parameters)
void	setData(Optional<byte[]> data)
void	setFinal_indicator(Optional<Boolean> final_indicator)
void	setInit_indicator(Optional<Boolean> init_indicator)
void	setIv_counter_nonce(Optional<byte[]> iv_counter_nonce)
void	setUnique_identifier(Optional<String> unique_identifier)
String	toString()
Encrypt	unique_identifier(Optional<String> unique_identifier)

Methods inherited from class java.lang.Object

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

Constructor Detail

Encrypt

public Encrypt()

Encrypt

public Encrypt(Optional<String> unique_identifier,
               Optional<CryptographicParameters> cryptographic_parameters,
               Optional<byte[]> data,
               Optional<byte[]> iv_counter_nonce,
               Optional<byte[]> correlation_value,
               Optional<Boolean> init_indicator,
               Optional<Boolean> final_indicator,
               Optional<byte[]> authenticated_encryption_additional_data)

Encrypt

public Encrypt(String unique_identifier,
               byte[] data,
               Optional<byte[]> iv_counter_nonce,
               Optional<byte[]> authenticated_encryption_additional_data)

Method Detail

getUnique_identifier

public Optional<String> getUnique_identifier()

setUnique_identifier

public void setUnique_identifier(Optional<String> unique_identifier)

getCryptographic_parameters

public Optional<CryptographicParameters> getCryptographic_parameters()

setCryptographic_parameters

public void setCryptographic_parameters(Optional<CryptographicParameters> cryptographic_parameters)

getData

public Optional<byte[]> getData()

setData

public void setData(Optional<byte[]> data)

getIv_counter_nonce

public Optional<byte[]> getIv_counter_nonce()

setIv_counter_nonce

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

getCorrelation_value

public Optional<byte[]> getCorrelation_value()

setCorrelation_value

public void setCorrelation_value(Optional<byte[]> correlation_value)

getInit_indicator

public Optional<Boolean> getInit_indicator()

setInit_indicator

public void setInit_indicator(Optional<Boolean> init_indicator)

getFinal_indicator

public Optional<Boolean> getFinal_indicator()

setFinal_indicator

public void setFinal_indicator(Optional<Boolean> final_indicator)

getAuthenticated_encryption_additional_data

public Optional<byte[]> getAuthenticated_encryption_additional_data()

setAuthenticated_encryption_additional_data

public void setAuthenticated_encryption_additional_data(Optional<byte[]> authenticated_encryption_additional_data)

unique_identifier

public Encrypt unique_identifier(Optional<String> unique_identifier)

cryptographic_parameters

public Encrypt cryptographic_parameters(Optional<CryptographicParameters> cryptographic_parameters)

data

public Encrypt data(Optional<byte[]> data)

iv_counter_nonce

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

correlation_value

public Encrypt correlation_value(Optional<byte[]> correlation_value)

init_indicator

public Encrypt init_indicator(Optional<Boolean> init_indicator)

final_indicator

public Encrypt final_indicator(Optional<Boolean> final_indicator)

authenticated_encryption_additional_data

public Encrypt authenticated_encryption_additional_data(Optional<byte[]> authenticated_encryption_additional_data)

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