oracle.oci.oci_key_management_verified_data – Manage a VerifiedData 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_verified_data.

New in version 2.9.0: of oracle.oci

Synopsis

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

  • For state=present, verifies a digital signature that was generated by the Sign operation by using the public key of the same asymmetric key that was used to sign the data. If you want to validate the digital signature outside of the service, you can do so by using the public key of the asymmetric key.

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).
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.
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.
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 sign the message.
key_version_id
string / required
The OCID of the key version used to sign the message.
message_type
string
    Choices:
  • RAW
  • DIGEST
Denotes whether the value of the message parameter is a raw message or a message digest. The default value, `RAW`, indicates a message. To indicate a message digest, use `DIGEST`.
msg
string / required
The base64-encoded binary data object denoting the message or message digest to sign. You can have a message up to 4096 bytes in size. To sign a larger message, provide the message digest.

aliases: message
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}'.
signature
string / required
The base64-encoded binary data object denoting the cryptographic signature generated for the message.
signing_algorithm
string / required
    Choices:
  • SHA_224_RSA_PKCS_PSS
  • SHA_256_RSA_PKCS_PSS
  • SHA_384_RSA_PKCS_PSS
  • SHA_512_RSA_PKCS_PSS
  • SHA_224_RSA_PKCS1_V1_5
  • SHA_256_RSA_PKCS1_V1_5
  • SHA_384_RSA_PKCS1_V1_5
  • SHA_512_RSA_PKCS1_V1_5
  • ECDSA_SHA_256
  • ECDSA_SHA_384
  • ECDSA_SHA_512
The algorithm to use to sign the message or message digest. For RSA keys, supported signature schemes include PKCS #1 and RSASSA-PSS, along with different hashing algorithms. For ECDSA keys, ECDSA is the supported signature scheme with different hashing algorithms. When you pass a message digest for signing, ensure that you specify the same hashing algorithm as used when creating the message digest.
state
string
    Choices:
  • present ←
The state of the VerifiedData.
Use state=present to create a VerifiedData.
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 verified_data
  oci_key_management_verified_data:
    # required
    key_id: "ocid1.key.oc1..xxxxxxEXAMPLExxxxxx"
    key_version_id: "ocid1.keyversion.oc1..xxxxxxEXAMPLExxxxxx"
    signature: signature_example
    msg: msg_example
    signing_algorithm: SHA_224_RSA_PKCS_PSS

    # optional
    message_type: RAW
    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
verified_data
complex
on success
Details of the VerifiedData resource acted upon by the current operation

Sample:
{'is_signature_valid': True}
 
is_signature_valid
boolean
on success
A Boolean value that indicates whether the signature was verified.

Sample:
True


Authors

  • Oracle (@oracle)