EncryptedData¶

class oci.key_management.models.EncryptedData(**kwargs)¶

Bases: object

The response to a request to encrypt the plaintext data.

Attributes

`ENCRYPTION_ALGORITHM_AES_256_GCM`	A constant which can be used with the encryption_algorithm property of a EncryptedData.
`ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_1`	A constant which can be used with the encryption_algorithm property of a EncryptedData.
`ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_256`	A constant which can be used with the encryption_algorithm property of a EncryptedData.
`ciphertext`	[Required] Gets the ciphertext of this EncryptedData.
`encryption_algorithm`	Gets the encryption_algorithm of this EncryptedData.
`key_id`	Gets the key_id of this EncryptedData.
`key_version_id`	Gets the key_version_id of this EncryptedData.

Methods

__init__(**kwargs) Initializes a new EncryptedData object with values from keyword arguments.

ENCRYPTION_ALGORITHM_AES_256_GCM = 'AES_256_GCM'¶: A constant which can be used with the encryption_algorithm property of a EncryptedData. This constant has a value of “AES_256_GCM”

ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_1 = 'RSA_OAEP_SHA_1'¶: A constant which can be used with the encryption_algorithm property of a EncryptedData. This constant has a value of “RSA_OAEP_SHA_1”

ENCRYPTION_ALGORITHM_RSA_OAEP_SHA_256 = 'RSA_OAEP_SHA_256'¶: A constant which can be used with the encryption_algorithm property of a EncryptedData. This constant has a value of “RSA_OAEP_SHA_256”

__init__(**kwargs)¶

Initializes a new EncryptedData object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

ciphertext (str) – The value to assign to the ciphertext property of this EncryptedData.
key_id (str) – The value to assign to the key_id property of this EncryptedData.
key_version_id (str) – The value to assign to the key_version_id property of this EncryptedData.
encryption_algorithm (str) – The value to assign to the encryption_algorithm property of this EncryptedData. Allowed values for this property are: “AES_256_GCM”, “RSA_OAEP_SHA_1”, “RSA_OAEP_SHA_256”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

ciphertext¶

[Required] Gets the ciphertext of this EncryptedData. The encrypted data.

Returns:	The ciphertext of this EncryptedData.
Return type:	str

encryption_algorithm¶

Gets the encryption_algorithm of this EncryptedData. The encryption algorithm to use to encrypt and decrypt data with a customer-managed key. AES_256_GCM indicates that the key is a symmetric key that uses the Advanced Encryption Standard (AES) algorithm and that the mode of encryption is the Galois/Counter Mode (GCM). RSA_OAEP_SHA_1 indicates that the key is an asymmetric key that uses the RSA encryption algorithm and uses Optimal Asymmetric Encryption Padding (OAEP). RSA_OAEP_SHA_256 indicates that the key is an asymmetric key that uses the RSA encryption algorithm with a SHA-256 hash and uses OAEP.

Allowed values for this property are: “AES_256_GCM”, “RSA_OAEP_SHA_1”, “RSA_OAEP_SHA_256”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The encryption_algorithm of this EncryptedData.
Return type:	str

key_id¶

Gets the key_id of this EncryptedData. The OCID of the key used to encrypt the ciphertext.

Returns:	The key_id of this EncryptedData.
Return type:	str

key_version_id¶

Gets the key_version_id of this EncryptedData. The OCID of the key version used to encrypt the ciphertext.

Returns:	The key_version_id of this EncryptedData.
Return type:	str