community.crypto.openssl_privatekey_pipe – Generate OpenSSL private keys without disk access

• Synopsis
• Requirements
• Parameters
• See Also
• Examples
• Return Values

Synopsis

• Keys are generated in PEM format.
• Make sure to not write the result of this module into logs or to the console, as it contains private key data! Use the no_log task option to be sure.
• Note that this module is implemented as an action plugin and will always be executed on the controller.
• One can generate RSA, DSA, ECC or EdDSA private keys.
• Please note that the module regenerates private keys if they don’t match the module’s options. In particular, if you provide another passphrase (or specify none), change the keysize, etc., the private key will be regenerated. If you are concerned that this could overwrite your private key, consider using the backup option.
• The module can use the cryptography Python library, or the pyOpenSSL Python library. By default, it tries to detect which one is available. This can be overridden with the select_crypto_backend option. Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in community.crypto 2.0.0.
• This allows to read and write keys to vaults without having to write intermediate versions to disk.
• This module allows one to (re)generate OpenSSL private keys without disk access.

Requirements

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

• Either cryptography >= 1.2.3 (older versions might work as well)
• Or pyOpenSSL

Parameters

See Also

Examples

- name: Generate an OpenSSL private key with the default values (4096 bits, RSA)
  community.crypto.openssl_privatekey_pipe:
    path: /etc/ssl/private/ansible.com.pem
  register: output
  no_log: true  # make sure that private key data is not accidentally revealed in logs!
- name: Show generated key
  debug:
    msg: "{{ output.privatekey }}"
  # DO NOT OUTPUT KEY MATERIAL TO CONSOLE OR LOGS IN PRODUCTION!

- block:
    - name: Update sops-encrypted key with the community.sops collection
      community.crypto.openssl_privatekey_pipe:
        content: "{{ lookup('community.sops.sops', 'private_key.pem.sops') }}"
        size: 2048
      register: output
      no_log: true  # make sure that private key data is not accidentally revealed in logs!

    - name: Update encrypted key when openssl_privatekey_pipe reported a change
      community.sops.encrypt_sops:
        path: private_key.pem.sops
        content_text: "{{ output.privatekey }}"
      when: output is changed
  always:
    - name: Make sure that output (which contains the private key) is overwritten
      set_fact:
        output: ''

Return Values

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

Authors

• Yanis Guenane (@Spredzy)
• Felix Fontein (@felixfontein)