You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.crypto.x509_crl_info module – Retrieve information on Certificate Revocation Lists (CRLs)

Note

This module is part of the community.crypto collection (version 2.3.4).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.crypto.

To use it in a playbook, specify: community.crypto.x509_crl_info.

New in version 1.0.0: of community.crypto

Synopsis

• This module allows one to retrieve information on Certificate Revocation Lists (CRLs).

Requirements

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

• If name_encoding is set to another value than ignore, the idna Python library needs to be installed.

• cryptography >= 1.2

Parameters

Parameter	Comments
content string	Content of the X.509 CRL in PEM format, or Base64-encoded X.509 CRL. Either path or content must be specified, but not both.
list_revoked_certificates boolean added in 1.7.0 of community.crypto	If set to false, the list of revoked certificates is not included in the result. This is useful when retrieving information on large CRL files. Enumerating all revoked certificates can take some time, including serializing the result as JSON, sending it to the Ansible controller, and decoding it again. Choices: no yes ← (default)
name_encoding string	How to encode names (DNS names, URIs, email addresses) in return values. ignore will use the encoding returned by the backend. idna will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails. unicode will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails. Note that idna and unicode require the idna Python library to be installed. Choices: ignore ← (default) idna unicode
path path	Remote absolute path where the generated CRL file should be created or is already located. Either path or content must be specified, but not both.

Notes

Note

• All timestamp values are provided in ASN.1 TIME format, in other words, following the YYYYMMDDHHMMSSZ pattern. They are all in UTC.

• Supports check_mode.

See Also

See also

community.crypto.x509_crl

The official documentation on the community.crypto.x509_crl module.

Examples

- name: Get information on CRL
  community.crypto.x509_crl_info:
    path: /etc/ssl/my-ca.crl
  register: result

- name: Print the information
  ansible.builtin.debug:
    msg: "{{ result }}"

- name: Get information on CRL without list of revoked certificates
  community.crypto.x509_crl_info:
    path: /etc/ssl/very-large.crl
    list_revoked_certificates: false
  register: result

Return Values

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

Key	Description
digest string	The signature algorithm used to sign the CRL. Returned: success Sample: “sha256WithRSAEncryption”
format string	Whether the CRL is in PEM format (pem) or in DER format (der). Returned: success Sample: “pem”
issuer dictionary	The CRL’s issuer. Note that for repeated values, only the last one will be returned. See name_encoding for how IDNs are handled. Returned: success Sample: “{\”organizationName\”: \”Ansible\”, \”commonName\”: \”ca.example.com\”}”
issuer_ordered list / elements=list	The CRL’s issuer as an ordered list of tuples. Returned: success Sample: “[[\”organizationName\”, \”Ansible\”], [\”commonName\”: \”ca.example.com\”]]”
last_update string	The point in time from which this CRL can be trusted as ASN.1 TIME. Returned: success Sample: “20190413202428Z”
next_update string	The point in time from which a new CRL will be issued and the client has to check for it as ASN.1 TIME. Returned: success Sample: “20190413202428Z”
revoked_certificates list / elements=dictionary	List of certificates to be revoked. Returned: success if list_revoked_certificates=true
invalidity_date string	The point in time it was known/suspected that the private key was compromised or that the certificate otherwise became invalid as ASN.1 TIME. Returned: success Sample: “20190413202428Z”
invalidity_date_critical boolean	Whether the invalidity date extension is critical. Returned: success Sample: false
issuer list / elements=string	The certificate’s issuer. See name_encoding for how IDNs are handled. Returned: success Sample: “[\”DNS:ca.example.org\”]”
issuer_critical boolean	Whether the certificate issuer extension is critical. Returned: success Sample: false
reason string	The value for the revocation reason extension. One of unspecified, key_compromise, ca_compromise, affiliation_changed, superseded, cessation_of_operation, certificate_hold, privilege_withdrawn, aa_compromise, and remove_from_crl. Returned: success Sample: “key_compromise”
reason_critical boolean	Whether the revocation reason extension is critical. Returned: success Sample: false
revocation_date string	The point in time the certificate was revoked as ASN.1 TIME. Returned: success Sample: “20190413202428Z”
serial_number integer	Serial number of the certificate. Returned: success Sample: 1234

Authors

• Felix Fontein (@felixfontein)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication