community.crypto.openssl_csr_pipe – Generate OpenSSL Certificate Signing Request (CSR)¶
Note
This plugin is part of the community.crypto collection (version 1.6.1).
To install it use: ansible-galaxy collection install community.crypto
.
To use it in a playbook, specify: community.crypto.openssl_csr_pipe
.
New in version 1.3.0: of community.crypto
Synopsis¶
Please note that the module regenerates an existing CSR if it doesn’t match the module’s options, or if it seems to be corrupt.
The module can use the cryptography Python library, or the pyOpenSSL Python library. By default, it tries to detect which one is available. This can be overridden with the select_crypto_backend option. Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in community.crypto 2.0.0.
This module allows one to (re)generate OpenSSL certificate signing requests.
This module supports the subjectAltName, keyUsage, extendedKeyUsage, basicConstraints and OCSP Must Staple extensions.
Requirements¶
The below requirements are needed on the host that executes this module.
Either cryptography >= 1.3
Or pyOpenSSL >= 0.15
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
authority_cert_issuer
list
/ elements=string
|
Names that will be present in the authority cert issuer field of the certificate signing request.
Values must be prefixed by their options. (i.e.,
email , URI , DNS , RID , IP , dirName , otherName and the ones specific to your CA)Example:
DNS:ca.example.org If specified, authority_key_identifier must also be specified.
Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.
Note that this is only supported if the
cryptography backend is used!The
AuthorityKeyIdentifier will only be added if at least one of authority_key_identifier, authority_cert_issuer and authority_cert_serial_number is specified. |
||
authority_cert_serial_number
integer
|
The authority cert serial number.
Note that this is only supported if the
cryptography backend is used!Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.
The
AuthorityKeyIdentifier will only be added if at least one of authority_key_identifier, authority_cert_issuer and authority_cert_serial_number is specified. |
||
authority_key_identifier
string
|
The authority key identifier as a hex string, where two bytes are separated by colons.
Example:
00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33 If specified, authority_cert_issuer must also be specified.
Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.
Note that this is only supported if the
cryptography backend is used!The
AuthorityKeyIdentifier will only be added if at least one of authority_key_identifier, authority_cert_issuer and authority_cert_serial_number is specified. |
||
basic_constraints
list
/ elements=string
|
Indicates basic constraints, such as if the certificate is a CA.
aliases: basicConstraints |
||
basic_constraints_critical
boolean
|
|
Should the basicConstraints extension be considered as critical.
aliases: basicConstraints_critical |
|
common_name
string
|
The commonName field of the certificate signing request subject.
aliases: CN, commonName |
||
content
string
|
The existing CSR.
|
||
country_name
string
|
The countryName field of the certificate signing request subject.
aliases: C, countryName |
||
create_subject_key_identifier
boolean
|
|
Create the Subject Key Identifier from the public key.
Please note that commercial CAs can ignore the value, respectively use a value of their own choice instead. Specifying this option is mostly useful for self-signed certificates or for own CAs.
Note that this is only supported if the
cryptography backend is used! |
|
crl_distribution_points
list
/ elements=dictionary
added in 1.4.0 of community.crypto
|
Allows to specify one or multiple CRL distribution points.
Only supported by the
cryptography backend. |
||
crl_issuer
list
/ elements=string
|
Information about the issuer of the CRL.
|
||
full_name
list
/ elements=string
|
Describes how the CRL can be retrieved.
Mutually exclusive with relative_name.
Example:
URI:https://ca.example.com/revocations.crl . |
||
reasons
list
/ elements=string
|
|
List of reasons that this distribution point can be used for when performing revocation checks.
|
|
relative_name
list
/ elements=string
|
Describes how the CRL can be retrieved relative to the CRL issuer.
Mutually exclusive with full_name.
Example:
/CN=example.com .Can only be used when cryptography >= 1.6 is installed.
|
||
digest
string
|
Default: "sha256"
|
The digest used when signing the certificate signing request with the private key.
|
|
email_address
string
|
The emailAddress field of the certificate signing request subject.
aliases: E, emailAddress |
||
extended_key_usage
list
/ elements=string
|
Additional restrictions (e.g. client authentication, server authentication) on the allowed purposes for which the public key may be used.
aliases: extKeyUsage, extendedKeyUsage |
||
extended_key_usage_critical
boolean
|
|
Should the extkeyUsage extension be considered as critical.
aliases: extKeyUsage_critical, extendedKeyUsage_critical |
|
key_usage
list
/ elements=string
|
This defines the purpose (e.g. encipherment, signature, certificate signing) of the key contained in the certificate.
aliases: keyUsage |
||
key_usage_critical
boolean
|
|
Should the keyUsage extension be considered as critical.
aliases: keyUsage_critical |
|
locality_name
string
|
The localityName field of the certificate signing request subject.
aliases: L, localityName |
||
name_constraints_critical
boolean
|
|
Should the Name Constraints extension be considered as critical.
|
|
name_constraints_excluded
list
/ elements=string
|
For CA certificates, this specifies a list of identifiers which describe subtrees of names that this CA is not allowed to issue certificates for.
Values must be prefixed by their options. (i.e.,
email , URI , DNS , RID , IP , dirName , otherName and the ones specific to your CA). |
||
name_constraints_permitted
list
/ elements=string
|
For CA certificates, this specifies a list of identifiers which describe subtrees of names that this CA is allowed to issue certificates for.
Values must be prefixed by their options. (i.e.,
email , URI , DNS , RID , IP , dirName , otherName and the ones specific to your CA). |
||
ocsp_must_staple
boolean
|
|
Indicates that the certificate should contain the OCSP Must Staple extension (https://tools.ietf.org/html/rfc7633).
aliases: ocspMustStaple |
|
ocsp_must_staple_critical
boolean
|
|
Should the OCSP Must Staple extension be considered as critical.
Note that according to the RFC, this extension should not be marked as critical, as old clients not knowing about OCSP Must Staple are required to reject such certificates (see https://tools.ietf.org/html/rfc7633#section-4).
aliases: ocspMustStaple_critical |
|
organization_name
string
|
The organizationName field of the certificate signing request subject.
aliases: O, organizationName |
||
organizational_unit_name
string
|
The organizationalUnitName field of the certificate signing request subject.
aliases: OU, organizationalUnitName |
||
privatekey_content
string
|
The content of the private key to use when signing the certificate signing request.
Either privatekey_path or privatekey_content must be specified if state is
present , but not both. |
||
privatekey_passphrase
string
|
The passphrase for the private key.
This is required if the private key is password protected.
|
||
privatekey_path
path
|
The path to the private key to use when signing the certificate signing request.
Either privatekey_path or privatekey_content must be specified if state is
present , but not both. |
||
select_crypto_backend
string
|
|
Determines which crypto backend to use.
The default choice is
auto , which tries to use cryptography if available, and falls back to pyopenssl .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
pyopenssl backend has been deprecated in Ansible 2.9, and will be removed in community.crypto 2.0.0. From that point on, only the cryptography backend will be available. |
|
state_or_province_name
string
|
The stateOrProvinceName field of the certificate signing request subject.
aliases: ST, stateOrProvinceName |
||
subject
dictionary
|
Key/value pairs that will be present in the subject name field of the certificate signing request.
If you need to specify more than one value with the same key, use a list as value.
|
||
subject_alt_name
list
/ elements=string
|
Subject Alternative Name (SAN) extension to attach to the certificate signing request.
This can either be a 'comma separated string' or a YAML list.
Values must be prefixed by their options. (i.e.,
email , URI , DNS , RID , IP , dirName , otherName and the ones specific to your CA).Note that if no SAN is specified, but a common name, the common name will be added as a SAN except if
useCommonNameForSAN is set to false.aliases: subjectAltName |
||
subject_alt_name_critical
boolean
|
|
Should the subjectAltName extension be considered as critical.
aliases: subjectAltName_critical |
|
subject_key_identifier
string
|
The subject key identifier as a hex string, where two bytes are separated by colons.
Example:
00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33 Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.
Note that this option can only be used if create_subject_key_identifier is
no .Note that this is only supported if the
cryptography backend is used! |
||
use_common_name_for_san
boolean
|
|
If set to
yes , the module will fill the common name in for subject_alt_name with DNS: prefix if no SAN is specified.aliases: useCommonNameForSAN |
|
version
integer
|
Default: 1
|
The version of the certificate signing request.
The only allowed value according to RFC 2986 is 1.
This option will no longer accept unsupported values from community.crypto 2.0.0 on.
|
Notes¶
Note
If the certificate signing request already exists it will be checked whether subjectAltName, keyUsage, extendedKeyUsage and basicConstraints only contain the requested values, whether OCSP Must Staple is as requested, and if the request was signed by the given private key.
See Also¶
See also
- community.crypto.openssl_csr
The official documentation on the community.crypto.openssl_csr module.
- community.crypto.x509_certificate
The official documentation on the community.crypto.x509_certificate module.
- community.crypto.x509_certificate_pipe
The official documentation on the community.crypto.x509_certificate_pipe module.
- community.crypto.openssl_dhparam
The official documentation on the community.crypto.openssl_dhparam module.
- community.crypto.openssl_pkcs12
The official documentation on the community.crypto.openssl_pkcs12 module.
- community.crypto.openssl_privatekey
The official documentation on the community.crypto.openssl_privatekey module.
- community.crypto.openssl_privatekey_pipe
The official documentation on the community.crypto.openssl_privatekey_pipe module.
- community.crypto.openssl_publickey
The official documentation on the community.crypto.openssl_publickey module.
- community.crypto.openssl_csr_info
The official documentation on the community.crypto.openssl_csr_info module.
Examples¶
- name: Generate an OpenSSL Certificate Signing Request
community.crypto.openssl_csr_pipe:
privatekey_path: /etc/ssl/private/ansible.com.pem
common_name: www.ansible.com
register: result
- debug:
var: result.csr
- name: Generate an OpenSSL Certificate Signing Request with an inline CSR
community.crypto.openssl_csr:
content: "{{ lookup('file', '/etc/ssl/csr/www.ansible.com.csr') }}"
privatekey_content: "{{ private_key_content }}"
common_name: www.ansible.com
register: result
- name: Store CSR
ansible.builtin.copy:
dest: /etc/ssl/csr/www.ansible.com.csr
content: "{{ result.csr }}"
when: result is changed
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Yanis Guenane (@Spredzy)
Felix Fontein (@felixfontein)