Try SpotterGenerate OpenSSL PKCS#12 archive
Authors: Guillaume Delpierre (@gdelpierre)
Install with ansible-galaxy collection install community.crypto:==2.18.0
collections:
- name: community.crypto
version: 2.18.0This module allows one to (re-)generate PKCS#12.
The module can use the cryptography Python library, or the pyOpenSSL Python library. By default, it tries to detect which one is available, assuming none of the O(iter_size) and O(maciter_size) options are used. This can be overridden with the O(select_crypto_backend) option.
- name: Generate PKCS#12 file
community.crypto.openssl_pkcs12:
action: export
path: /opt/certs/ansible.p12
friendly_name: raclette
privatekey_path: /opt/certs/keys/key.pem
certificate_path: /opt/certs/cert.pem
other_certificates: /opt/certs/ca.pem
# Note that if /opt/certs/ca.pem contains multiple certificates,
# only the first one will be used. See the other_certificates_parse_all
# option for changing this behavior.
state: present
- name: Generate PKCS#12 file
community.crypto.openssl_pkcs12:
action: export
path: /opt/certs/ansible.p12
friendly_name: raclette
privatekey_content: '{{ private_key_contents }}'
certificate_path: /opt/certs/cert.pem
other_certificates_parse_all: true
other_certificates:
- /opt/certs/ca_bundle.pem
# Since we set other_certificates_parse_all to true, all
# certificates in the CA bundle are included and not just
# the first one.
- /opt/certs/intermediate.pem
# In case this file has multiple certificates in it,
# all will be included as well.
state: present
- name: Change PKCS#12 file permission
community.crypto.openssl_pkcs12:
action: export
path: /opt/certs/ansible.p12
friendly_name: raclette
privatekey_path: /opt/certs/keys/key.pem
certificate_path: /opt/certs/cert.pem
other_certificates: /opt/certs/ca.pem
state: present
mode: '0600'
- name: Regen PKCS#12 file
community.crypto.openssl_pkcs12:
action: export
src: /opt/certs/ansible.p12
path: /opt/certs/ansible.p12
friendly_name: raclette
privatekey_path: /opt/certs/keys/key.pem
certificate_path: /opt/certs/cert.pem
other_certificates: /opt/certs/ca.pem
state: present
mode: '0600'
force: true
- name: Dump/Parse PKCS#12 file
community.crypto.openssl_pkcs12:
action: parse
src: /opt/certs/ansible.p12
path: /opt/certs/ansible.pem
state: present
- name: Remove PKCS#12 file
community.crypto.openssl_pkcs12:
path: /opt/certs/ansible.p12
state: absent
src:
description:
- PKCS#12 file path to parse.
type: path
mode:
description:
- The permissions the resulting filesystem object should have.
- For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers.
You must give Ansible enough information to parse them correctly. For consistent
results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives
a string and can do its own conversion from string into number. Adding a leading
zero (for example, V(0755)) works sometimes, but can fail in loops and some other
circumstances.
- Giving Ansible a number without following either of these rules will end up with
a decimal number which will have unexpected results.
- As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx)
or V(u=rw,g=r,o=r)).
- If O(mode) is not specified and the destination filesystem object B(does not) exist,
the default C(umask) on the system will be used when setting the mode for the newly
created filesystem object.
- If O(mode) is not specified and the destination filesystem object B(does) exist,
the mode of the existing filesystem object will be used.
- Specifying O(mode) is the best way to ensure filesystem objects are created with
the correct permissions. See CVE-2020-1736 for further details.
type: raw
path:
description:
- Filename to write the PKCS#12 file to.
required: true
type: path
force:
default: false
description:
- Should the file be regenerated even if it already exists.
type: bool
group:
description:
- Name of the group that should own the filesystem object, as would be fed to I(chown).
- When left unspecified, it uses the current group of the current user unless you
are root, in which case it can preserve the previous ownership.
type: str
owner:
description:
- Name of the user that should own the filesystem object, as would be fed to I(chown).
- When left unspecified, it uses the current user unless you are root, in which case
it can preserve the previous ownership.
- Specifying a numeric username will be assumed to be a user ID and not a username.
Avoid numeric usernames to avoid this confusion.
type: str
state:
choices:
- absent
- present
default: present
description:
- Whether the file should exist or not. All parameters except O(path) are ignored
when state is V(absent).
type: str
action:
choices:
- export
- parse
default: export
description:
- V(export) or V(parse) a PKCS#12.
type: str
backup:
default: false
description:
- Create a backup file including a timestamp so you can get the original output file
back if you overwrote it with a new one by accident.
type: bool
serole:
description:
- The role part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(role) portion of the policy if available.
type: str
setype:
description:
- The type part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(type) portion of the policy if available.
type: str
seuser:
description:
- The user part of the SELinux filesystem object context.
- By default it uses the V(system) policy, where applicable.
- When set to V(_default), it will use the C(user) portion of the policy if available.
type: str
selevel:
description:
- The level part of the SELinux filesystem object context.
- This is the MLS/MCS attribute, sometimes known as the C(range).
- When set to V(_default), it will use the C(level) portion of the policy if available.
type: str
iter_size:
description:
- Number of times to repeat the encryption step.
- This is B(not considered during idempotency checks).
- This is only used by the C(pyopenssl) backend, or when O(encryption_level=compatibility2022).
- When using it, the default is V(2048) for C(pyopenssl) and V(50000) for C(cryptography).
type: int
attributes:
aliases:
- attr
description:
- The attributes the resulting filesystem object should have.
- To get supported flags look at the man page for I(chattr) on the target system.
- This string should contain the attributes in the same order as the one displayed
by I(lsattr).
- The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to
be included in the string.
type: str
version_added: '2.3'
version_added_collection: ansible.builtin
passphrase:
description:
- The PKCS#12 password.
- B(Note:) PKCS12 encryption is not secure and should not be used as a security mechanism.
If you need to store or send a PKCS12 file safely, you should additionally encrypt
it with something else.
type: str
maciter_size:
description:
- Number of times to repeat the MAC step.
- This is B(not considered during idempotency checks).
- This is only used by the C(pyopenssl) backend. When using it, the default is V(1).
type: int
friendly_name:
aliases:
- name
description:
- Specifies the friendly name for the certificate and private key.
type: str
unsafe_writes:
default: false
description:
- Influence when to use atomic operation to prevent data corruption or inconsistent
reads from the target filesystem object.
- By default this module uses atomic operations to prevent data corruption or inconsistent
reads from the target filesystem objects, but sometimes systems are configured or
just broken in ways that prevent this. One example is docker mounted filesystem
objects, which cannot be updated atomically from inside the container and can only
be written in an unsafe manner.
- This option allows Ansible to fall back to unsafe methods of updating filesystem
objects when atomic operations fail (however, it doesn't force Ansible to perform
unsafe writes).
- IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
type: bool
version_added: '2.2'
version_added_collection: ansible.builtin
return_content:
default: false
description:
- If set to V(true), will return the (current or generated) PKCS#12's content as RV(pkcs12).
type: bool
version_added: 1.0.0
version_added_collection: community.crypto
privatekey_path:
description:
- File to read private key from.
- Mutually exclusive with O(privatekey_content).
type: path
certificate_path:
description:
- The path to read certificates and private keys from.
- Must be in PEM format.
type: path
encryption_level:
choices:
- auto
- compatibility2022
default: auto
description:
- Determines the encryption level used.
- V(auto) uses the default of the selected backend. For C(cryptography), this is what
the cryptography library's specific version considers the best available encryption.
- V(compatibility2022) uses compatibility settings for older software in 2022. This
is only supported by the C(cryptography) backend if cryptography >= 38.0.0 is available.
- B(Note) that this option is B(not used for idempotency).
type: str
version_added: 2.8.0
version_added_collection: community.crypto
other_certificates:
aliases:
- ca_certificates
description:
- List of other certificates to include. Pre Ansible 2.8 this parameter was called
O(ca_certificates).
- Assumes there is one PEM-encoded certificate per file. If a file contains multiple
PEM certificates, set O(other_certificates_parse_all) to V(true).
elements: path
type: list
privatekey_content:
description:
- Content of the private key file.
- Mutually exclusive with O(privatekey_path).
type: str
version_added: 2.3.0
version_added_collection: community.crypto
privatekey_passphrase:
description:
- Passphrase source to decrypt any input private keys with.
type: str
select_crypto_backend:
choices:
- auto
- cryptography
- pyopenssl
default: auto
description:
- Determines which crypto backend to use.
- The default choice is V(auto), which tries to use C(cryptography) if available,
and falls back to C(pyopenssl). If O(iter_size) is used together with O(encryption_level)
is not V(compatibility2022), or if O(maciter_size) is used, V(auto) will always
result in C(pyopenssl) to be chosen for backwards compatibility.
- If set to V(pyopenssl), will try to use the L(pyOpenSSL,https://pypi.org/project/pyOpenSSL/)
library.
- If set to V(cryptography), will try to use the L(cryptography,https://cryptography.io/)
library.
type: str
version_added: 1.7.0
version_added_collection: community.crypto
other_certificates_parse_all:
default: false
description:
- If set to V(true), assumes that the files mentioned in O(other_certificates) can
contain more than one certificate per file (or even none per file).
type: bool
version_added: 1.4.0
version_added_collection: community.crypto
backup_file: description: Name of backup file created. returned: changed and if O(backup) is V(true) sample: /path/to/ansible.com.pem.2019-03-09@11:22~ type: str filename: description: Path to the generate PKCS#12 file. returned: changed or success sample: /opt/certs/ansible.p12 type: str pkcs12: description: The (current or generated) PKCS#12's content Base64 encoded. returned: if O(state) is V(present) and O(return_content) is V(true) type: str version_added: 1.0.0 version_added_collection: community.crypto privatekey: description: Path to the TLS/SSL private key the public key was generated from. returned: changed or success sample: /etc/ssl/private/ansible.com.pem type: str