mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
865 lines
32 KiB
Python
865 lines
32 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright: (c) 2016-2017, Yanis Guenane <yanis+ansible@guenane.org>
|
|
# Copyright: (c) 2017, Markus Teufelberger <mteufelberger+ansible@mgit.at>
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|
'status': ['preview'],
|
|
'supported_by': 'community'}
|
|
|
|
DOCUMENTATION = r'''
|
|
---
|
|
module: openssl_certificate_info
|
|
version_added: '2.8'
|
|
short_description: Provide information of OpenSSL X.509 certificates
|
|
description:
|
|
- This module allows one to query information on OpenSSL certificates.
|
|
- 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
|
|
C(select_crypto_backend)). Please note that the PyOpenSSL backend was deprecated in Ansible 2.9
|
|
and will be removed in Ansible 2.13.
|
|
requirements:
|
|
- PyOpenSSL >= 0.15 or cryptography >= 1.6
|
|
author:
|
|
- Felix Fontein (@felixfontein)
|
|
- Yanis Guenane (@Spredzy)
|
|
- Markus Teufelberger (@MarkusTeufelberger)
|
|
options:
|
|
path:
|
|
description:
|
|
- Remote absolute path where the certificate file is loaded from.
|
|
- Either I(path) or I(content) must be specified, but not both.
|
|
type: path
|
|
content:
|
|
description:
|
|
- Content of the X.509 certificate in PEM format.
|
|
- Either I(path) or I(content) must be specified, but not both.
|
|
type: str
|
|
version_added: "2.10"
|
|
valid_at:
|
|
description:
|
|
- A dict of names mapping to time specifications. Every time specified here
|
|
will be checked whether the certificate is valid at this point. See the
|
|
C(valid_at) return value for informations on the result.
|
|
- Time can be specified either as relative time or as absolute timestamp.
|
|
- Time will always be interpreted as UTC.
|
|
- Valid format is C([+-]timespec | ASN.1 TIME) where timespec can be an integer
|
|
+ C([w | d | h | m | s]) (e.g. C(+32w1d2h), and ASN.1 TIME (i.e. pattern C(YYYYMMDDHHMMSSZ)).
|
|
Note that all timestamps will be treated as being in UTC.
|
|
type: dict
|
|
select_crypto_backend:
|
|
description:
|
|
- Determines which crypto backend to use.
|
|
- The default choice is C(auto), which tries to use C(cryptography) if available, and falls back to C(pyopenssl).
|
|
- If set to C(pyopenssl), will try to use the L(pyOpenSSL,https://pypi.org/project/pyOpenSSL/) library.
|
|
- If set to C(cryptography), will try to use the L(cryptography,https://cryptography.io/) library.
|
|
- Please note that the C(pyopenssl) backend has been deprecated in Ansible 2.9, and will be removed in Ansible 2.13.
|
|
From that point on, only the C(cryptography) backend will be available.
|
|
type: str
|
|
default: auto
|
|
choices: [ auto, cryptography, pyopenssl ]
|
|
|
|
notes:
|
|
- All timestamp values are provided in ASN.1 TIME format, i.e. following the C(YYYYMMDDHHMMSSZ) pattern.
|
|
They are all in UTC.
|
|
seealso:
|
|
- module: openssl_certificate
|
|
'''
|
|
|
|
EXAMPLES = r'''
|
|
- name: Generate a Self Signed OpenSSL certificate
|
|
openssl_certificate:
|
|
path: /etc/ssl/crt/ansible.com.crt
|
|
privatekey_path: /etc/ssl/private/ansible.com.pem
|
|
csr_path: /etc/ssl/csr/ansible.com.csr
|
|
provider: selfsigned
|
|
|
|
|
|
# Get information on the certificate
|
|
|
|
- name: Get information on generated certificate
|
|
openssl_certificate_info:
|
|
path: /etc/ssl/crt/ansible.com.crt
|
|
register: result
|
|
|
|
- name: Dump information
|
|
debug:
|
|
var: result
|
|
|
|
|
|
# Check whether the certificate is valid or not valid at certain times, fail
|
|
# if this is not the case. The first task (openssl_certificate_info) collects
|
|
# the information, and the second task (assert) validates the result and
|
|
# makes the playbook fail in case something is not as expected.
|
|
|
|
- name: Test whether that certificate is valid tomorrow and/or in three weeks
|
|
openssl_certificate_info:
|
|
path: /etc/ssl/crt/ansible.com.crt
|
|
valid_at:
|
|
point_1: "+1d"
|
|
point_2: "+3w"
|
|
register: result
|
|
|
|
- name: Validate that certificate is valid tomorrow, but not in three weeks
|
|
assert:
|
|
that:
|
|
- result.valid_at.point_1 # valid in one day
|
|
- not result.valid_at.point_2 # not valid in three weeks
|
|
'''
|
|
|
|
RETURN = r'''
|
|
expired:
|
|
description: Whether the certificate is expired (i.e. C(notAfter) is in the past)
|
|
returned: success
|
|
type: bool
|
|
basic_constraints:
|
|
description: Entries in the C(basic_constraints) extension, or C(none) if extension is not present.
|
|
returned: success
|
|
type: list
|
|
elements: str
|
|
sample: "[CA:TRUE, pathlen:1]"
|
|
basic_constraints_critical:
|
|
description: Whether the C(basic_constraints) extension is critical.
|
|
returned: success
|
|
type: bool
|
|
extended_key_usage:
|
|
description: Entries in the C(extended_key_usage) extension, or C(none) if extension is not present.
|
|
returned: success
|
|
type: list
|
|
elements: str
|
|
sample: "[Biometric Info, DVCS, Time Stamping]"
|
|
extended_key_usage_critical:
|
|
description: Whether the C(extended_key_usage) extension is critical.
|
|
returned: success
|
|
type: bool
|
|
extensions_by_oid:
|
|
description: Returns a dictionary for every extension OID
|
|
returned: success
|
|
type: dict
|
|
contains:
|
|
critical:
|
|
description: Whether the extension is critical.
|
|
returned: success
|
|
type: bool
|
|
value:
|
|
description: The Base64 encoded value (in DER format) of the extension
|
|
returned: success
|
|
type: str
|
|
sample: "MAMCAQU="
|
|
sample: '{"1.3.6.1.5.5.7.1.24": { "critical": false, "value": "MAMCAQU="}}'
|
|
key_usage:
|
|
description: Entries in the C(key_usage) extension, or C(none) if extension is not present.
|
|
returned: success
|
|
type: str
|
|
sample: "[Key Agreement, Data Encipherment]"
|
|
key_usage_critical:
|
|
description: Whether the C(key_usage) extension is critical.
|
|
returned: success
|
|
type: bool
|
|
subject_alt_name:
|
|
description: Entries in the C(subject_alt_name) extension, or C(none) if extension is not present.
|
|
returned: success
|
|
type: list
|
|
elements: str
|
|
sample: "[DNS:www.ansible.com, IP:1.2.3.4]"
|
|
subject_alt_name_critical:
|
|
description: Whether the C(subject_alt_name) extension is critical.
|
|
returned: success
|
|
type: bool
|
|
ocsp_must_staple:
|
|
description: C(yes) if the OCSP Must Staple extension is present, C(none) otherwise.
|
|
returned: success
|
|
type: bool
|
|
ocsp_must_staple_critical:
|
|
description: Whether the C(ocsp_must_staple) extension is critical.
|
|
returned: success
|
|
type: bool
|
|
issuer:
|
|
description:
|
|
- The certificate's issuer.
|
|
- Note that for repeated values, only the last one will be returned.
|
|
returned: success
|
|
type: dict
|
|
sample: '{"organizationName": "Ansible", "commonName": "ca.example.com"}'
|
|
issuer_ordered:
|
|
description: The certificate's issuer as an ordered list of tuples.
|
|
returned: success
|
|
type: list
|
|
elements: list
|
|
sample: '[["organizationName", "Ansible"], ["commonName": "ca.example.com"]]'
|
|
version_added: "2.9"
|
|
subject:
|
|
description:
|
|
- The certificate's subject as a dictionary.
|
|
- Note that for repeated values, only the last one will be returned.
|
|
returned: success
|
|
type: dict
|
|
sample: '{"commonName": "www.example.com", "emailAddress": "test@example.com"}'
|
|
subject_ordered:
|
|
description: The certificate's subject as an ordered list of tuples.
|
|
returned: success
|
|
type: list
|
|
elements: list
|
|
sample: '[["commonName", "www.example.com"], ["emailAddress": "test@example.com"]]'
|
|
version_added: "2.9"
|
|
not_after:
|
|
description: C(notAfter) date as ASN.1 TIME
|
|
returned: success
|
|
type: str
|
|
sample: 20190413202428Z
|
|
not_before:
|
|
description: C(notBefore) date as ASN.1 TIME
|
|
returned: success
|
|
type: str
|
|
sample: 20190331202428Z
|
|
public_key:
|
|
description: Certificate's public key in PEM format
|
|
returned: success
|
|
type: str
|
|
sample: "-----BEGIN PUBLIC KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8A..."
|
|
public_key_fingerprints:
|
|
description:
|
|
- Fingerprints of certificate's public key.
|
|
- For every hash algorithm available, the fingerprint is computed.
|
|
returned: success
|
|
type: dict
|
|
sample: "{'sha256': 'd4:b3:aa:6d:c8:04:ce:4e:ba:f6:29:4d:92:a3:94:b0:c2:ff:bd:bf:33:63:11:43:34:0f:51:b0:95:09:2f:63',
|
|
'sha512': 'f7:07:4a:f0:b0:f0:e6:8b:95:5f:f9:e6:61:0a:32:68:f1..."
|
|
signature_algorithm:
|
|
description: The signature algorithm used to sign the certificate.
|
|
returned: success
|
|
type: str
|
|
sample: sha256WithRSAEncryption
|
|
serial_number:
|
|
description: The certificate's serial number.
|
|
returned: success
|
|
type: int
|
|
sample: 1234
|
|
version:
|
|
description: The certificate version.
|
|
returned: success
|
|
type: int
|
|
sample: 3
|
|
valid_at:
|
|
description: For every time stamp provided in the I(valid_at) option, a
|
|
boolean whether the certificate is valid at that point in time
|
|
or not.
|
|
returned: success
|
|
type: dict
|
|
subject_key_identifier:
|
|
description:
|
|
- The certificate's subject key identifier.
|
|
- The identifier is returned in hexadecimal, with C(:) used to separate bytes.
|
|
- Is C(none) if the C(SubjectKeyIdentifier) extension is not present.
|
|
returned: success and if the pyOpenSSL backend is I(not) used
|
|
type: str
|
|
sample: '00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33'
|
|
version_added: "2.9"
|
|
authority_key_identifier:
|
|
description:
|
|
- The certificate's authority key identifier.
|
|
- The identifier is returned in hexadecimal, with C(:) used to separate bytes.
|
|
- Is C(none) if the C(AuthorityKeyIdentifier) extension is not present.
|
|
returned: success and if the pyOpenSSL backend is I(not) used
|
|
type: str
|
|
sample: '00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33'
|
|
version_added: "2.9"
|
|
authority_cert_issuer:
|
|
description:
|
|
- The certificate's authority cert issuer as a list of general names.
|
|
- Is C(none) if the C(AuthorityKeyIdentifier) extension is not present.
|
|
returned: success and if the pyOpenSSL backend is I(not) used
|
|
type: list
|
|
elements: str
|
|
sample: "[DNS:www.ansible.com, IP:1.2.3.4]"
|
|
version_added: "2.9"
|
|
authority_cert_serial_number:
|
|
description:
|
|
- The certificate's authority cert serial number.
|
|
- Is C(none) if the C(AuthorityKeyIdentifier) extension is not present.
|
|
returned: success and if the pyOpenSSL backend is I(not) used
|
|
type: int
|
|
sample: '12345'
|
|
version_added: "2.9"
|
|
ocsp_uri:
|
|
description: The OCSP responder URI, if included in the certificate. Will be
|
|
C(none) if no OCSP responder URI is included.
|
|
returned: success
|
|
type: str
|
|
version_added: "2.9"
|
|
'''
|
|
|
|
|
|
import abc
|
|
import binascii
|
|
import datetime
|
|
import os
|
|
import re
|
|
import traceback
|
|
from distutils.version import LooseVersion
|
|
|
|
from ansible.module_utils import crypto as crypto_utils
|
|
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
|
from ansible.module_utils.six import string_types
|
|
from ansible.module_utils._text import to_native, to_text, to_bytes
|
|
from ansible.module_utils.compat import ipaddress as compat_ipaddress
|
|
|
|
MINIMAL_CRYPTOGRAPHY_VERSION = '1.6'
|
|
MINIMAL_PYOPENSSL_VERSION = '0.15'
|
|
|
|
PYOPENSSL_IMP_ERR = None
|
|
try:
|
|
import OpenSSL
|
|
from OpenSSL import crypto
|
|
PYOPENSSL_VERSION = LooseVersion(OpenSSL.__version__)
|
|
if OpenSSL.SSL.OPENSSL_VERSION_NUMBER >= 0x10100000:
|
|
# OpenSSL 1.1.0 or newer
|
|
OPENSSL_MUST_STAPLE_NAME = b"tlsfeature"
|
|
OPENSSL_MUST_STAPLE_VALUE = b"status_request"
|
|
else:
|
|
# OpenSSL 1.0.x or older
|
|
OPENSSL_MUST_STAPLE_NAME = b"1.3.6.1.5.5.7.1.24"
|
|
OPENSSL_MUST_STAPLE_VALUE = b"DER:30:03:02:01:05"
|
|
except ImportError:
|
|
PYOPENSSL_IMP_ERR = traceback.format_exc()
|
|
PYOPENSSL_FOUND = False
|
|
else:
|
|
PYOPENSSL_FOUND = True
|
|
|
|
CRYPTOGRAPHY_IMP_ERR = None
|
|
try:
|
|
import cryptography
|
|
from cryptography import x509
|
|
from cryptography.hazmat.primitives import serialization
|
|
CRYPTOGRAPHY_VERSION = LooseVersion(cryptography.__version__)
|
|
except ImportError:
|
|
CRYPTOGRAPHY_IMP_ERR = traceback.format_exc()
|
|
CRYPTOGRAPHY_FOUND = False
|
|
else:
|
|
CRYPTOGRAPHY_FOUND = True
|
|
|
|
|
|
TIMESTAMP_FORMAT = "%Y%m%d%H%M%SZ"
|
|
|
|
|
|
class CertificateInfo(crypto_utils.OpenSSLObject):
|
|
def __init__(self, module, backend):
|
|
super(CertificateInfo, self).__init__(
|
|
module.params['path'] or '',
|
|
'present',
|
|
False,
|
|
module.check_mode,
|
|
)
|
|
self.backend = backend
|
|
self.module = module
|
|
self.content = module.params['content']
|
|
if self.content is not None:
|
|
self.content = self.content.encode('utf-8')
|
|
|
|
self.valid_at = module.params['valid_at']
|
|
if self.valid_at:
|
|
for k, v in self.valid_at.items():
|
|
if not isinstance(v, string_types):
|
|
self.module.fail_json(
|
|
msg='The value for valid_at.{0} must be of type string (got {1})'.format(k, type(v))
|
|
)
|
|
self.valid_at[k] = crypto_utils.get_relative_time_option(v, 'valid_at.{0}'.format(k))
|
|
|
|
def generate(self):
|
|
# Empty method because crypto_utils.OpenSSLObject wants this
|
|
pass
|
|
|
|
def dump(self):
|
|
# Empty method because crypto_utils.OpenSSLObject wants this
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_signature_algorithm(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_subject_ordered(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_issuer_ordered(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_version(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_key_usage(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_extended_key_usage(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_basic_constraints(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_ocsp_must_staple(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_subject_alt_name(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_not_before(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_not_after(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_public_key(self, binary):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_subject_key_identifier(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_authority_key_identifier(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_serial_number(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_all_extensions(self):
|
|
pass
|
|
|
|
@abc.abstractmethod
|
|
def _get_ocsp_uri(self):
|
|
pass
|
|
|
|
def get_info(self):
|
|
result = dict()
|
|
self.cert = crypto_utils.load_certificate(self.path, content=self.content, backend=self.backend)
|
|
|
|
result['signature_algorithm'] = self._get_signature_algorithm()
|
|
subject = self._get_subject_ordered()
|
|
issuer = self._get_issuer_ordered()
|
|
result['subject'] = dict()
|
|
for k, v in subject:
|
|
result['subject'][k] = v
|
|
result['subject_ordered'] = subject
|
|
result['issuer'] = dict()
|
|
for k, v in issuer:
|
|
result['issuer'][k] = v
|
|
result['issuer_ordered'] = issuer
|
|
result['version'] = self._get_version()
|
|
result['key_usage'], result['key_usage_critical'] = self._get_key_usage()
|
|
result['extended_key_usage'], result['extended_key_usage_critical'] = self._get_extended_key_usage()
|
|
result['basic_constraints'], result['basic_constraints_critical'] = self._get_basic_constraints()
|
|
result['ocsp_must_staple'], result['ocsp_must_staple_critical'] = self._get_ocsp_must_staple()
|
|
result['subject_alt_name'], result['subject_alt_name_critical'] = self._get_subject_alt_name()
|
|
|
|
not_before = self._get_not_before()
|
|
not_after = self._get_not_after()
|
|
result['not_before'] = not_before.strftime(TIMESTAMP_FORMAT)
|
|
result['not_after'] = not_after.strftime(TIMESTAMP_FORMAT)
|
|
result['expired'] = not_after < datetime.datetime.utcnow()
|
|
|
|
result['valid_at'] = dict()
|
|
if self.valid_at:
|
|
for k, v in self.valid_at.items():
|
|
result['valid_at'][k] = not_before <= v <= not_after
|
|
|
|
result['public_key'] = self._get_public_key(binary=False)
|
|
pk = self._get_public_key(binary=True)
|
|
result['public_key_fingerprints'] = crypto_utils.get_fingerprint_of_bytes(pk) if pk is not None else dict()
|
|
|
|
if self.backend != 'pyopenssl':
|
|
ski = self._get_subject_key_identifier()
|
|
if ski is not None:
|
|
ski = to_native(binascii.hexlify(ski))
|
|
ski = ':'.join([ski[i:i + 2] for i in range(0, len(ski), 2)])
|
|
result['subject_key_identifier'] = ski
|
|
|
|
aki, aci, acsn = self._get_authority_key_identifier()
|
|
if aki is not None:
|
|
aki = to_native(binascii.hexlify(aki))
|
|
aki = ':'.join([aki[i:i + 2] for i in range(0, len(aki), 2)])
|
|
result['authority_key_identifier'] = aki
|
|
result['authority_cert_issuer'] = aci
|
|
result['authority_cert_serial_number'] = acsn
|
|
|
|
result['serial_number'] = self._get_serial_number()
|
|
result['extensions_by_oid'] = self._get_all_extensions()
|
|
result['ocsp_uri'] = self._get_ocsp_uri()
|
|
|
|
return result
|
|
|
|
|
|
class CertificateInfoCryptography(CertificateInfo):
|
|
"""Validate the supplied cert, using the cryptography backend"""
|
|
def __init__(self, module):
|
|
super(CertificateInfoCryptography, self).__init__(module, 'cryptography')
|
|
|
|
def _get_signature_algorithm(self):
|
|
return crypto_utils.cryptography_oid_to_name(self.cert.signature_algorithm_oid)
|
|
|
|
def _get_subject_ordered(self):
|
|
result = []
|
|
for attribute in self.cert.subject:
|
|
result.append([crypto_utils.cryptography_oid_to_name(attribute.oid), attribute.value])
|
|
return result
|
|
|
|
def _get_issuer_ordered(self):
|
|
result = []
|
|
for attribute in self.cert.issuer:
|
|
result.append([crypto_utils.cryptography_oid_to_name(attribute.oid), attribute.value])
|
|
return result
|
|
|
|
def _get_version(self):
|
|
if self.cert.version == x509.Version.v1:
|
|
return 1
|
|
if self.cert.version == x509.Version.v3:
|
|
return 3
|
|
return "unknown"
|
|
|
|
def _get_key_usage(self):
|
|
try:
|
|
current_key_ext = self.cert.extensions.get_extension_for_class(x509.KeyUsage)
|
|
current_key_usage = current_key_ext.value
|
|
key_usage = dict(
|
|
digital_signature=current_key_usage.digital_signature,
|
|
content_commitment=current_key_usage.content_commitment,
|
|
key_encipherment=current_key_usage.key_encipherment,
|
|
data_encipherment=current_key_usage.data_encipherment,
|
|
key_agreement=current_key_usage.key_agreement,
|
|
key_cert_sign=current_key_usage.key_cert_sign,
|
|
crl_sign=current_key_usage.crl_sign,
|
|
encipher_only=False,
|
|
decipher_only=False,
|
|
)
|
|
if key_usage['key_agreement']:
|
|
key_usage.update(dict(
|
|
encipher_only=current_key_usage.encipher_only,
|
|
decipher_only=current_key_usage.decipher_only
|
|
))
|
|
|
|
key_usage_names = dict(
|
|
digital_signature='Digital Signature',
|
|
content_commitment='Non Repudiation',
|
|
key_encipherment='Key Encipherment',
|
|
data_encipherment='Data Encipherment',
|
|
key_agreement='Key Agreement',
|
|
key_cert_sign='Certificate Sign',
|
|
crl_sign='CRL Sign',
|
|
encipher_only='Encipher Only',
|
|
decipher_only='Decipher Only',
|
|
)
|
|
return sorted([
|
|
key_usage_names[name] for name, value in key_usage.items() if value
|
|
]), current_key_ext.critical
|
|
except cryptography.x509.ExtensionNotFound:
|
|
return None, False
|
|
|
|
def _get_extended_key_usage(self):
|
|
try:
|
|
ext_keyusage_ext = self.cert.extensions.get_extension_for_class(x509.ExtendedKeyUsage)
|
|
return sorted([
|
|
crypto_utils.cryptography_oid_to_name(eku) for eku in ext_keyusage_ext.value
|
|
]), ext_keyusage_ext.critical
|
|
except cryptography.x509.ExtensionNotFound:
|
|
return None, False
|
|
|
|
def _get_basic_constraints(self):
|
|
try:
|
|
ext_keyusage_ext = self.cert.extensions.get_extension_for_class(x509.BasicConstraints)
|
|
result = []
|
|
result.append('CA:{0}'.format('TRUE' if ext_keyusage_ext.value.ca else 'FALSE'))
|
|
if ext_keyusage_ext.value.path_length is not None:
|
|
result.append('pathlen:{0}'.format(ext_keyusage_ext.value.path_length))
|
|
return sorted(result), ext_keyusage_ext.critical
|
|
except cryptography.x509.ExtensionNotFound:
|
|
return None, False
|
|
|
|
def _get_ocsp_must_staple(self):
|
|
try:
|
|
try:
|
|
# This only works with cryptography >= 2.1
|
|
tlsfeature_ext = self.cert.extensions.get_extension_for_class(x509.TLSFeature)
|
|
value = cryptography.x509.TLSFeatureType.status_request in tlsfeature_ext.value
|
|
except AttributeError as dummy:
|
|
# Fallback for cryptography < 2.1
|
|
oid = x509.oid.ObjectIdentifier("1.3.6.1.5.5.7.1.24")
|
|
tlsfeature_ext = self.cert.extensions.get_extension_for_oid(oid)
|
|
value = tlsfeature_ext.value.value == b"\x30\x03\x02\x01\x05"
|
|
return value, tlsfeature_ext.critical
|
|
except cryptography.x509.ExtensionNotFound:
|
|
return None, False
|
|
|
|
def _get_subject_alt_name(self):
|
|
try:
|
|
san_ext = self.cert.extensions.get_extension_for_class(x509.SubjectAlternativeName)
|
|
result = [crypto_utils.cryptography_decode_name(san) for san in san_ext.value]
|
|
return result, san_ext.critical
|
|
except cryptography.x509.ExtensionNotFound:
|
|
return None, False
|
|
|
|
def _get_not_before(self):
|
|
return self.cert.not_valid_before
|
|
|
|
def _get_not_after(self):
|
|
return self.cert.not_valid_after
|
|
|
|
def _get_public_key(self, binary):
|
|
return self.cert.public_key().public_bytes(
|
|
serialization.Encoding.DER if binary else serialization.Encoding.PEM,
|
|
serialization.PublicFormat.SubjectPublicKeyInfo
|
|
)
|
|
|
|
def _get_subject_key_identifier(self):
|
|
try:
|
|
ext = self.cert.extensions.get_extension_for_class(x509.SubjectKeyIdentifier)
|
|
return ext.value.digest
|
|
except cryptography.x509.ExtensionNotFound:
|
|
return None
|
|
|
|
def _get_authority_key_identifier(self):
|
|
try:
|
|
ext = self.cert.extensions.get_extension_for_class(x509.AuthorityKeyIdentifier)
|
|
issuer = None
|
|
if ext.value.authority_cert_issuer is not None:
|
|
issuer = [crypto_utils.cryptography_decode_name(san) for san in ext.value.authority_cert_issuer]
|
|
return ext.value.key_identifier, issuer, ext.value.authority_cert_serial_number
|
|
except cryptography.x509.ExtensionNotFound:
|
|
return None, None, None
|
|
|
|
def _get_serial_number(self):
|
|
return self.cert.serial_number
|
|
|
|
def _get_all_extensions(self):
|
|
return crypto_utils.cryptography_get_extensions_from_cert(self.cert)
|
|
|
|
def _get_ocsp_uri(self):
|
|
try:
|
|
ext = self.cert.extensions.get_extension_for_class(x509.AuthorityInformationAccess)
|
|
for desc in ext.value:
|
|
if desc.access_method == x509.oid.AuthorityInformationAccessOID.OCSP:
|
|
if isinstance(desc.access_location, x509.UniformResourceIdentifier):
|
|
return desc.access_location.value
|
|
except x509.ExtensionNotFound as dummy:
|
|
pass
|
|
return None
|
|
|
|
|
|
class CertificateInfoPyOpenSSL(CertificateInfo):
|
|
"""validate the supplied certificate."""
|
|
|
|
def __init__(self, module):
|
|
super(CertificateInfoPyOpenSSL, self).__init__(module, 'pyopenssl')
|
|
|
|
def _get_signature_algorithm(self):
|
|
return to_text(self.cert.get_signature_algorithm())
|
|
|
|
def __get_name(self, name):
|
|
result = []
|
|
for sub in name.get_components():
|
|
result.append([crypto_utils.pyopenssl_normalize_name(sub[0]), to_text(sub[1])])
|
|
return result
|
|
|
|
def _get_subject_ordered(self):
|
|
return self.__get_name(self.cert.get_subject())
|
|
|
|
def _get_issuer_ordered(self):
|
|
return self.__get_name(self.cert.get_issuer())
|
|
|
|
def _get_version(self):
|
|
# Version numbers in certs are off by one:
|
|
# v1: 0, v2: 1, v3: 2 ...
|
|
return self.cert.get_version() + 1
|
|
|
|
def _get_extension(self, short_name):
|
|
for extension_idx in range(0, self.cert.get_extension_count()):
|
|
extension = self.cert.get_extension(extension_idx)
|
|
if extension.get_short_name() == short_name:
|
|
result = [
|
|
crypto_utils.pyopenssl_normalize_name(usage.strip()) for usage in to_text(extension, errors='surrogate_or_strict').split(',')
|
|
]
|
|
return sorted(result), bool(extension.get_critical())
|
|
return None, False
|
|
|
|
def _get_key_usage(self):
|
|
return self._get_extension(b'keyUsage')
|
|
|
|
def _get_extended_key_usage(self):
|
|
return self._get_extension(b'extendedKeyUsage')
|
|
|
|
def _get_basic_constraints(self):
|
|
return self._get_extension(b'basicConstraints')
|
|
|
|
def _get_ocsp_must_staple(self):
|
|
extensions = [self.cert.get_extension(i) for i in range(0, self.cert.get_extension_count())]
|
|
oms_ext = [
|
|
ext for ext in extensions
|
|
if to_bytes(ext.get_short_name()) == OPENSSL_MUST_STAPLE_NAME and to_bytes(ext) == OPENSSL_MUST_STAPLE_VALUE
|
|
]
|
|
if OpenSSL.SSL.OPENSSL_VERSION_NUMBER < 0x10100000:
|
|
# Older versions of libssl don't know about OCSP Must Staple
|
|
oms_ext.extend([ext for ext in extensions if ext.get_short_name() == b'UNDEF' and ext.get_data() == b'\x30\x03\x02\x01\x05'])
|
|
if oms_ext:
|
|
return True, bool(oms_ext[0].get_critical())
|
|
else:
|
|
return None, False
|
|
|
|
def _normalize_san(self, san):
|
|
if san.startswith('IP Address:'):
|
|
san = 'IP:' + san[len('IP Address:'):]
|
|
if san.startswith('IP:'):
|
|
ip = compat_ipaddress.ip_address(san[3:])
|
|
san = 'IP:{0}'.format(ip.compressed)
|
|
return san
|
|
|
|
def _get_subject_alt_name(self):
|
|
for extension_idx in range(0, self.cert.get_extension_count()):
|
|
extension = self.cert.get_extension(extension_idx)
|
|
if extension.get_short_name() == b'subjectAltName':
|
|
result = [self._normalize_san(altname.strip()) for altname in
|
|
to_text(extension, errors='surrogate_or_strict').split(', ')]
|
|
return result, bool(extension.get_critical())
|
|
return None, False
|
|
|
|
def _get_not_before(self):
|
|
time_string = to_native(self.cert.get_notBefore())
|
|
return datetime.datetime.strptime(time_string, "%Y%m%d%H%M%SZ")
|
|
|
|
def _get_not_after(self):
|
|
time_string = to_native(self.cert.get_notAfter())
|
|
return datetime.datetime.strptime(time_string, "%Y%m%d%H%M%SZ")
|
|
|
|
def _get_public_key(self, binary):
|
|
try:
|
|
return crypto.dump_publickey(
|
|
crypto.FILETYPE_ASN1 if binary else crypto.FILETYPE_PEM,
|
|
self.cert.get_pubkey()
|
|
)
|
|
except AttributeError:
|
|
try:
|
|
# pyOpenSSL < 16.0:
|
|
bio = crypto._new_mem_buf()
|
|
if binary:
|
|
rc = crypto._lib.i2d_PUBKEY_bio(bio, self.cert.get_pubkey()._pkey)
|
|
else:
|
|
rc = crypto._lib.PEM_write_bio_PUBKEY(bio, self.cert.get_pubkey()._pkey)
|
|
if rc != 1:
|
|
crypto._raise_current_error()
|
|
return crypto._bio_to_string(bio)
|
|
except AttributeError:
|
|
self.module.warn('Your pyOpenSSL version does not support dumping public keys. '
|
|
'Please upgrade to version 16.0 or newer, or use the cryptography backend.')
|
|
|
|
def _get_subject_key_identifier(self):
|
|
# Won't be implemented
|
|
return None
|
|
|
|
def _get_authority_key_identifier(self):
|
|
# Won't be implemented
|
|
return None, None, None
|
|
|
|
def _get_serial_number(self):
|
|
return self.cert.get_serial_number()
|
|
|
|
def _get_all_extensions(self):
|
|
return crypto_utils.pyopenssl_get_extensions_from_cert(self.cert)
|
|
|
|
def _get_ocsp_uri(self):
|
|
for i in range(self.cert.get_extension_count()):
|
|
ext = self.cert.get_extension(i)
|
|
if ext.get_short_name() == b'authorityInfoAccess':
|
|
v = str(ext)
|
|
m = re.search('^OCSP - URI:(.*)$', v, flags=re.MULTILINE)
|
|
if m:
|
|
return m.group(1)
|
|
return None
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec=dict(
|
|
path=dict(type='path'),
|
|
content=dict(type='str'),
|
|
valid_at=dict(type='dict'),
|
|
select_crypto_backend=dict(type='str', default='auto', choices=['auto', 'cryptography', 'pyopenssl']),
|
|
),
|
|
required_one_of=(
|
|
['path', 'content'],
|
|
),
|
|
mutually_exclusive=(
|
|
['path', 'content'],
|
|
),
|
|
supports_check_mode=True,
|
|
)
|
|
|
|
try:
|
|
if module.params['path'] is not None:
|
|
base_dir = os.path.dirname(module.params['path']) or '.'
|
|
if not os.path.isdir(base_dir):
|
|
module.fail_json(
|
|
name=base_dir,
|
|
msg='The directory %s does not exist or the file is not a directory' % base_dir
|
|
)
|
|
|
|
backend = module.params['select_crypto_backend']
|
|
if backend == 'auto':
|
|
# Detect what backend we can use
|
|
can_use_cryptography = CRYPTOGRAPHY_FOUND and CRYPTOGRAPHY_VERSION >= LooseVersion(MINIMAL_CRYPTOGRAPHY_VERSION)
|
|
can_use_pyopenssl = PYOPENSSL_FOUND and PYOPENSSL_VERSION >= LooseVersion(MINIMAL_PYOPENSSL_VERSION)
|
|
|
|
# If cryptography is available we'll use it
|
|
if can_use_cryptography:
|
|
backend = 'cryptography'
|
|
elif can_use_pyopenssl:
|
|
backend = 'pyopenssl'
|
|
|
|
# Fail if no backend has been found
|
|
if backend == 'auto':
|
|
module.fail_json(msg=("Can't detect any of the required Python libraries "
|
|
"cryptography (>= {0}) or PyOpenSSL (>= {1})").format(
|
|
MINIMAL_CRYPTOGRAPHY_VERSION,
|
|
MINIMAL_PYOPENSSL_VERSION))
|
|
|
|
if backend == 'pyopenssl':
|
|
if not PYOPENSSL_FOUND:
|
|
module.fail_json(msg=missing_required_lib('pyOpenSSL >= {0}'.format(MINIMAL_PYOPENSSL_VERSION)),
|
|
exception=PYOPENSSL_IMP_ERR)
|
|
try:
|
|
getattr(crypto.X509Req, 'get_extensions')
|
|
except AttributeError:
|
|
module.fail_json(msg='You need to have PyOpenSSL>=0.15')
|
|
|
|
module.deprecate('The module is using the PyOpenSSL backend. This backend has been deprecated',
|
|
version='2.13', collection_name='ansible.builtin')
|
|
certificate = CertificateInfoPyOpenSSL(module)
|
|
elif backend == 'cryptography':
|
|
if not CRYPTOGRAPHY_FOUND:
|
|
module.fail_json(msg=missing_required_lib('cryptography >= {0}'.format(MINIMAL_CRYPTOGRAPHY_VERSION)),
|
|
exception=CRYPTOGRAPHY_IMP_ERR)
|
|
certificate = CertificateInfoCryptography(module)
|
|
|
|
result = certificate.get_info()
|
|
module.exit_json(**result)
|
|
except crypto_utils.OpenSSLObjectError as exc:
|
|
module.fail_json(msg=to_native(exc))
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|