community.crypto.openssh_cert – Generate OpenSSH host or user certificates.
Note
This plugin is part of the community.crypto collection (version 1.9.8).
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.openssh_cert.
Parameters
Parameter |
Comments |
|---|---|
The attributes the resulting file or directory should have. To get supported flags look at the man page for chattr on the target system. This string should contain the attributes in the same order as the one displayed by lsattr. The |
|
Should the certificate be regenerated even if it already exists and is valid. Equivalent to regenerate=always. Choices:
|
|
Name of the group that should own the file/directory, as would be fed to chown. |
|
Specify the key identity when signing a public key. The identifier that is logged by the server when the certificate is used for authentication. |
|
The permissions the resulting file or directory should have. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either add a leading zero so that Ansible’s YAML parser knows it is an octal number (like Giving Ansible a number without following one 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, If If Specifying |
|
Specify certificate options when signing a key. The option that are valid for user certificates are:
At present, no options are valid for host keys. |
|
Name of the user that should own the file/directory, as would be fed to chown. |
|
Path of the file containing the certificate. |
|
To use a signing key that resides on a PKCS#11 token, set this to the name (or full path) of the shared library to use with the token. Usually If this is set, signing_key needs to point to a file containing the public key of the CA. |
|
Certificates may be limited to be valid for a set of principal (user/host) names. By default, generated certificates are valid for all users or hosts. |
|
The path to the public key that will be signed with the signing key in order to generate the certificate. Required if state is |
|
When When When When
Choices:
|
|
The level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the When set to |
|
Specify the certificate serial number. The serial number is logged by the server when the certificate is used for authentication. The certificate serial number may be used in a KeyRevocationList. The serial number may be omitted for checks, but must be specified again for a new certificate. Note: The default value set by ssh-keygen is 0. |
|
The role part of the SELinux file context. When set to |
|
The type part of the SELinux file context. When set to |
|
The user part of the SELinux file context. By default it uses the When set to |
|
As of OpenSSH 8.2 the SHA-1 signature algorithm for RSA keys has been disabled and Using any value for this option with a non-RSA signing_key will cause this module to fail. Note: OpenSSH versions prior to 7.2 do not support SHA-2 signature algorithms for RSA keys and OpenSSH versions prior to 7.3 do not support SHA-2 signature algorithms for certificates. See https://www.openssh.com/txt/release-8.2 for more information. Choices:
|
|
The path to the private openssh key that is used for signing the public key in order to generate the certificate. If the private key is on a PKCS#11 token (pkcs11_provider), set this to the path to the public key instead. Required if state is |
|
Whether the host or user certificate should exist or not, taking action if the state is different from what is stated. Choices:
|
|
Whether the module should generate a host or a user certificate. Required if state is Choices:
|
|
Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file. By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted files, 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 files 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. Choices:
|
|
Should the ssh-keygen use a CA key residing in a ssh-agent. Choices:
|
|
Check if the certificate is valid at a certain point in time. If it is not the certificate will be regenerated. Time will always be interpreted as UTC. Mainly to be used with relative timespec for valid_from and / or valid_to. Note that if using relative time this module is NOT idempotent. |
|
The point in time the certificate is valid from. Time can be specified either as relative time or as absolute timestamp. Time will always be interpreted as UTC. Valid formats are: Required if state is |
|
The point in time the certificate is valid to. Time can be specified either as relative time or as absolute timestamp. Time will always be interpreted as UTC. Valid formats are: Required if state is |
Examples
- name: Generate an OpenSSH user certificate that is valid forever and for all users
community.crypto.openssh_cert:
type: user
signing_key: /path/to/private_key
public_key: /path/to/public_key.pub
path: /path/to/certificate
valid_from: always
valid_to: forever
# Generate an OpenSSH host certificate that is valid for 32 weeks from now and will be regenerated
# if it is valid for less than 2 weeks from the time the module is being run
- name: Generate an OpenSSH host certificate with valid_from, valid_to and valid_at parameters
community.crypto.openssh_cert:
type: host
signing_key: /path/to/private_key
public_key: /path/to/public_key.pub
path: /path/to/certificate
valid_from: +0s
valid_to: +32w
valid_at: +2w
- name: Generate an OpenSSH host certificate that is valid forever and only for example.com and examplehost
community.crypto.openssh_cert:
type: host
signing_key: /path/to/private_key
public_key: /path/to/public_key.pub
path: /path/to/certificate
valid_from: always
valid_to: forever
principals:
- example.com
- examplehost
- name: Generate an OpenSSH host Certificate that is valid from 21.1.2001 to 21.1.2019
community.crypto.openssh_cert:
type: host
signing_key: /path/to/private_key
public_key: /path/to/public_key.pub
path: /path/to/certificate
valid_from: "2001-01-21"
valid_to: "2019-01-21"
- name: Generate an OpenSSH user Certificate with clear and force-command option
community.crypto.openssh_cert:
type: user
signing_key: /path/to/private_key
public_key: /path/to/public_key.pub
path: /path/to/certificate
valid_from: always
valid_to: forever
options:
- "clear"
- "force-command=/tmp/bla/foo"
- name: Generate an OpenSSH user certificate using a PKCS#11 token
community.crypto.openssh_cert:
type: user
signing_key: /path/to/ca_public_key.pub
pkcs11_provider: libpkcs11.so
public_key: /path/to/public_key.pub
path: /path/to/certificate
valid_from: always
valid_to: forever
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
path to the certificate Returned: changed or success Sample: “/tmp/certificate-cert.pub” |
|
Information about the certificate. Output of Returned: change or success |
|
type of the certificate (host or user) Returned: changed or success Sample: “host” |
Authors
David Kainz (@lolcube)