openssl_pkcs12 – Generate OpenSSL PKCS#12 archive.

New in version 2.7.

Synopsis

  • This module allows one to (re-)generate PKCS#12.

Requirements

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

  • python-pyOpenSSL

Parameters

Parameter Choices/Defaults Comments
action
-
    Choices:
  • parse
  • export ←
export or parse a PKCS#12.
attributes
-
added in 2.3
Attributes the file or directory should have. To get supported flags look at the man page for chattr on the target system. This string should contain the attributes in the same order as the one displayed by lsattr.
= operator is assumed as default, otherwise + or - operators need to be included in the string.

aliases: attr
ca_certificates
-
List of CA certificate to include.
certificate_path
-
The path to read certificates and private keys from. Must be in PEM format.
force
boolean
    Choices:
  • no ←
  • yes
Should the file be regenerated even if it already exists.
friendly_name
-
Specifies the friendly name for the certificate and private key.

aliases: name
group
-
Name of the group that should own the file/directory, as would be fed to chown.
iter_size
-
Default:
2048
Number of times to repeat the encryption step.
maciter_size
-
Default:
1
Number of times to repeat the MAC step.
mode
-
Mode the file or directory should be. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either add a leading zero so that Ansible's YAML parser knows it is an octal number (like 0644 or 01777) or quote it (like '644' or '1777') so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results. As of version 1.8, the mode may be specified as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r).
owner
-
Name of the user that should own the file/directory, as would be fed to chown.
passphrase
-
The PKCS#12 password.
path
- / required
Filename to write the PKCS#12 file to.
privatekey_passphrase
-
Passphrase source to decrypt any input private keys with.
privatekey_path
-
File to read private key from.
selevel
-
Default:
"s0"
Level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the range. _default feature works as for seuser.
serole
-
Role part of SELinux file context, _default feature works as for seuser.
setype
-
Type part of SELinux file context, _default feature works as for seuser.
seuser
-
User part of SELinux file context. Will default to system policy, if applicable. If set to _default, it will use the user portion of the policy if available.
src
-
PKCS#12 file path to parse.
state
-
    Choices:
  • present ←
  • absent
Whether the file should exist or not. All parameters except path are ignored when state is absent.
unsafe_writes
boolean
added in 2.2
    Choices:
  • no ←
  • yes
By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted files, 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 files 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.

Examples

- name: 'Generate PKCS#12 file'
  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'
    ca_certificates: '/opt/certs/ca.pem'
    state: present

- name: 'Change PKCS#12 file permission'
  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'
    ca_certificates: '/opt/certs/ca.pem'
    state: present
    mode: 0600

- name: 'Regen PKCS#12 file'
  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'
    ca_certificates: '/opt/certs/ca.pem'
    state: present
    mode: 0600
    force: True

- name: 'Dump/Parse PKCS#12 file'
  openssl_pkcs12:
    action: parse
    src: '/opt/certs/ansible.p12'
    path: '/opt/certs/ansible.pem'
    state: present

- name: 'Remove PKCS#12 file'
  openssl_pkcs12:
    path: '/opt/certs/ansible.p12'
    state: absent

Return Values

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

Key Returned Description
filename
string
 changed or success
Path to the generate PKCS#12 file.

Sample:
/opt/certs/ansible.p12
privatekey
string
 changed or success
Path to the TLS/SSL private key the public key was generated from

Sample:
/etc/ssl/private/ansible.com.pem


Status

Authors

  • Guillaume Delpierre (@gdelpierre)

Hint

If you notice any issues in this documentation you can edit this document to improve it.