community.crypto.openssl_publickey – Generate an OpenSSL public key from its private key.  Note This plugin is part of the community.crypto collection (version 1.3.0). To install it use: ansible-galaxy collection install community.crypto. To use it in a playbook, specify: community.crypto.openssl_publickey.   Synopsis Requirements Parameters See Also Examples Return Values  Synopsis  This module allows one to (re)generate OpenSSL public keys from their private keys. Keys are generated in PEM or OpenSSH format. 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. When format is OpenSSH, the cryptography backend has to be used. Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in community.crypto 2.0.0.  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 >= 16.0.0 Needs cryptography >= 1.4 if format is OpenSSH
  Parameters   Parameter Choices/Defaults Comments    attributes  string   added in 2.3 of ansible.builtin      The attributes the resulting 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. The = operator is assumed as default, otherwise + or - operators need to be included in the string. 
aliases: attr     backup  boolean    
Choices: 
no ← yes    Create a backup file including a timestamp so you can get the original public key back if you overwrote it with a different one by accident.     force  boolean    
Choices: 
no ← yes    Should the key be regenerated even it it already exists.     format  string    
Choices: OpenSSH 
PEM ←    The format of the public key.     group  string      Name of the group that should own the file/directory, as would be fed to chown.     mode  raw      The permissions the resulting file or directory should have. 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 Ansible 1.8, the mode may be specified as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r).     owner  string      Name of the user that should own the file/directory, as would be fed to chown.     path  path / required      Name of the file in which the generated TLS/SSL public key will be written.     privatekey_content  string   added in 1.0.0 of community.crypto      The content of the TLS/SSL private key from which to generate the public key. Either privatekey_path or privatekey_content must be specified, but not both. If state is present, one of them is required.     privatekey_passphrase  string      The passphrase for the private key.     privatekey_path  path      Path to the TLS/SSL private key from which to generate the public key. Either privatekey_path or privatekey_content must be specified, but not both. If state is present, one of them is required.     return_content  boolean   added in 1.0.0 of community.crypto    
Choices: 
no ← yes    If set to yes, will return the (current or generated) public key's content as publickey.     select_crypto_backend  string    
Choices: 
auto ← cryptography pyopenssl    Determines which crypto backend to use. The default choice is auto, which tries to use cryptography if available, and falls back to pyopenssl. If set to pyopenssl, will try to use the pyOpenSSL library. If set to cryptography, will try to use the cryptography library.     selevel  string      The level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the range. When set to _default, it will use the level portion of the policy if available.     serole  string      The role part of the SELinux file context. When set to _default, it will use the role portion of the policy if available.     setype  string      The type part of the SELinux file context. When set to _default, it will use the type portion of the policy if available.     seuser  string      The user part of the SELinux file context. By default it uses the system policy, where applicable. When set to _default, it will use the user portion of the policy if available.     state  string    
Choices: absent 
present ←    Whether the public key should exist or not, taking action if the state is different from what is stated.     unsafe_writes  boolean   added in 2.2 of ansible.builtin    
Choices: 
no ← yes    Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file. 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.     See Also  See also  community.crypto.x509_certificate

The official documentation on the community.crypto.x509_certificate module.  community.crypto.x509_certificate_pipe

The official documentation on the community.crypto.x509_certificate_pipe module.  community.crypto.openssl_csr

The official documentation on the community.crypto.openssl_csr module.  community.crypto.openssl_csr_pipe

The official documentation on the community.crypto.openssl_csr_pipe module.  community.crypto.openssl_dhparam

The official documentation on the community.crypto.openssl_dhparam module.  community.crypto.openssl_pkcs12

The official documentation on the community.crypto.openssl_pkcs12 module.  community.crypto.openssl_privatekey

The official documentation on the community.crypto.openssl_privatekey module.  community.crypto.openssl_privatekey_pipe

The official documentation on the community.crypto.openssl_privatekey_pipe module.    Examples - name: Generate an OpenSSL public key in PEM format
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    privatekey_path: /etc/ssl/private/ansible.com.pem

- name: Generate an OpenSSL public key in PEM format from an inline key
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    privatekey_content: "{{ private_key_content }}"

- name: Generate an OpenSSL public key in OpenSSH v2 format
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    privatekey_path: /etc/ssl/private/ansible.com.pem
    format: OpenSSH

- name: Generate an OpenSSL public key with a passphrase protected private key
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    privatekey_path: /etc/ssl/private/ansible.com.pem
    privatekey_passphrase: ansible

- name: Force regenerate an OpenSSL public key if it already exists
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    privatekey_path: /etc/ssl/private/ansible.com.pem
    force: yes

- name: Remove an OpenSSL public key
  community.crypto.openssl_publickey:
    path: /etc/ssl/public/ansible.com.pem
    state: absent
 Return Values Common return values are documented here, the following are the fields unique to this module:   Key Returned Description    backup_file  string   changed and if backup is yes
  Name of backup file created.  Sample: /path/to/publickey.pem.2019-03-09@11:22~     filename  string   changed or success  Path to the generated TLS/SSL public key file.  Sample: /etc/ssl/public/ansible.com.pem     fingerprint  dictionary   changed or success  The fingerprint of the public key. Fingerprint will be generated for each hashlib.algorithms available. Requires PyOpenSSL >= 16.0 for meaningful output.  Sample: {'md5': '8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069', 'sha1': '8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:ee:71:f6:10', 'sha224': '8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:e9:f5:9b:46', 'sha256': '8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069', 'sha384': '8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069', 'sha512': '8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:8b7c:f320:99b9:690f:4595:cd17:293a:c069:01:1e:a6:60:...:0f:9b'}     format  string   changed or success  The format of the public key (PEM, OpenSSH, ...).  Sample: PEM     privatekey  string   changed or success  Path to the TLS/SSL private key the public key was generated from. Will be none if the private key has been provided in privatekey_content.  Sample: /etc/ssl/private/ansible.com.pem     publickey  string  added in 1.0.0 of community.crypto  if state is present and return_content is yes
  The (current or generated) public key's content.      Authors  Yanis Guenane (@Spredzy) Felix Fontein (@felixfontein) 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible~2.10/collections/community/crypto/openssl_publickey_module.html', 'source': 'DevDocs.IO'}