User¶

Manage accounts, groups, authorized keys, and sudoers as root. sudoer grants all commands as any user; it does not run visudo. See Quickstart for account setup and sudo validation.

class rmote.tools.user.User[source]¶

Bases: Tool

Manage users, groups, SSH keys, and sudoers on the remote host. Requires root.

Creating or removing a user or a group runs the shadow utilities (useradd and its family), and a target without them refuses with NotImplementedError. sudoer and authorized_key only write files, so they work on any POSIX target.

Create a group and user in a disposable Debian container, then remove them:

>>> remote = getfixture("debian_tool")
>>> group = remote(User.group_present, "deployers")
>>> group.changed
True
>>> remote(User.group_present, "deployers").changed
False
>>> remote(User.present, "deploy", gid=group.gid, create_home=False).changed
True
>>> remote(User.present, "deploy", gid=group.gid, create_home=False).changed
False
>>> remote(User.absent, "deploy")
True
>>> remote(User.absent, "deploy")
False
>>> remote(User.group_absent, "deployers")
True

async static absent(name, *, remove_home=False)[source]¶

Ensure a user does not exist. Returns True if user was removed.

Parameters:

name (Text) – Username
remove_home (bool) – Also remove the user’s home directory

Return type:

bool

static authorized_key(name, key, *, exclusive=False)[source]¶

Ensure an SSH public key is present in ~/.ssh/authorized_keys.

Parameters:

name (Text) – Username
key (Text) – SSH public key string
exclusive (bool) – If True, replace the entire authorized_keys with only this key

Return type:

bool

Returns:

True if file was changed.

async static group_absent(name)[source]¶

Ensure a group does not exist. Returns True if group was removed.

Return type:: bool

async static group_present(name, *, gid=None, system=False)[source]¶

Ensure a group exists. Idempotent.

Return type:: GroupResult

async static present(name, *, uid=None, gid=None, comment='', home=None, shell='/bin/bash', groups=None, append_groups=True, system=False, create_home=True)[source]¶

Ensure a user exists with the given attributes. Idempotent.

Parameters:

name (Text) – Username
uid (getint | None) – Numeric UID (optional)
gid (getint | None) – Numeric primary GID (optional)
comment (Text) – GECOS field
home (Text | None) – Home directory path (default: /home/<name>)
shell (Text) – Login shell
groups (list[Text] | None) – Supplementary groups
append_groups (bool) – If True, add to groups without removing existing ones
system (bool) – Create as system user (no home, lower UID range)
create_home (bool) – Create home directory if it does not exist

Return type: