Try SpotterGenerate OpenSSH host or user certificates.
| "added in version" 2.8 of ansible.builtin"
Authors: David Kainz (@lolcube)
preview | supported by community
pipInstall with pip install ansible==2.9.27
Generate and regenerate OpenSSH host or user certificates.
# Generate an OpenSSH user certificate that is valid forever and for all users
- 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
- 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
# Generate an OpenSSH host certificate that is valid forever and only for example.com and examplehost
- 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
# Generate an OpenSSH host Certificate that is valid from 21.1.2001 to 21.1.2019
- 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"
# Generate an OpenSSH user Certificate with clear and force-command option:
- 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"
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:
- Path of the file containing the certificate.
required: true
type: path
type:
choices:
- host
- user
description:
- Whether the module should generate a host or a user certificate.
- Required if I(state) is C(present).
type: str
force:
default: false
description:
- Should the certificate be regenerated even if it already exists and is valid.
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 host or user certificate should exist or not, taking action if the state
is different from what is stated.
type: str
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
options:
description:
- 'Specify certificate options when signing a key. The option that are valid for user
certificates are:'
- 'C(clear): Clear all enabled permissions. This is useful for clearing the default
set of permissions so permissions may be added individually.'
- 'C(force-command=command): Forces the execution of command instead of any shell
or command specified by the user when the certificate is used for authentication.'
- 'C(no-agent-forwarding): Disable ssh-agent forwarding (permitted by default).'
- 'C(no-port-forwarding): Disable port forwarding (permitted by default).'
- 'C(no-pty Disable): PTY allocation (permitted by default).'
- 'C(no-user-rc): Disable execution of C(~/.ssh/rc) by sshd (permitted by default).'
- 'C(no-x11-forwarding): Disable X11 forwarding (permitted by default)'
- 'C(permit-agent-forwarding): Allows ssh-agent forwarding.'
- 'C(permit-port-forwarding): Allows port forwarding.'
- 'C(permit-pty): Allows PTY allocation.'
- 'C(permit-user-rc): Allows execution of C(~/.ssh/rc) by sshd.'
- 'C(permit-x11-forwarding): Allows X11 forwarding.'
- 'C(source-address=address_list): Restrict the source addresses from which the certificate
is considered valid. The C(address_list) is a comma-separated list of one or more
address/netmask pairs in CIDR format.'
- At present, no options are valid for host keys.
elements: str
type: list
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
valid_at:
description:
- 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 I(valid_from) and / or I(valid_to). Note that if using relative
time this module is NOT idempotent.
type: str
valid_to:
description:
- '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: C([+-]timespec | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS | YYYY-MM-DD
HH:MM:SS | forever) where timespec can be an integer + C([w | d | h | m | s]) (e.g.
C(+32w1d2h). Note that if using relative time this module is NOT idempotent.'
- Required if I(state) is C(present).
type: str
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
identifier:
description:
- Specify the key identity when signing a public key. The identifier that is logged
by the server when the certificate is used for authentication.
type: str
principals:
description:
- 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.
elements: str
type: list
public_key:
description:
- The path to the public key that will be signed with the signing key in order to
generate the certificate.
- Required if I(state) is C(present).
type: path
valid_from:
description:
- '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: C([+-]timespec | YYYY-MM-DD | YYYY-MM-DDTHH:MM:SS | YYYY-MM-DD
HH:MM:SS | always) where timespec can be an integer + C([w | d | h | m | s]) (e.g.
C(+32w1d2h). Note that if using relative time this module is NOT idempotent.'
- Required if I(state) is C(present).
type: str
signing_key:
description:
- The path to the private openssh key that is used for signing the public key in order
to generate the certificate.
- Required if I(state) is C(present).
type: path
serial_number:
description:
- '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.'
type: int
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
filename: description: path to the certificate returned: changed or success sample: /tmp/certificate-cert.pub type: str info: description: Information about the certificate. Output of C(ssh-keygen -L -f). elements: str returned: change or success type: list type: description: type of the certificate (host or user) returned: changed or success sample: host type: str