Try SpotterGenerate OpenSSH private and public keys.
| "added in version" 2.8 of ansible.builtin"
Authors: David Kainz (@lolcube)
preview | supported by community
pipInstall with pip install ansible==2.9.27
This module allows one to (re)generate OpenSSH private and public keys. It uses ssh-keygen to generate keys. One can generate C(rsa), C(dsa), C(rsa1), C(ed25519) or C(ecdsa) private keys.
# Generate an OpenSSH keypair with the default values (4096 bits, rsa)
- openssh_keypair:
path: /tmp/id_ssh_rsa
# Generate an OpenSSH rsa keypair with a different size (2048 bits)
- openssh_keypair:
path: /tmp/id_ssh_rsa
size: 2048
# Force regenerate an OpenSSH keypair if it already exists
- openssh_keypair:
path: /tmp/id_ssh_rsa
force: True
# Generate an OpenSSH keypair with a different algorithm (dsa)
- openssh_keypair:
path: /tmp/id_ssh_dsa
type: dsa
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:
- Name of the files containing the public and private key. The file containing the
public key will have the extension C(.pub).
required: true
type: path
size:
description:
- 'Specifies the number of bits in the private key to create. For RSA keys, the minimum
size is 1024 bits and the default is 4096 bits. Generally, 2048 bits is considered
sufficient. DSA keys must be exactly 1024 bits as specified by FIPS 186-2. For
ECDSA keys, size determines the key length by selecting from one of three elliptic
curve sizes: 256, 384 or 521 bits. Attempting to use bit lengths other than these
three values for ECDSA keys will cause this module to fail. Ed25519 keys have a
fixed length and the size will be ignored.'
type: int
type:
choices:
- rsa
- dsa
- rsa1
- ecdsa
- ed25519
default: rsa
description:
- The algorithm used to generate the SSH private key. C(rsa1) is for protocol version
1. C(rsa1) is deprecated and may not be supported by every version of ssh-keygen.
type: str
force:
default: false
description:
- Should the key be regenerated 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 private and public keys 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
comment:
description:
- Provides a new comment to the public key. When checking if the key is in the correct
state this will be ignored.
type: str
version_added: '2.9'
version_added_collection: ansible.builtin
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
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
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
comment: description: The comment of the generated key returned: changed or success sample: test@comment type: str filename: description: Path to the generated SSH private key file returned: changed or success sample: /tmp/id_ssh_rsa type: str fingerprint: description: The fingerprint of the key. returned: changed or success sample: SHA256:r4YCZxihVjedH2OlfjVGI6Y5xAYtdCwk8VxKyzVyYfM type: str public_key: description: The public key of the generated SSH private key returned: changed or success sample: ssh-rsa AAAAB3Nza(...omitted...)veL4E3Xcw== test_key type: str size: description: Size (in bits) of the SSH private key returned: changed or success sample: 4096 type: int type: description: Algorithm used to generate the SSH private key returned: changed or success sample: rsa type: str