ansible / ansible.builtin / v2.6.17 / module / openssl_certificate Generate and/or check OpenSSL certificates | "added in version" 2.4 of ansible.builtin" Authors: Yanis Guenane (@Spredzy), Markus Teufelberger (@MarkusTeufelberger) preview | supported by communityansible.builtin.openssl_certificate (v2.6.17) — module
pip
Install with pip install ansible==2.6.17
This module allows one to (re)generate OpenSSL certificates. It implements a notion of provider (ie. C(selfsigned), C(acme), C(assertonly)) for your certificate. The 'assertonly' provider is intended for use cases where one is only interested in checking properties of a supplied certificate. Many properties that can be specified in this module are for validation of an existing or newly generated certificate. The proper place to specify them, if you want to receive a certificate with these properties is a CSR (Certificate Signing Request). It uses the pyOpenSSL python library to interact with OpenSSL.
- 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
- name: Generate a Let's Encrypt Certificate openssl_certificate: path: /etc/ssl/crt/ansible.com.crt csr_path: /etc/ssl/csr/ansible.com.csr provider: acme acme_accountkey_path: /etc/ssl/private/ansible.com.pem acme_challenge_path: /etc/ssl/challenges/ansible.com/
- name: Force (re-)generate a new Let's Encrypt Certificate openssl_certificate: path: /etc/ssl/crt/ansible.com.crt csr_path: /etc/ssl/csr/ansible.com.csr provider: acme acme_accountkey_path: /etc/ssl/private/ansible.com.pem acme_challenge_path: /etc/ssl/challenges/ansible.com/ force: True
# Examples for some checks one could use the assertonly provider for: # How to use the assertonly provider to implement and trigger your own custom certificate generation workflow: - name: Check if a certificate is currently still valid, ignoring failures openssl_certificate: path: /etc/ssl/crt/example.com.crt provider: assertonly has_expired: False ignore_errors: True register: validity_check
- name: Run custom task(s) to get a new, valid certificate in case the initial check failed command: superspecialSSL recreate /etc/ssl/crt/example.com.crt when: validity_check.failed
- name: Check the new certificate again for validity with the same parameters, this time failing the play if it is still invalid openssl_certificate: path: /etc/ssl/crt/example.com.crt provider: assertonly has_expired: False when: validity_check.failed
# Some other checks that assertonly could be used for: - name: Verify that an existing certificate was issued by the Let's Encrypt CA and is currently still valid openssl_certificate: path: /etc/ssl/crt/example.com.crt provider: assertonly issuer: O: Let's Encrypt has_expired: False
- name: Ensure that a certificate uses a modern signature algorithm (no SHA1, MD5 or DSA) openssl_certificate: path: /etc/ssl/crt/example.com.crt provider: assertonly signature_algorithms: - sha224WithRSAEncryption - sha256WithRSAEncryption - sha384WithRSAEncryption - sha512WithRSAEncryption - sha224WithECDSAEncryption - sha256WithECDSAEncryption - sha384WithECDSAEncryption - sha512WithECDSAEncryption
- name: Ensure that the existing certificate belongs to the specified private key openssl_certificate: path: /etc/ssl/crt/example.com.crt privatekey_path: /etc/ssl/private/example.com.pem provider: assertonly
- name: Ensure that the existing certificate is still valid at the winter solstice 2017 openssl_certificate: path: /etc/ssl/crt/example.com.crt provider: assertonly valid_at: 20171221162800Z
- name: Ensure that the existing certificate is still valid 2 weeks (1209600 seconds) from now openssl_certificate: path: /etc/ssl/crt/example.com.crt provider: assertonly valid_in: 1209600
- name: Ensure that the existing certificate is only used for digital signatures and encrypting other keys openssl_certificate: path: /etc/ssl/crt/example.com.crt provider: assertonly key_usage: - digitalSignature - keyEncipherment key_usage_strict: true
- name: Ensure that the existing certificate can be used for client authentication openssl_certificate: path: /etc/ssl/crt/example.com.crt provider: assertonly extended_key_usage: - clientAuth
- name: Ensure that the existing certificate can only be used for client authentication and time stamping openssl_certificate: path: /etc/ssl/crt/example.com.crt provider: assertonly extended_key_usage: - clientAuth - 1.3.6.1.5.5.7.3.8 extended_key_usage_strict: true
- name: Ensure that the existing certificate has a certain domain in its subjectAltName openssl_certificate: path: /etc/ssl/crt/example.com.crt provider: assertonly subject_alt_name: - www.example.com - test.example.com
mode: description: - The permissions the resulting filesystem object should have. - For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers. You must give Ansible enough information to parse them correctly. For consistent results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives a string and can do its own conversion from string into number. Adding a leading zero (for example, V(0755)) works sometimes, but can fail in loops and some other circumstances. - Giving Ansible a number without following either of these rules will end up with a decimal number which will have unexpected results. - As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx) or V(u=rw,g=r,o=r)). - If O(mode) is not specified and the destination filesystem object B(does not) exist, the default C(umask) on the system will be used when setting the mode for the newly created filesystem object. - If O(mode) is not specified and the destination filesystem object B(does) exist, the mode of the existing filesystem object will be used. - Specifying O(mode) is the best way to ensure filesystem objects are created with the correct permissions. See CVE-2020-1736 for further details. type: raw path: description: - Remote absolute path where the generated certificate file should be created or is already located. required: true force: default: false description: - Generate the certificate, even if it already exists. type: bool group: description: - Name of the group that should own the filesystem object, as would be fed to I(chown). - When left unspecified, it uses the current group of the current user unless you are root, in which case it can preserve the previous ownership. type: str owner: description: - Name of the user that should own the filesystem object, as would be fed to I(chown). - When left unspecified, it uses the current user unless you are root, in which case it can preserve the previous ownership. - Specifying a numeric username will be assumed to be a user ID and not a username. Avoid numeric usernames to avoid this confusion. type: str state: choices: - present - absent default: present description: - Whether the certificate should exist or not, taking action if the state is different from what is stated. issuer: description: - Key/value pairs that must be present in the issuer name field of the certificate. If you need to specify more than one value with the same key, use a list as value. serole: description: - The role part of the SELinux filesystem object context. - When set to V(_default), it will use the C(role) portion of the policy if available. type: str setype: description: - The type part of the SELinux filesystem object context. - When set to V(_default), it will use the C(type) portion of the policy if available. type: str seuser: description: - The user part of the SELinux filesystem object context. - By default it uses the V(system) policy, where applicable. - When set to V(_default), it will use the C(user) portion of the policy if available. type: str selevel: description: - The level part of the SELinux filesystem object context. - This is the MLS/MCS attribute, sometimes known as the C(range). - When set to V(_default), it will use the C(level) portion of the policy if available. type: str subject: description: - Key/value pairs that must be present in the subject name field of the certificate. If you need to specify more than one value with the same key, use a list as value. version: description: - Version of the certificate. Nowadays it should almost always be 3. csr_path: description: - Path to the Certificate Signing Request (CSR) used to generate this certificate. This is not required in C(assertonly) mode. provider: choices: - selfsigned - assertonly - acme description: - Name of the provider to use to generate/retrieve the OpenSSL certificate. The C(assertonly) provider will not generate files and fail if the certificate file is missing. required: true valid_at: description: - The certificate must be valid at this point in time. The timestamp is formatted as an ASN.1 TIME. valid_in: description: - The certificate must still be valid in I(valid_in) seconds from now. key_usage: aliases: - keyUsage description: - The I(key_usage) extension field must contain all these values. not_after: aliases: - notAfter description: - The certificate must expire at this point in time. The timestamp is formatted as an ASN.1 TIME. acme_chain: default: true description: - Include the intermediate certificate to the generated certificate version_added: '2.5' version_added_collection: ansible.builtin attributes: aliases: - attr description: - The attributes the resulting filesystem object should have. - To get supported flags look at the man page for I(chattr) on the target system. - This string should contain the attributes in the same order as the one displayed by I(lsattr). - The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string. type: str version_added: '2.3' version_added_collection: ansible.builtin invalid_at: description: - The certificate must be invalid at this point in time. The timestamp is formatted as an ASN.1 TIME. not_before: aliases: - notBefore description: - The certificate must start to become valid at this point in time. The timestamp is formatted as an ASN.1 TIME. has_expired: default: false description: - Checks if the certificate is expired/not expired at the time the module is executed. type: bool issuer_strict: default: false description: - If set to True, the I(issuer) field must contain only these values. type: bool version_added: '2.5' version_added_collection: ansible.builtin unsafe_writes: default: false description: - Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target filesystem object. - By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target filesystem objects, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted filesystem objects, which cannot be updated atomically from inside the container and can only be written in an unsafe manner. - This option allows Ansible to fall back to unsafe methods of updating filesystem objects when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes). - IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. type: bool version_added: '2.2' version_added_collection: ansible.builtin subject_strict: default: false description: - If set to True, the I(subject) field must contain only these values. type: bool version_added: '2.5' version_added_collection: ansible.builtin privatekey_path: description: - Path to the private key to use when signing the certificate. key_usage_strict: aliases: - keyUsage_strict default: false description: - If set to True, the I(key_usage) extension field must contain only these values. type: bool subject_alt_name: aliases: - subjectAltName description: - The I(subject_alt_name) extension field must contain these values. selfsigned_digest: default: sha256 description: - Digest algorithm to be used when self-signing the certificate extended_key_usage: aliases: - extendedKeyUsage description: - The I(extended_key_usage) extension field must contain all these values. selfsigned_version: default: 3 description: - Version of the C(selfsigned) certificate. Nowadays it should almost always be C(3). version_added: '2.5' version_added_collection: ansible.builtin acme_challenge_path: description: - Path to the ACME challenge directory that is served on U(http://<HOST>:80/.well-known/acme-challenge/) acme_accountkey_path: description: - Path to the accountkey for the C(acme) provider selfsigned_not_after: aliases: - selfsigned_notAfter description: - The timestamp at which the certificate stops being valid. The timestamp is formatted as an ASN.1 TIME. If this value is not specified, certificate will stop being valid 10 years from now. signature_algorithms: description: - list of algorithms that you would accept the certificate to be signed with (e.g. ['sha256WithRSAEncryption', 'sha512WithRSAEncryption']). privatekey_passphrase: description: - The passphrase for the I(privatekey_path). selfsigned_not_before: aliases: - selfsigned_notBefore description: - The timestamp at which the certificate starts being valid. The timestamp is formatted as an ASN.1 TIME. If this value is not specified, certificate will start being valid from now. subject_alt_name_strict: aliases: - subjectAltName_strict default: false description: - If set to True, the I(subject_alt_name) extension field must contain only these values. type: bool extended_key_usage_strict: aliases: - extendedKeyUsage_strict default: false description: - If set to True, the I(extended_key_usage) extension field must contain only these values. type: bool
filename: description: Path to the generated Certificate returned: changed or success sample: /etc/ssl/crt/www.ansible.com.crt type: string