Add x509_crl_info filter

plugins/filter/x509_crl_info.py

@@ -0,0 +1,196 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2022, Felix Fontein <[email protected]>
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+DOCUMENTATION = '''
+name: x509_crl_info
+short_description: Retrieve information from X.509 CRLs in PEM format
+version_added: 2.10.0
+author:
+    - Felix Fontein (@felixfontein)
+description:
+    - Provided a X.509 crl in PEM format, retrieve information.
+    - This is a filter version of the M(community.crypto.x509_crl_info) module.
+options:
+    _input:
+        description:
+            - The content of the X.509 CRL in PEM format.
+        type: string
+        required: true
+    list_revoked_certificates:
+        description:
+            - If set to C(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.
+        type: bool
+        default: true
+        version_added: 1.7.0
+extends_documentation_fragment:
+    - community.crypto.name_encoding
+seealso:
+    - module: community.crypto.x509_crl_info
+'''
+
+EXAMPLES = '''
+- name: Show the Organization Name of the CRL's subject
+  ansible.builtin.debug:
+    msg: >-
+      {{
+        (
+          lookup('ansible.builtin.file', '/path/to/cert.pem')
+          | community.crypto.x509_crl_info
+        ).issuer.organizationName
+      }}
+'''
+
+RETURN = '''
+_value:
+    description:
+        - Information on the CRL.
+    type: dict
+    contains:
+        format:
+            description:
+                - Whether the CRL is in PEM format (C(pem)) or in DER format (C(der)).
+            returned: success
+            type: str
+            sample: pem
+        issuer:
+            description:
+                - The CRL's issuer.
+                - Note that for repeated values, only the last one will be returned.
+                - See I(name_encoding) for how IDNs are handled.
+            returned: success
+            type: dict
+            sample: {"organizationName": "Ansible", "commonName": "ca.example.com"}
+        issuer_ordered:
+            description: The CRL's issuer as an ordered list of tuples.
+            returned: success
+            type: list
+            elements: list
+            sample: [["organizationName", "Ansible"], ["commonName": "ca.example.com"]]
+        last_update:
+            description: The point in time from which this CRL can be trusted as ASN.1 TIME.
+            returned: success
+            type: str
+            sample: '20190413202428Z'
+        next_update:
+            description: 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
+            type: str
+            sample: '20190413202428Z'
+        digest:
+            description: The signature algorithm used to sign the CRL.
+            returned: success
+            type: str
+            sample: sha256WithRSAEncryption
+        revoked_certificates:
+            description: List of certificates to be revoked.
+            returned: success if I(list_revoked_certificates=true)
+            type: list
+            elements: dict
+            contains:
+                serial_number:
+                    description: Serial number of the certificate.
+                    type: int
+                    sample: 1234
+                revocation_date:
+                    description: The point in time the certificate was revoked as ASN.1 TIME.
+                    type: str
+                    sample: '20190413202428Z'
+                issuer:
+                    description:
+                        - The certificate's issuer.
+                        - See I(name_encoding) for how IDNs are handled.
+                    type: list
+                    elements: str
+                    sample: ["DNS:ca.example.org"]
+                issuer_critical:
+                    description: Whether the certificate issuer extension is critical.
+                    type: bool
+                    sample: false
+                reason:
+                    description:
+                        - The value for the revocation reason extension.
+                        - One of C(unspecified), C(key_compromise), C(ca_compromise), C(affiliation_changed), C(superseded),
+                          C(cessation_of_operation), C(certificate_hold), C(privilege_withdrawn), C(aa_compromise), and
+                          C(remove_from_crl).
+                    type: str
+                    sample: key_compromise
+                reason_critical:
+                    description: Whether the revocation reason extension is critical.
+                    type: bool
+                    sample: false
+                invalidity_date:
+                    description: |
+                        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.
+                    type: str
+                    sample: '20190413202428Z'
+                invalidity_date_critical:
+                    description: Whether the invalidity date extension is critical.
+                    type: bool
+                    sample: false
+'''
+
+import base64
+import binascii
+
+from ansible.errors import AnsibleFilterError
+from ansible.module_utils.six import string_types
+from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text
+
+from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import (
+    OpenSSLObjectError,
+)
+
+from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import (
+    identify_pem_format,
+)
+
+from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.crl_info import (
+    get_crl_info,
+)
+
+from ansible_collections.community.crypto.plugins.plugin_utils.filter_module import FilterModuleMock
+
+
+def x509_crl_info_filter(data, name_encoding='ignore', list_revoked_certificates=True):
+    '''Extract information from X.509 PEM certificate.'''
+    if not isinstance(data, string_types):
+        raise AnsibleFilterError('The community.crypto.x509_crl_info input must be a text type, not %s' % type(data))
+    if not isinstance(name_encoding, string_types):
+        raise AnsibleFilterError('The name_encoding option must be of a text type, not %s' % type(name_encoding))
+    if not isinstance(list_revoked_certificates, bool):
+        raise AnsibleFilterError('The list_revoked_certificates option must be a boolean, not %s' % type(list_revoked_certificates))
+    name_encoding = to_native(name_encoding)
+    if name_encoding not in ('ignore', 'idna', 'unicode'):
+        raise AnsibleFilterError('The name_encoding option must be one of the values "ignore", "idna", or "unicode", not "%s"' % name_encoding)
+
+    data = to_bytes(data)
+    if not identify_pem_format(data):
+        try:
+            data = base64.b64decode(to_native(data))
+        except (binascii.Error, TypeError, ValueError, UnicodeEncodeError) as e:
+            pass
+
+    module = FilterModuleMock({'name_encoding': name_encoding})
+    try:
+        return get_crl_info(module, content=data, list_revoked_certificates=list_revoked_certificates)
+    except OpenSSLObjectError as exc:
+        raise AnsibleFilterError(to_native(exc))
+
+
+class FilterModule(object):
+    '''Ansible jinja2 filters'''
+
+    def filters(self):
+        return {
+            'x509_crl_info': x509_crl_info_filter,
+        }

plugins/modules/x509_crl_info.py

@@ -50,6 +50,10 @@
       They are all in UTC.
 seealso:
     - module: community.crypto.x509_crl
+    - ref: community.crypto.x509_crl_info filter <ansible_collections.community.crypto.x509_crl_info_filter>
+    # - plugin: community.crypto.x509_crl_info
+    #   plugin_type: filter
+      description: A filter variant of this module.
 '''
 
 EXAMPLES = r'''

tests/integration/targets/filter_x509_crl_info/aliases

@@ -0,0 +1,7 @@
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+azp/generic/2
+azp/posix/2
+destructive

tests/integration/targets/filter_x509_crl_info/meta/main.yml

@@ -0,0 +1,8 @@
+---
+# Copyright (c) Ansible Project
+# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+dependencies:
+  - setup_openssl
+  - setup_remote_tmp_dir