thalesgroup.ciphertrust.dpg_protection_policy_save module – Manage DPG protection policies governing crypto operations

Note

This module is part of the thalesgroup.ciphertrust collection (version 1.0.2).

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 thalesgroup.ciphertrust.

To use it in a playbook, specify: thalesgroup.ciphertrust.dpg_protection_policy_save.

New in thalesgroup.ciphertrust 1.0.0

Synopsis

Parameters

Parameter

Comments

access_policy_name

string

Name of access policy to be associated with the protection policy.

algorithm

string

Algorithm to be used during crypto operations

allow_single_char_input

boolean

If true, null or single-character inputs are passed untransformed. If false, row transformation fails

Obsolete post CM v2.12

Choices:

  • false

  • true

character_set_id

string

ID of the Character Set

disable_versioning

boolean

If set to true, versioning is not maintained for the protection policies. The default value is false.

Added in CM v2.12

Choices:

  • false

  • true

iv

string

IV to be used during crypto operations

key

string

Name of the key

localNode

dictionary / required

this holds the connection parameters required to communicate with an instance of CipherTrust Manager (CM)

holds IP/FQDN of the server, username, password, and port

auth_domain_path

string / required

user’s domain path

password

string / required

admin password of CM

server_ip

string / required

CM Server IP or FQDN

server_port

integer / required

Port on which CM server is listening

server_private_ip

string / required

internal or private IP of the CM Server, if different from the server_ip

user

string / required

admin username of CM

verify

boolean / required

if SSL verification is required

Choices:

  • false

  • true

masking_format_id

string

ID of the Static Masking Format

name

string

Unique name for the protection policy

op_type

string / required

Operation to be performed

Choices:

  • "create"

  • "patch"

policy_name

string

Identifier of the protection policy to be patched

tweak

string

Tweak data to be used during crypto operations

tweak_algorithm

string

Tweak algorithm to be used during crypto operations

Choices:

  • "SHA1"

  • "SHA256"

  • "None"

use_external_versioning

boolean

If set to true, external versioning is enabled for the protection policy

The version details are stored in a separate external parameter

The default value is false

Added in CM v2.12

Choices:

  • false

  • true

Examples

- name: "Create Protection Policy"
  thalesgroup.ciphertrust.dpg_protection_policy_save:
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
        auth_domain_path:
    op_type: create
    algorithm: "AES/CBC/PKCS5Padding"
    key: <CM_KEY_ID>
    name: DemoProtectionPolicy
    character_set_id: <CHAR_SET_ID>
    iv: 16
    tweak: 1628462495815733
    tweak_algorithm: SHA1

- name: "Patch Protection Policy"
  thalesgroup.ciphertrust.dpg_protection_policy_save:
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
        auth_domain_path:
    op_type: patch
    policy_name: DemoProtectionPolicy
    tweak: 1628462495815733
    tweak_algorithm: SHA256

- name: "Delete Protection Policy by name"
  thalesgroup.ciphertrust.cm_resource_delete:
    key: DemoProtectionPolicy
    resource_type: "protection-policies"
    localNode:
        server_ip: "IP/FQDN of CipherTrust Manager"
        server_private_ip: "Private IP in case that is different from above"
        server_port: 5432
        user: "CipherTrust Manager Username"
        password: "CipherTrust Manager Password"
        verify: false
        auth_domain_path:

Authors

  • Anurag Jain (@anugram)