Files
napalm-bsd/napalm_bsd/accounts.py
T
Christian Manivong a16918245c
driver / lint (pull_request) Successful in 26s
driver / standard (pull_request) Successful in 29s
driver / types (pull_request) Successful in 1m9s
driver / test (3.13) (pull_request) Successful in 1m3s
driver / test (3.12) (pull_request) Successful in 1m11s
driver / lowest (pull_request) Successful in 36s
driver / build (pull_request) Successful in 43s
driver / security (pull_request) Successful in 1m27s
CI / driver (pull_request) Successful in 2m59s
driver / publish (pull_request) Skipped
feat(accounts): clear a password, replace and remove keys on FreeBSD
napalm-device-types 4.28.0 lets add_local_account remove the old keys
(replaces) and the password (clear_password), and adds
remove_local_account_keys. The key changes run through the mixin's own
key files as the person; the password goes with chpass -p '*', the
field pw useradd -w no writes, which sshd does not take for a lock.

See NetOrk/netork#2013
2026-11-04 11:47:26 +01:00

85 lines
3.3 KiB
Python

"""Personal accounts on a FreeBSD host, with pw(8) and chpass(1) (NetOrk/netork#1793).
napalm-device-types' ``LocalAccountsMixin`` runs the steps; this names the
commands. A locked account is ``pw lock``'s: ``*LOCKED*`` in front of the
password, which sshd refuses a key login too. getpwnam(3) shows the password
field to root only, so the lock is read as root; nothing but its prefix is
looked at.
An account whose password is removed (NetOrk/netork#2013) gets ``*`` as its
password field, as ``pw useradd -w no`` gives a new one: no hash matches it,
and sshd takes only ``*LOCKED*`` for a lock, so the key still logs in.
"""
from __future__ import annotations
import shlex
from napalm_device_types import LocalAccountsMixin
#: What ``pw lock`` puts in front of the password.
_LOCKED_PREFIX = "*LOCKED*"
#: The password field of an account that logs in with a key only: no hash matches it.
_KEY_ONLY = "*"
class FreeBSDLocalAccountsMixin(LocalAccountsMixin):
ACCOUNT_SHELL = "/bin/sh"
ACCOUNT_ADMIN_GROUPS = ("wheel",)
#: The sudo package's, which its default sudoers includes.
SUDOERS_DIR = "/usr/local/etc/sudoers.d"
ROOT_GROUP = "wheel"
def _account_create(self, name: str, password_hash: str | None) -> list[list[str]]:
# -w no: the password field is "*", no password login until one is set.
create = ["pw", "useradd", "-n", name, "-m", "-s", self.ACCOUNT_SHELL, "-w", "no"]
return [create, *self._set_password(name, password_hash)]
def _account_create_with_uid(self, name: str, uid: int) -> list[list[str]]:
return [
[
"pw",
"useradd",
"-n",
name,
"-u",
str(uid),
"-m",
"-s",
self.ACCOUNT_SHELL,
"-w",
"no",
]
]
def _account_open(
self, name: str, password_hash: str | None, *, locked: bool
) -> list[list[str]]:
unlock = [["pw", "unlock", name]] if locked else []
return [*unlock, *self._set_password(name, password_hash)]
def _account_lock(self, name: str, *, locked: bool) -> list[list[str]]:
# pw refuses to lock a locked account again.
return [] if locked else [["pw", "lock", name]]
def _account_locked(self, name: str, passwd: list[str]) -> bool:
result = self.run_command(
shlex.join(["getent", "passwd", name]), privileged=True, timeout=30
)
fields = result.stdout.strip().split(":")
if result.exit_code != 0 or len(fields) < 7 or fields[0] != name:
reason = (result.stderr or result.stdout).strip() or f"exit {result.exit_code}"
raise RuntimeError(f"cannot read whether {name} is locked: {reason}")
return fields[1].startswith(_LOCKED_PREFIX)
def _account_leave_group(self, name: str, group: str, groups: list[str]) -> list[str]:
return ["pw", "groupmod", group, "-d", name]
def _account_clear_password(self, name: str) -> list[list[str]]:
return [["chpass", "-p", _KEY_ONLY, name]]
@staticmethod
def _set_password(name: str, password_hash: str | None) -> list[list[str]]:
"""chpass takes the crypt(3) string itself from root."""
return [["chpass", "-p", password_hash, name]] if password_hash else []