EncryptDataDetails¶

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

Bases: object

The details of the plaintext data that you want to encrypt.

Attributes:

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

Methods:

__init__(**kwargs)

Initializes a new EncryptDataDetails 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 EncryptDataDetails. 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 EncryptDataDetails. 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 EncryptDataDetails. This constant has a value of “RSA_OAEP_SHA_256”

__init__(**kwargs)¶

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

Parameters

associated_data (dict(str, str)) – The value to assign to the associated_data property of this EncryptDataDetails.
key_id (str) – The value to assign to the key_id property of this EncryptDataDetails.
logging_context (dict(str, str)) – The value to assign to the logging_context property of this EncryptDataDetails.
plaintext (str) – The value to assign to the plaintext property of this EncryptDataDetails.
key_version_id (str) – The value to assign to the key_version_id property of this EncryptDataDetails.
encryption_algorithm (str) – The value to assign to the encryption_algorithm property of this EncryptDataDetails. Allowed values for this property are: “AES_256_GCM”, “RSA_OAEP_SHA_1”, “RSA_OAEP_SHA_256”

property associated_data¶

Gets the associated_data of this EncryptDataDetails. Information that can be used to provide an encryption context for the encrypted data. The length of the string representation of the associated data must be fewer than 4096 characters.

Returns: The associated_data of this EncryptDataDetails.
Return type: dict(str, str)

property encryption_algorithm¶

Gets the encryption_algorithm of this EncryptDataDetails. 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”

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

property key_id¶

[Required] Gets the key_id of this EncryptDataDetails. The OCID of the key to encrypt with.

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

property key_version_id¶

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

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

property logging_context¶

Gets the logging_context of this EncryptDataDetails. Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in the audit logs when audit logging is enabled.

Returns: The logging_context of this EncryptDataDetails.
Return type: dict(str, str)

property plaintext¶

[Required] Gets the plaintext of this EncryptDataDetails. The plaintext data to encrypt.

Returns: The plaintext of this EncryptDataDetails.
Return type: str