openssl_csr_info – Provide information of OpenSSL Certificate Signing Requests (CSR)¶
New in version 2.8.
Synopsis¶
- This module allows one to query information on OpenSSL Certificate Signing Requests (CSR).
- In case the CSR signature cannot be validated, the module will fail. In this case, all return variables are still returned.
- 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.3
Parameters¶
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| path 
                    path
                                             / required                     | Remote absolute path where the CSR file is loaded from. | |
| select_crypto_backend 
                    string
                                                                 | 
 | Determines which crypto backend to use. The default choice is  auto, which tries to usecryptographyif available, and falls back topyopenssl.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  pyopensslbackend has been deprecated in Ansible 2.9, and will be removed in Ansible 2.13. From that point on, only thecryptographybackend will be available. | 
See Also¶
See also
- openssl_csr – Generate OpenSSL Certificate Signing Request (CSR)
- The official documentation on the openssl_csr module.
Examples¶
- name: Generate an OpenSSL Certificate Signing Request
  openssl_csr:
    path: /etc/ssl/csr/www.ansible.com.csr
    privatekey_path: /etc/ssl/private/ansible.com.pem
    common_name: www.ansible.com
- name: Get information on the CSR
  openssl_csr_info:
    path: /etc/ssl/csr/www.ansible.com.csr
  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.
