community / community.crypto / 2.18.0 / module / openssl_privatekey_convert Convert OpenSSL private keys | "added in version" 2.1.0 of community.crypto" Authors: Felix Fontein (@felixfontein)community.crypto.openssl_privatekey_convert (2.18.0) — module
Install with ansible-galaxy collection install community.crypto:==2.18.0
collections: - name: community.crypto version: 2.18.0
This module allows one to convert OpenSSL private keys.
The default mode for the private key file will be V(0600) if O(mode) is not explicitly set.
- name: Convert private key to PKCS8 format with passphrase community.crypto.openssl_privatekey_convert: src_path: /etc/ssl/private/ansible.com.pem dest_path: /etc/ssl/private/ansible.com.key dest_passphrase: '{{ private_key_passphrase }}' format: pkcs8
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 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 backup: default: false description: - Create a backup file including a timestamp so you can get the original private key back if you overwrote it with a new one by accident. type: bool format: choices: - pkcs1 - pkcs8 - raw description: - Determines which format the destination private key should be written in. - Please note that not every key can be exported in any format, and that not every format supports encryption. required: true type: str 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 src_path: description: - Name of the file containing the OpenSSL private key to convert. - Exactly one of O(src_path) or O(src_content) must be specified. type: path dest_path: description: - Name of the file in which the generated TLS/SSL private key will be written. It will have V(0600) mode if O(mode) is not explicitly set. required: true type: path 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 src_content: description: - The content of the file containing the OpenSSL private key to convert. - Exactly one of O(src_path) or O(src_content) must be specified. 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 src_passphrase: description: - The passphrase for the private key to load. type: str dest_passphrase: description: - The passphrase for the private key to store. type: str
backup_file: description: Name of backup file created. returned: changed and if O(backup) is V(true) sample: /path/to/privatekey.pem.2019-03-09@11:22~ type: str