openssl_privatekey_info – Provide information for OpenSSL private keys¶
New in version 2.8.
Synopsis¶
- This module allows one to query information on OpenSSL private keys.
- In case the key consistency checks fail, the module will fail as this indicates a faked private key. In this case, all return variables are still returned. Note that key consistency checks are not available all key types; if none is available,
none
is returned forkey_is_consistent
. - It uses the pyOpenSSL or cryptography python library to interact with OpenSSL. If both the cryptography and PyOpenSSL libraries are available (and meet the minimum version requirements) cryptography will be preferred as a backend over PyOpenSSL (unless the backend is forced with
select_crypto_backend
). Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in Ansible 2.13.
Requirements¶
The below requirements are needed on the host that executes this module.
- PyOpenSSL >= 0.15 or cryptography >= 1.2.3
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
passphrase
string
|
The passphrase for the private key.
|
|
path
path
/ required
|
Remote absolute path where the private key file is loaded from.
|
|
return_private_key_data
boolean
|
|
Whether to return private key data.
Only set this to
yes when you want private information about this key to leave the remote machine.WARNING: you have to make sure that private key data isn't accidentally logged!
|
select_crypto_backend
string
|
|
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.Please note that the
pyopenssl backend has been deprecated in Ansible 2.9, and will be removed in Ansible 2.13. From that point on, only the cryptography backend will be available. |
See Also¶
See also
- openssl_privatekey – Generate OpenSSL private keys
- The official documentation on the openssl_privatekey module.
Examples¶
- name: Generate an OpenSSL private key with the default values (4096 bits, RSA)
openssl_privatekey:
path: /etc/ssl/private/ansible.com.pem
- name: Get information on generated key
openssl_privatekey_info:
path: /etc/ssl/private/ansible.com.pem
register: result
- name: Dump information
debug:
var: result
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Felix Fontein (@felixfontein)
- Yanis Guenane (@Spredzy)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.