oracle.oci.oci_key_management_decrypted_data – Manage a DecryptedData resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_key_management_decrypted_data.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create a DecryptedData resource in Oracle Cloud Infrastructure

  • For state=present, decrypts data using the given DecryptDataDetails resource.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
associated_data
dictionary
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.
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
ciphertext
string / required
The encrypted data to decrypt.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
encryption_algorithm
string
    Choices:
  • AES_256_GCM
  • RSA_OAEP_SHA_1
  • RSA_OAEP_SHA_256
The encryption algorithm to use to encrypt or 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.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
key_id
string / required
The OCID of the key used to encrypt the ciphertext.
key_version_id
string
The OCID of the key version used to encrypt the ciphertext.
logging_context
dictionary
Information that provides context for audit logging. You can provide this additional data as key-value pairs to include in audit logs when audit logging is enabled.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
service_endpoint
string / required
The endpoint of the service to call using this client. For example 'https://kms.{region}.{secondLevelDomain}'.
state
string
    Choices:
  • present ←
The state of the DecryptedData.
Use state=present to create a DecryptedData.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Examples

- name: Create decrypted_data
  oci_key_management_decrypted_data:
    # required
    ciphertext: ciphertext_example
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    associated_data: null
    logging_context: null
    key_version_id: "ocid1.keyversion.oc1..xxxxxxEXAMPLExxxxxx"
    encryption_algorithm: AES_256_GCM
    service_endpoint: "https://xxx.kms.{region}.oraclecloud.com"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
decrypted_data
complex
on success
Details of the DecryptedData resource acted upon by the current operation

Sample:
{'encryption_algorithm': 'AES_256_GCM', 'key_id': 'ocid1.key.oc1..xxxxxxEXAMPLExxxxxx', 'key_version_id': 'ocid1.keyversion.oc1..xxxxxxEXAMPLExxxxxx', 'plaintext': 'plaintext_example', 'plaintext_checksum': 'plaintext_checksum_example'}
 
encryption_algorithm
string
on success
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.

Sample:
AES_256_GCM
 
key_id
string
on success
The OCID of the key used to encrypt the ciphertext.

Sample:
ocid1.key.oc1..xxxxxxEXAMPLExxxxxx
 
key_version_id
string
on success
The OCID of the key version used to encrypt the ciphertext.

Sample:
ocid1.keyversion.oc1..xxxxxxEXAMPLExxxxxx
 
plaintext
string
on success
The decrypted data, expressed as a base64-encoded value.

Sample:
plaintext_example
 
plaintext_checksum
string
on success
The checksum of the decrypted data.

Sample:
plaintext_checksum_example


Authors

  • Oracle (@oracle)