Author SHA1 Message Date
christianmanivong 5c13ce1a8b Merge pull request 'chore(release): 0.17.0' (#70) from chore/release-0.17.0 into main
driver / lint (push) Successful in 16s
driver / test (3.13) (push) Successful in 1m6s
driver / lowest (push) Successful in 38s
driver / build (push) Successful in 30s
driver / security (push) Successful in 1m10s
driver / publish (push) Successful in 30s
driver / types (push) Successful in 1m7s
driver / standard (push) Successful in 20s
driver / test (3.12) (push) Successful in 1m13s
CI / driver (push) Successful in 3m31s
2026-11-04 11:19:01 +00:00
Christian Manivong 1c8b1b1c60 chore(release): 0.17.0
driver / build (pull_request) Successful in 32s
driver / security (pull_request) Successful in 1m12s
CI / driver (pull_request) Successful in 2m50s
driver / standard (pull_request) Successful in 18s
driver / types (pull_request) Successful in 1m10s
driver / test (3.12) (pull_request) Successful in 1m4s
driver / test (3.13) (pull_request) Successful in 1m10s
driver / lowest (pull_request) Successful in 35s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 16s
2026-11-04 12:14:00 +01:00
christianmanivong bd17fbd84d Merge pull request 'feat(accounts): clear a password, replace and remove keys' (#69) from fix/local-account-key-replace into main
driver / lint (push) Successful in 15s
driver / test (3.13) (push) Successful in 1m13s
driver / build (push) Successful in 32s
driver / security (push) Successful in 1m12s
driver / publish (push) Skipped
driver / types (push) Successful in 1m11s
driver / lowest (push) Successful in 36s
driver / standard (push) Successful in 19s
driver / test (3.12) (push) Successful in 1m25s
CI / driver (push) Successful in 2m44s
2026-11-04 11:13:54 +00:00
Christian Manivong d03fe2a2ba feat(accounts): clear a password, replace and remove keys
driver / build (pull_request) Successful in 30s
driver / security (pull_request) Successful in 1m6s
CI / driver (pull_request) Successful in 2m27s
driver / standard (pull_request) Successful in 19s
driver / types (pull_request) Successful in 1m9s
driver / test (3.13) (pull_request) Successful in 1m2s
driver / test (3.12) (pull_request) Successful in 1m11s
driver / lowest (pull_request) Successful in 32s
driver / lint (pull_request) Successful in 17s
driver / publish (pull_request) Skipped
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 usermod -p '*', which
leaves the expiry (the lock) alone and keeps the key login working with
and without PAM, where an empty password or a '!' would not.

See NetOrk/netork#2013
2026-11-04 11:46:13 +01:00
christianmanivong 650379680f Merge pull request 'feat(scheduled-jobs): scheduled jobs through PosixScheduledJobsMixin (#67)' (#68) from feature/scheduled-jobs into main
driver / lint (push) Successful in 14s
driver / test (3.13) (push) Successful in 51s
driver / lowest (push) Successful in 28s
driver / build (push) Successful in 31s
driver / security (push) Successful in 59s
driver / publish (push) Successful in 25s
driver / types (push) Successful in 59s
driver / standard (push) Successful in 14s
driver / test (3.12) (push) Successful in 1m3s
CI / driver (push) Successful in 2m52s
2026-11-03 07:56:30 +00:00
Christian Manivong 04a34ca6f5 chore(release): 0.16.0
driver / build (pull_request) Successful in 27s
driver / security (pull_request) Successful in 1m4s
CI / driver (pull_request) Successful in 2m27s
driver / standard (pull_request) Successful in 14s
driver / types (pull_request) Successful in 55s
driver / test (3.12) (pull_request) Successful in 59s
driver / test (3.13) (pull_request) Successful in 57s
driver / lowest (pull_request) Successful in 36s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 14s
Scheduled jobs (NetOrk/netork#1933) and everything unreleased since
0.15.0.
2026-11-03 08:52:05 +01:00
Christian Manivong d5870d9813 chore(scheduled-jobs): require napalm-device-types 4.27.0
driver / build (pull_request) Successful in 27s
driver / security (pull_request) Successful in 1m4s
CI / driver (pull_request) Successful in 2m14s
driver / standard (pull_request) Successful in 15s
driver / types (pull_request) Successful in 1m0s
driver / test (3.13) (pull_request) Successful in 53s
driver / test (3.12) (pull_request) Successful in 1m3s
driver / lowest (pull_request) Successful in 30s
driver / lint (pull_request) Successful in 14s
driver / publish (pull_request) Skipped
4.26.0 went out with the sshd drop-in change; the scheduled-jobs
contract is in 4.27.0.
2026-11-03 08:35:36 +01:00
Christian Manivong a30d1f6fe5 chore: version 0.16.0 ahead of the release, so OMV and QTS can require it
driver / build (pull_request) Successful in 32s
driver / security (pull_request) Failing after 1m13s
CI / driver (pull_request) Failing after 2m36s
driver / standard (pull_request) Successful in 24s
driver / test (3.12) (pull_request) Failing after 58s
driver / types (pull_request) Failing after 1m20s
driver / test (3.13) (pull_request) Failing after 56s
driver / lowest (pull_request) Failing after 24s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 25s
Their scheduled-jobs branches require napalm-linux>=0.16.0; the release
commit then only dates the changelog and tags.

Refs #67
2026-11-03 06:35:01 +01:00
Christian Manivong ca32b89686 feat(scheduled-jobs): scheduled jobs through PosixScheduledJobsMixin (#67)
driver / build (pull_request) Successful in 30s
driver / security (pull_request) Failing after 1m14s
CI / driver (pull_request) Failing after 2m29s
driver / standard (pull_request) Successful in 16s
driver / test (3.12) (pull_request) Failing after 51s
driver / types (pull_request) Failing after 59s
driver / test (3.13) (pull_request) Failing after 47s
driver / lowest (pull_request) Failing after 29s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 13s
get_scheduled_jobs reads /etc/crontab, /etc/cron.d, the user crontabs,
run-parts, anacron and every systemd timer in one round trip as root;
manage_scheduled_job enables, disables or runs one now; put_ and
delete_scheduled_job write and remove an application's own job.

get_cron_jobs goes: it read without root, missed most of what a host
schedules, and nothing called it.

Requires napalm-device-types 4.26.0.

Closes #67
2026-11-03 05:32:01 +01:00
christianmanivong cb0e308a78 Merge pull request 'fix(lldp): list every neighbour of a port, with its chassis MAC' (#62) from fix/lldp-keyvalue into main
driver / lint (push) Successful in 15s
driver / test (3.13) (push) Successful in 1m1s
driver / build (push) Successful in 31s
driver / security (push) Successful in 1m18s
driver / publish (push) Skipped
driver / types (push) Successful in 1m12s
driver / lowest (push) Successful in 33s
driver / standard (push) Successful in 19s
driver / test (3.12) (push) Successful in 1m14s
CI / driver (push) Successful in 3m4s
2026-11-02 11:03:06 +00:00
Christian Manivong c7317925ed Merge remote-tracking branch 'origin/main' into fix/lldp-keyvalue
driver / build (pull_request) Successful in 27s
driver / security (pull_request) Successful in 1m3s
CI / driver (pull_request) Successful in 2m21s
driver / standard (pull_request) Successful in 18s
driver / types (pull_request) Successful in 1m8s
driver / test (3.13) (pull_request) Successful in 58s
driver / test (3.12) (pull_request) Successful in 1m6s
driver / lowest (pull_request) Successful in 29s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 20s
# Conflicts:
#	CHANGELOG.md
#	tests/quality_baseline.json
2026-11-02 09:29:09 +01:00
christianmanivong 9ac6c7cf04 Merge pull request 'fix: quote ping arguments, sudo -n runs the whole command, ip route types (#55, #56, #57)' (#61) from fix/bugs-2026-11-02 into main
driver / lint (push) Successful in 15s
driver / test (3.13) (push) Successful in 1m8s
driver / build (push) Successful in 34s
driver / security (push) Successful in 1m15s
driver / publish (push) Skipped
driver / types (push) Successful in 1m13s
driver / lowest (push) Successful in 34s
driver / standard (push) Successful in 19s
driver / test (3.12) (push) Successful in 1m14s
CI / driver (push) Successful in 3m3s
2026-11-02 08:15:56 +00:00
Christian Manivong d3189806d3 fix(lldp): recognise a stopped lldpd and raise on a failed read
driver / build (pull_request) Successful in 32s
driver / security (pull_request) Failing after 1m9s
CI / driver (pull_request) Failing after 2m35s
driver / standard (pull_request) Successful in 19s
driver / test (3.12) (pull_request) Failing after 57s
driver / types (pull_request) Failing after 1m7s
driver / test (3.13) (pull_request) Failing after 50s
driver / lowest (pull_request) Failing after 23s
driver / lint (pull_request) Successful in 15s
driver / publish (pull_request) Skipped
The running check looked for "active" anywhere in the answer, and
systemctl answers "inactive" for a stopped lldpd, so lldpctl was asked
anyway. The check now prints one word, running or stopped, and is
compared whole. With lldpd running, lldpctl runs as napalm-device-types'
LLDPCTL_KEYVALUE_COMMAND: a failure (socket out of the login's reach, a
daemon restarting) raises with lldpctl's message instead of reading as
a host without neighbours. A missing or stopped lldpd still answers {}.

Closes #66
2026-11-02 08:53:52 +01:00
Christian Manivong a3d95d72b9 refactor(lldp): take the neighbour MAC from the shared projection
napalm-device-types' lldp_neighbors now carries the chassis MAC as mac
when the chassis id is a MAC address, the rule this driver applied
itself. The getter uses the projection, so linux and openwrt report
neighbours the same way.
2026-11-02 08:52:10 +01:00
Christian Manivong ca65f007c1 fix(routes): read the address of a "via inet6" next hop
driver / build (pull_request) Successful in 40s
driver / security (pull_request) Successful in 1m25s
CI / driver (pull_request) Successful in 3m10s
driver / standard (pull_request) Successful in 16s
driver / types (pull_request) Successful in 1m17s
driver / test (3.13) (pull_request) Successful in 1m12s
driver / test (3.12) (pull_request) Successful in 1m18s
driver / lowest (pull_request) Successful in 37s
driver / lint (pull_request) Successful in 16s
driver / publish (pull_request) Skipped
iproute2 prints an IPv4 route with an IPv6 next hop (RFC 8950, BGP
unnumbered) as "via inet6 fe80::1", and the next hop was read as the
literal "inet6". The family word after "via" is now skipped, for
multipath next hops as well.

With the address in place, get_route_to would have reported such a
route as ipv6, because it took the family from the next hop too. The
family is now the destination's alone. The test fixture is ip's output
(iproute2 6.1.0) recorded in a network namespace set up with these
routes.

Closes #65
2026-11-02 08:49:53 +01:00
Christian Manivong 9089429c2d fix(routes): give an FRR host route without a length /128 for IPv6
The FRR enrichment in get_route_to completed every prefix without a
length with /32. An IPv6 host route became a different, much larger
/32 prefix, so it missed the kernel's /128 entry for the same host
(stored that way since #6) and added a bogus one instead.

with_length() in _routes.py completes a prefix by its family, /32 or
/128. The protocol attributes move onto IpRoute, which keeps the import
in linux.py on one line; get_route_to shrinks and the baseline records
it.

Closes #64
2026-11-02 08:48:39 +01:00
Christian Manivong a1e8ec78c3 fix(ping): refuse a destination or source that reads as an option
Quoting keeps a value one word, but ping still reads a word starting
with "-" as one of its options: ping(destination="-f") sent a flood
ping option instead of a host, and a source "-f" did the same after -I.
No address or hostname starts with "-", so ping_command now refuses
such a destination or source with ValueError before anything is sent.

Closes #63
2026-11-02 08:47:23 +01:00
Christian Manivong 3d2de27988 fix(lldp): list every neighbour of a port, with its chassis MAC
driver / build (pull_request) Successful in 38s
driver / security (pull_request) Failing after 1m20s
CI / driver (pull_request) Failing after 2m46s
driver / standard (pull_request) Successful in 15s
driver / test (3.12) (pull_request) Failing after 48s
driver / types (pull_request) Failing after 1m0s
driver / lowest (pull_request) Failing after 22s
driver / test (3.13) (pull_request) Failing after 48s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 15s
lldpctl -f keyvalue was grouped by interface, so a second neighbour on a
port overwrote the first. The driver looked for chassis.id.value and
port.id.value, keys lldpd never prints (it names an id by its type,
chassis.mac, port.local), so the chassis MAC was never reported and a
port given by MAC or local id came back empty; and eth0.100 was cut at
its dot. The output now goes through napalm-device-types'
parse_lldpctl_keyvalue, which splits neighbours at their via line and
keeps the interface name whole; the floor on napalm-device-types rises
to 4.24.0 for it.

Closes #58
2026-11-02 08:44:15 +01:00
Christian Manivong e4c65945b9 fix(routes): read route types and multipath next hops in ip route
driver / build (pull_request) Successful in 36s
driver / security (pull_request) Successful in 1m19s
CI / driver (pull_request) Successful in 2m57s
driver / standard (pull_request) Successful in 18s
driver / types (pull_request) Successful in 1m16s
driver / test (3.12) (pull_request) Successful in 1m11s
driver / test (3.13) (pull_request) Successful in 1m5s
driver / lowest (pull_request) Successful in 32s
driver / lint (pull_request) Successful in 16s
driver / publish (pull_request) Skipped
get_route_to took the first word of every "ip route show" line as the
destination. For unreachable, blackhole, prohibit and throw routes that
word is the route type, so they came back as "unreachable/32" and the
like; a multipath route's continuation lines became "nexthop/32"
routes, and the route itself had no next hop.

The type word is now read as the type and reported in
protocol_attributes, without a next hop or outgoing interface for the
types that forward nothing (IPv6 names lo for them). nexthop lines
attach to the route before them, one entry per next hop. The test
fixture is ip's output (iproute2 6.1.0) recorded in a network
namespace set up with these routes.

Closes #57
2026-11-02 08:41:56 +01:00
Christian Manivong d3134c83b8 fix(sudo): run the whole command as root without a sudo password
Without a root login and without a sudo password, _run_privileged typed
"sudo -n <command>" into the interactive shell. sudo covered only the
first simple command of the line, and dnf's and yum's advisory query,
which starts with a brace group, did not parse at all: no status marker
ever arrived, so netmiko waited out the 120 s read timeout and
get_available_updates() failed. This is the default path for netOrk's
own NOPASSWD account.

The command now goes to "sudo -n sh -c" as one argument, as _as_root
already does with a password. A status echo at its end stays outside
sh -c: it reports sh's status, which is the command's, and still
arrives when sudo refuses.

Closes #56
2026-11-02 08:39:50 +01:00
Christian Manivong c2d7c4d1b4 fix(ping): quote the destination and source in the ping command
ping() typed its arguments into the interactive shell as they came, so a
destination such as "1.2.3.4; id" ran the command after the semicolon as
the login user. destination and source now go through shlex.quote, and
count, timeout, size and ttl are coerced with int(), which refuses
anything that is not a number before a command is sent.

The command is built in _ping.py, next to its parser, which keeps
linux.py within its recorded length.

Closes #55
2026-11-02 08:37:15 +01:00
christianmanivong 5687f5d9a1 Merge pull request 'fix(updates): read dnf and yum updates from the cached metadata (#59)' (#60) from fix/dnf-cache-only into main
driver / lint (push) Successful in 14s
driver / test (3.13) (push) Successful in 55s
driver / lowest (push) Successful in 29s
driver / build (push) Successful in 33s
driver / security (push) Successful in 1m8s
driver / publish (push) Skipped
driver / types (push) Successful in 1m3s
driver / standard (push) Successful in 16s
driver / test (3.12) (push) Successful in 1m11s
CI / driver (push) Successful in 2m49s
Reviewed-on: #60
2026-11-02 07:22:56 +00:00
Christian Manivong b891acd29c style(updates): keep linux.py within its recorded length
driver / build (pull_request) Successful in 30s
driver / security (pull_request) Successful in 1m7s
CI / driver (pull_request) Successful in 2m27s
driver / standard (pull_request) Successful in 14s
driver / types (pull_request) Successful in 1m1s
driver / test (3.12) (pull_request) Successful in 59s
driver / test (3.13) (pull_request) Successful in 52s
driver / lowest (pull_request) Successful in 29s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 13s
The quality ratchet records 2142 lines for napalm_linux/linux.py; the docstring of the previous commit took it to 2147.
2026-11-02 08:18:42 +01:00
Christian Manivong d226ebf764 fix(updates): read dnf and yum updates from the cached metadata
driver / build (pull_request) Successful in 33s
driver / security (pull_request) Successful in 1m9s
CI / driver (pull_request) Failing after 2m30s
driver / standard (pull_request) Failing after 15s
driver / types (pull_request) Successful in 1m0s
driver / test (3.12) (pull_request) Failing after 1m1s
driver / test (3.13) (pull_request) Failing after 53s
driver / lowest (pull_request) Failing after 28s
driver / lint (pull_request) Successful in 13s
driver / publish (pull_request) Skipped
`dnf check-update` and `yum check-update`, and yum's security query, download
the repositories' metadata first whenever the cached copy has expired. On an
Oracle Linux host on OCI that outlasted netOrk's 120 s poll on every run, and
the device went offline. They now run with --cacheonly, as apt's read uses its
local index; refresh_available_updates (`dnf makecache`) still refreshes it.
Without a cache the read fails at once and says to refresh the index. The
README row claimed check-update ran unprivileged; it runs as root.

dnf's security query is NAPALM/napalm-device-types#76.

Closes #59
2026-11-02 08:07:48 +01:00
christianmanivong 60ff9d9700 Merge pull request 'fix: six open bugs (#4, #43, #21, #17, #15, #6)' (#54) from fix/bugs-2026-11 into main
driver / lint (push) Successful in 14s
driver / test (3.13) (push) Successful in 1m2s
driver / lowest (push) Successful in 36s
driver / build (push) Successful in 30s
driver / security (push) Successful in 1m27s
driver / publish (push) Skipped
driver / types (push) Successful in 1m9s
driver / standard (push) Successful in 17s
driver / test (3.12) (push) Successful in 1m10s
CI / driver (push) Successful in 3m8s
2026-11-01 22:10:02 +00:00
Christian Manivong 897892b923 fix(routes): give the IPv6 default route ::/0
driver / build (pull_request) Successful in 38s
driver / security (pull_request) Successful in 1m20s
CI / driver (pull_request) Successful in 2m59s
driver / standard (pull_request) Successful in 17s
driver / types (pull_request) Successful in 1m10s
driver / test (3.12) (pull_request) Successful in 1m8s
driver / lowest (pull_request) Successful in 37s
driver / test (3.13) (pull_request) Successful in 1m14s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 14s
get_route_to read "ip -4 route show && ip -6 route show" as one output
and mapped "default" to 0.0.0.0/0; the "default6" branch meant for IPv6
never matches, because ip -6 also prints "default". A dual-stack host
showed two 0.0.0.0/0 routes, one of them family ipv6. Each family is now
read with its own command, so "default" becomes ::/0 for IPv6 and a host
route without a prefix length a /128 there instead of a /32.

The line parse moves to napalm_linux/_routes.py.

Closes #6
2026-11-01 21:50:33 +01:00
Christian Manivong 69f1701ea6 fix(ping): read BusyBox's ping and IPv6 replies
ping() only knew the iputils summary. BusyBox, the ping on Alpine,
writes "2 packets received", so every target came back as an error and
the ping sweep counted it as down. Its probe lines ("seq=") and every
IPv6 reply were dropped by an IPv4-only per-probe pattern, and its
"round-trip min/avg/max" line without a deviation was not read.

The parse moves to napalm_linux/_ping.py and accepts both summaries
(also iputils' with "+N errors"), both RTT lines, IPv6 and named
replies. The shared Unix ping parser is still open as
NAPALM/napalm-device-types#12.

Closes #15
2026-11-01 21:49:28 +01:00
Christian Manivong 024f68c543 fix(packages): leave removed packages with leftover config out of apt
dpkg-query -W also lists packages that were removed but whose
configuration dpkg keeps (state rc), and the driver marked every line
installed: old kernels and a removed agent showed up as installed
software. The query now asks for db:Status-Abbrev and drops packages
that are not installed or only left their configuration; held, unpacked
and half-configured packages keep counting, their files are on disk.

The dpkg query and its parse move to napalm_linux/_dpkg.py, a pure
function under strict mypy, which keeps linux.py inside its line count.

Closes #17
2026-11-01 21:48:05 +01:00
Christian Manivong 54f6844d84 fix(processes): keep ps's five-word start time in one field
get_processes split each ps line into 11 parts, but lstart is five
words, so started held only the weekday and command began with the rest
of the date. The line is now split into 15 parts, started joins the five
date words and command is the remainder. ps runs under LC_ALL=C: only
there are the weekday and month one word each on every host.

Closes #21
2026-11-01 21:46:34 +01:00
Christian Manivong df4f4b0e4d fix(vpn): make the WireGuard peer key's prefix URL-safe
get_vpn_tunnels keyed a peer as wireguard-<iface>-<pubkey[:8]>. Base64
uses "/" and "+", and the key is used as a URL path segment; a "/"
breaks the route even percent-encoded. The prefix now maps "+" to "-"
and "/" to "_", as napalm-opnsense does (NAPALM/napalm-opnsense#32).
Affected peers change their key once.

Closes #43
2026-11-01 21:45:42 +01:00
Christian Manivong eaa08ae7e3 fix(packages): read install_package's success from the exit status
install_package searched the output of `... || true` for words such as
"failed", the pattern uninstall_package left behind for netork#267: a
postinst that only mentions a failure read as a failed install, and a
failure phrased without those words read as success. It now runs through
_sudo_status like the removal and falls back to the keywords only when
the channel gave no exit status.

The ruff findings named in the issue are gone since the driver adopted
the standard; strict mypy for linux.py is held by the quality ratchet,
and the None-vs-dict package contract is NAPALM/napalm-device-types#36.

Closes #4
2026-11-01 21:44:51 +01:00
christianmanivong a729b35d8b Merge pull request 'feat: netOrk's own account with a fixed uid (NetOrk/netork#1817)' (#53) from feature/system-user-uid-1817 into main
driver / lint (push) Successful in 17s
driver / test (3.13) (push) Successful in 1m7s
driver / build (push) Failing after 7s
driver / security (push) Successful in 1m15s
driver / publish (push) Skipped
driver / types (push) Successful in 1m9s
driver / lowest (push) Successful in 39s
driver / standard (push) Successful in 17s
driver / test (3.12) (push) Successful in 1m6s
CI / driver (push) Failing after 2m57s
2026-11-01 12:44:20 +00:00
Christian Manivong e9a1fc7ff9 feat: netOrk's own account with a fixed uid (NetOrk/netork#1817)
driver / build (pull_request) Successful in 26s
driver / security (pull_request) Successful in 1m6s
CI / driver (pull_request) Successful in 2m37s
driver / standard (pull_request) Successful in 14s
driver / types (pull_request) Successful in 1m4s
driver / test (3.12) (pull_request) Successful in 1m3s
driver / test (3.13) (pull_request) Successful in 57s
driver / lowest (pull_request) Successful in 28s
driver / lint (pull_request) Successful in 13s
driver / publish (pull_request) Skipped
_account_create_with_uid makes it with useradd -m -u <uid>; below UID_MIN
useradd warns and goes on, as for a system's account.
2026-11-01 12:42:30 +01:00
christianmanivong f49d1ca7f5 Merge pull request 'test: check the proxy fix's own steps, not every step the mixin runs' (#52) from fix/apt-https-step into main
driver / lint (push) Successful in 17s
driver / test (3.13) (push) Successful in 1m2s
driver / build (push) Successful in 32s
driver / security (push) Successful in 1m11s
driver / publish (push) Skipped
driver / types (push) Successful in 1m11s
driver / lowest (push) Successful in 34s
driver / standard (push) Successful in 23s
driver / test (3.12) (push) Successful in 1m11s
CI / driver (push) Successful in 3m2s
2026-11-01 07:13:43 +00:00
Christian Manivong dd351f1077 test: check the proxy fix's own steps, not every step the mixin runs
driver / build (pull_request) Successful in 25s
driver / security (pull_request) Successful in 1m4s
CI / driver (pull_request) Successful in 2m32s
driver / standard (pull_request) Successful in 14s
driver / types (pull_request) Successful in 1m1s
driver / test (3.12) (pull_request) Successful in 1m3s
driver / test (3.13) (pull_request) Successful in 1m1s
driver / lowest (pull_request) Successful in 31s
driver / lint (pull_request) Successful in 13s
driver / publish (pull_request) Skipped
napalm-device-types adds an https step to configure_package_proxy
(NetOrk/netork#1811). It runs on the transports this driver already has, so
the test checks the four steps it supplies and lets later ones be.
2026-11-01 07:58:10 +01:00
christianmanivong b702fa5125 Merge pull request 'feat: personal accounts with shadow-utils, locked by expiry (NetOrk/netork#1793)' (#50) from feat/local-accounts into main
driver / lint (push) Successful in 14s
driver / test (3.13) (push) Successful in 1m1s
driver / build (push) Successful in 27s
driver / security (push) Successful in 59s
driver / publish (push) Skipped
driver / lowest (push) Successful in 30s
driver / types (push) Successful in 1m3s
driver / standard (push) Successful in 15s
driver / test (3.12) (push) Failing after 5s
CI / driver (push) Failing after 1m48s
Reviewed-on: #50
2026-10-31 23:51:03 +00:00
Christian Manivong 448eeec0fa refactor: the interactive shell's end-of-output pattern lives in _shell (quality ratchet)
driver / build (pull_request) Successful in 37s
driver / security (pull_request) Successful in 1m19s
CI / driver (pull_request) Successful in 3m5s
driver / standard (pull_request) Successful in 14s
driver / types (pull_request) Successful in 1m15s
driver / test (3.12) (pull_request) Successful in 1m19s
driver / test (3.13) (pull_request) Successful in 1m11s
driver / lowest (pull_request) Successful in 35s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 13s
expect_for and STATUS_ECHO_RE say when netmiko's interactive shell has
finished printing a command's output, next to PROMPT_RE they build on.
Moving them out keeps linux.py within its line count now that it mixes in
the personal accounts; the baseline goes down to 2265.
2026-11-01 00:48:02 +01:00
Christian Manivong 9ce915a8b9 Merge remote-tracking branch 'origin/main' into feat/local-accounts
# Conflicts:
#	CHANGELOG.md
2026-11-01 00:48:02 +01:00
christianmanivong 812a162eef Merge pull request 'feat: open() waits out sshd's per-source penalty (NetOrk/netork#1800)' (#51) from feat/ssh-penalties-1800 into main
driver / lint (push) Successful in 14s
driver / test (3.13) (push) Successful in 1m3s
driver / build (push) Successful in 25s
driver / security (push) Successful in 58s
driver / publish (push) Skipped
driver / types (push) Successful in 1m4s
driver / lowest (push) Successful in 28s
driver / standard (push) Successful in 14s
driver / test (3.12) (push) Successful in 1m5s
CI / driver (push) Successful in 2m15s
Reviewed-on: #51
2026-10-31 23:36:46 +00:00
Christian Manivong bff275402e fix: keep linux.py within its line count (quality ratchet)
driver / build (pull_request) Successful in 29s
driver / security (pull_request) Successful in 1m3s
CI / driver (pull_request) Successful in 2m14s
driver / standard (pull_request) Successful in 15s
driver / types (pull_request) Successful in 1m5s
driver / test (3.13) (pull_request) Successful in 56s
driver / test (3.12) (pull_request) Successful in 1m6s
driver / lowest (pull_request) Successful in 28s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 14s
One handler for the two netmiko failures that both became a
ConnectionException, and the retry's note on its own line.
2026-11-01 00:33:32 +01:00
Christian Manivong 49b7d7fef7 feat: open() waits out sshd's per-source penalty (NetOrk/netork#1800)
driver / build (pull_request) Successful in 29s
driver / security (pull_request) Successful in 1m2s
CI / driver (pull_request) Failing after 2m17s
driver / standard (pull_request) Failing after 15s
driver / types (pull_request) Successful in 1m3s
driver / test (3.13) (pull_request) Failing after 59s
driver / test (3.12) (pull_request) Failing after 1m9s
driver / lowest (pull_request) Failing after 28s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 15s
OpenSSH 9.8+ closes every connection from a source it has just
penalised, before its banner, for seconds to minutes. open() now wraps
netmiko's ConnectHandler in napalm-device-types' retry_refused, so the
connection is tried again after 1, 3, 7 and 15 s instead of failing.
Needs NAPALM/napalm-device-types#63.
2026-11-01 00:26:47 +01:00
Christian Manivong c5be71adac feat: personal accounts with shadow-utils, locked by expiry (NetOrk/netork#1793)
driver / build (pull_request) Successful in 42s
driver / security (pull_request) Successful in 1m29s
CI / driver (pull_request) Failing after 3m19s
driver / standard (pull_request) Failing after 17s
driver / types (pull_request) Failing after 1m17s
driver / test (3.12) (pull_request) Failing after 1m19s
driver / test (3.13) (pull_request) Failing after 1m7s
driver / lowest (pull_request) Failing after 41s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 14s
LinuxDriver mixes in napalm-device-types' LocalAccountsMixin with
useradd -m -s /bin/bash, usermod and gpasswd -d. A locked account is an
expired one (usermod -L -e 1): PAM refuses it a key login too, where a
"!" in front of the password stops only the password. Opening it again
lifts the expiry and gives the old password back.

Checked on Debian 13 and Rocky Linux 9 containers with sshd and sudo:
key login works after adding, is refused after locking and works again
after reopening; the sudo rule takes effect with the person's password;
membership of sudo/wheel goes when sudo is not wanted.
2026-10-31 23:24:27 +01:00
christianmanivong 7550b884b0 Merge pull request 'feat: count and remove the sudo password the old _sudo left in histories (NetOrk/netork#1090)' (#48) from feat/sudo-history-cleanup into main
driver / lint (push) Successful in 17s
driver / test (3.13) (push) Successful in 1m1s
driver / build (push) Successful in 36s
driver / security (push) Successful in 1m20s
driver / publish (push) Skipped
driver / types (push) Successful in 1m15s
driver / lowest (push) Successful in 38s
driver / standard (push) Successful in 20s
driver / test (3.12) (push) Successful in 1m15s
CI / driver (push) Successful in 3m2s
2026-10-30 20:52:36 +00:00
Christian Manivong fbaded5913 feat: count and remove the sudo password the old _sudo left in histories (NetOrk/netork#1090)
driver / build (pull_request) Successful in 38s
driver / security (pull_request) Successful in 1m30s
CI / driver (pull_request) Successful in 3m6s
driver / standard (pull_request) Successful in 18s
driver / types (pull_request) Successful in 1m3s
driver / test (3.12) (pull_request) Successful in 1m4s
driver / test (3.13) (pull_request) Successful in 1m10s
driver / lowest (pull_request) Successful in 59s
driver / lint (pull_request) Successful in 14s
driver / publish (pull_request) Skipped
Until NetOrk/netork#1039, _sudo typed `echo '<password>' | sudo -S -p ""
<command>` into netmiko's interactive shell, so the login user's history
kept the password once per command, and the part after the first `&&` ran
without root, leaving snmpd.conf and apt's 00proxy to the login user.

LinuxDriver mixes in napalm-device-types' SudoHistoryMixin and names what
to look for: the marker "| sudo -S -p " and those two files.
get_history_sudo_lines() and remove_history_sudo_lines() run on the exec
channel; OpenMediaVault and QNAP inherit both.

The _privileged docstring points at _as_root instead of restating it, so
linux.py does not grow.

Requires the napalm-device-types release with SudoHistoryMixin.
2026-10-30 21:09:33 +01:00
christianmanivong 4cd1710e19 Merge pull request 'fix: an unknown ARP age is -1.0, not 0.0' (#47) from fix/arp-unknown-age into main
driver / lint (push) Successful in 16s
driver / test (3.13) (push) Successful in 1m2s
driver / lowest (push) Successful in 37s
driver / build (push) Successful in 33s
driver / security (push) Successful in 1m20s
driver / publish (push) Skipped
driver / types (push) Successful in 1m8s
driver / standard (push) Successful in 18s
driver / test (3.12) (push) Successful in 1m8s
CI / driver (push) Successful in 2m55s
2026-10-30 09:11:41 +00:00
Christian Manivong 05cef25e9b fix: an unknown ARP age is -1.0, not 0.0
driver / build (pull_request) Successful in 32s
driver / security (pull_request) Successful in 1m9s
CI / driver (pull_request) Successful in 2m54s
driver / standard (pull_request) Successful in 18s
driver / types (pull_request) Successful in 1m14s
driver / test (3.12) (pull_request) Successful in 1m14s
driver / test (3.13) (pull_request) Successful in 1m6s
driver / lowest (pull_request) Successful in 31s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 13s
ip neigh has no age, and a STALE entry may be hours old, so get_arp_table
reports ARP_AGE_UNKNOWN instead of 0.0 ("confirmed just now").

NetOrk/netork#1327
2026-10-30 08:37:08 +01:00
christianmanivong 2ffad23bf0 Merge pull request 'feat: set_hostname renames the host (#45)' (#46) from feat/set-hostname-45 into main
driver / lint (push) Successful in 17s
driver / test (3.13) (push) Successful in 1m8s
driver / lowest (push) Successful in 31s
driver / build (push) Successful in 39s
driver / security (push) Successful in 1m23s
driver / publish (push) Skipped
driver / types (push) Successful in 1m12s
driver / standard (push) Successful in 21s
driver / test (3.12) (push) Successful in 1m11s
CI / driver (push) Successful in 2m51s
2026-10-29 21:05:29 +00:00
Christian Manivong 4108eb83dd feat: set_hostname renames the host (#45)
driver / build (pull_request) Successful in 32s
driver / security (pull_request) Successful in 1m14s
CI / driver (pull_request) Successful in 1m15s
driver / standard (pull_request) Successful in 18s
driver / types (pull_request) Successful in 1m12s
driver / test (3.12) (pull_request) Successful in 1m11s
driver / test (3.13) (pull_request) Successful in 1m6s
driver / lowest (pull_request) Successful in 29s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 14s
netOrk could save a Linux host's new name but not apply it: the driver had
no set_hostname(), so apply-hostname answered "The driver linux does not
support set_hostname()".

HostnameMixin.set_hostname() takes a bare name or an FQDN. The short name
goes to hostnamectl, or to /etc/hostname and hostname(1) without systemd.
/etc/hosts follows: every line naming the old name, else the 127.0.1.1
line; a file with neither is left alone. A cloud-init host gets
preserve_hostname: true, or its next boot restores the image's name.
Names that are not RFC 1123 hostnames are refused before anything runs.
Files are staged unprivileged and installed by root
(_install_file_as_root), never written from privileged stdin.

It lives in its own module because linux.py may not grow (quality
ratchet); the two lines it adds there are offset by a stale comment and
an import that fits on one line, so the baseline drops to 2286.
2026-10-29 21:57:40 +01:00
christianmanivong b6677c9fc5 Merge pull request 'chore: Python 3.12 is the floor (NAPALM/driver-standard#6)' (#44) from chore/python-312-floor into main
driver / lint (push) Successful in 21s
driver / test (3.13) (push) Successful in 1m9s
driver / build (push) Successful in 38s
driver / security (push) Successful in 1m14s
driver / publish (push) Skipped
driver / types (push) Successful in 1m18s
driver / lowest (push) Successful in 35s
driver / standard (push) Successful in 18s
driver / test (3.12) (push) Successful in 1m28s
CI / driver (push) Successful in 2m58s
2026-10-27 09:37:26 +00:00
Christian Manivong 2afdf33d4d chore: Python 3.12 is the floor (NAPALM/driver-standard#6)
driver / build (pull_request) Successful in 27s
driver / security (pull_request) Successful in 1m7s
CI / driver (pull_request) Successful in 2m42s
driver / standard (pull_request) Successful in 15s
driver / types (pull_request) Successful in 1m7s
driver / test (3.12) (pull_request) Successful in 1m6s
driver / test (3.13) (pull_request) Successful in 55s
driver / lowest (pull_request) Successful in 30s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 13s
netOrk runs every driver in its own containers on Python 3.12, so 3.10
and 3.11 are no longer supported or tested. requires-python, mypy and
ruff move to 3.12, along with what ruff's pyupgrade rules then rewrite.
2026-10-27 10:18:57 +01:00
christianmanivong 661f6da3f7 Merge pull request 'fix: keep systemd's OSC 3008 shell context out of command output (#41)' (#42) from fix/osc-context-41 into main
driver / lint (push) Successful in 17s
driver / test (3.13) (push) Successful in 46s
driver / build (push) Successful in 24s
driver / security (push) Successful in 56s
driver / publish (push) Skipped
driver / types (push) Successful in 3m1s
driver / test (3.11) (push) Successful in 2m16s
driver / lowest (push) Successful in 25s
driver / standard (push) Successful in 18s
driver / test (3.10) (push) Successful in 1m13s
driver / test (3.12) (push) Successful in 1m43s
CI / driver (push) Successful in 5m29s
2026-10-23 21:10:04 +00:00
Christian Manivong 42e93f02dd refactor: prepare the interactive shell in its own module
driver / test (3.10) (pull_request) Successful in 3m57s
driver / test (3.11) (pull_request) Successful in 1m7s
driver / security (pull_request) Successful in 1m3s
driver / build (pull_request) Successful in 58s
CI / driver (pull_request) Successful in 23m9s
driver / standard (pull_request) Successful in 40s
driver / test (3.12) (pull_request) Successful in 1m9s
driver / types (pull_request) Successful in 19m18s
driver / lowest (pull_request) Successful in 43s
driver / test (3.13) (pull_request) Successful in 16m1s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 27s
The prompt-hook step (#41) pushed linux.py past its line count in the
quality baseline. The three steps that make netmiko's fresh shell fit to
read - history off, prompt hooks off, no line wrap - and the prompt
pattern move to napalm_linux/_shell.py, under strict mypy. linux.py
shrinks below where it was; the baseline follows.
2026-10-23 22:46:36 +02:00
Christian Manivong 4159612a33 fix: keep systemd's OSC 3008 shell context out of command output (#41)
driver / test (3.10) (pull_request) Successful in 1m3s
driver / test (3.11) (pull_request) Successful in 1m4s
driver / build (pull_request) Successful in 23s
driver / security (pull_request) Successful in 4m12s
CI / driver (pull_request) Failing after 8m24s
driver / standard (pull_request) Failing after 17s
driver / types (pull_request) Successful in 51s
driver / test (3.12) (pull_request) Successful in 1m58s
driver / test (3.13) (pull_request) Successful in 2m1s
driver / lowest (pull_request) Successful in 1m19s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 28s
systemd 258 (Ubuntu 26.04) ships /etc/profile.d/80-systemd-osc-context.sh:
an interactive bash wraps every command in OSC 3008 sequences from PS0 and
PROMPT_COMMAND, each with a fresh UUID. They ended up in every value read
through netmiko's shell, and because the prompt never looked the same twice,
the prompt line stayed in the output too. os_version grew past 255
characters and netOrk could not store the poll.

The session now unsets PS0 and PROMPT_COMMAND right after switching the
history off and reads its prompt anew; _send() strips terminal codes from
what it returns.

Version 0.15.1.
2026-10-23 18:58:21 +02:00
christianmanivong 3aa1955382 Merge pull request 'chore: adopt the NAPALM driver standard' (#38) from chore/driver-standard into main
driver / lint (push) Successful in 16s
driver / lowest (push) Successful in 30s
driver / test (3.13) (push) Successful in 1m2s
driver / build (push) Successful in 34s
driver / security (push) Successful in 1m15s
driver / publish (push) Successful in 29s
driver / types (push) Successful in 1m13s
driver / test (3.11) (push) Successful in 1m10s
driver / standard (push) Successful in 18s
driver / test (3.10) (push) Successful in 1m14s
driver / test (3.12) (push) Successful in 1m8s
CI / driver (push) Successful in 3m46s
2026-10-23 12:55:55 +00:00
Christian Manivong 9a4bc76dbf chore(release): 0.15.0
driver / test (3.10) (pull_request) Successful in 59s
driver / test (3.11) (pull_request) Successful in 58s
driver / build (pull_request) Successful in 26s
driver / security (pull_request) Successful in 58s
CI / driver (pull_request) Successful in 2m42s
driver / standard (pull_request) Successful in 15s
driver / types (pull_request) Successful in 54s
driver / lowest (pull_request) Successful in 29s
driver / test (3.12) (pull_request) Successful in 56s
driver / test (3.13) (pull_request) Successful in 52s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 12s
2026-10-23 12:02:11 +02:00
Christian Manivong cc0e0358f2 ci: say which napalm-device-types the git install waits for
driver / test (3.10) (pull_request) Failing after 38s
driver / test (3.11) (pull_request) Failing after 38s
driver / security (pull_request) Failing after 46s
driver / build (pull_request) Successful in 23s
CI / driver (pull_request) Failing after 4m55s
driver / standard (pull_request) Successful in 13s
driver / types (pull_request) Failing after 41s
driver / test (3.12) (pull_request) Failing after 35s
driver / test (3.13) (pull_request) Failing after 31s
driver / lowest (pull_request) Failing after 19s
driver / lint (pull_request) Successful in 11s
driver / publish (pull_request) Skipped
2026-10-23 08:29:33 +02:00
Christian Manivong e0960085c7 Merge remote-tracking branch 'origin/master' into chore/driver-standard
driver / test (3.10) (pull_request) Failing after 38s
driver / test (3.11) (pull_request) Failing after 38s
driver / security (pull_request) Failing after 45s
driver / build (pull_request) Successful in 22s
CI / driver (pull_request) Failing after 4m51s
driver / standard (pull_request) Successful in 14s
driver / types (pull_request) Failing after 42s
driver / test (3.12) (pull_request) Failing after 33s
driver / test (3.13) (pull_request) Failing after 30s
driver / lowest (pull_request) Failing after 17s
driver / lint (pull_request) Successful in 11s
driver / publish (pull_request) Skipped
# Conflicts:
#	napalm_linux/linux.py
2026-10-23 08:29:05 +02:00
christianmanivong 91b2025074 Merge pull request 'feat: apt's proxy through AptProxyMixin (NetOrk/netork#1397)' (#39) from feat/apt-proxy-verify into master
CI / test (3.10) (push) Failing after 14s
CI / test (3.11) (push) Failing after 13s
CI / test (3.12) (push) Failing after 14s
2026-10-22 22:08:24 +00:00
Christian Manivong 04f071afd0 feat: apt's proxy through AptProxyMixin (NetOrk/netork#1397)
CI / test (3.10) (push) Failing after 21s
CI / test (3.11) (push) Failing after 19s
CI / test (3.10) (pull_request) Failing after 19s
CI / test (3.12) (pull_request) Failing after 16s
CI / test (3.12) (push) Failing after 18s
CI / test (3.11) (pull_request) Failing after 17s
get_package_proxy() is what apt-config dump says, not 00proxy alone: a
proxy in 90curtin-aptproxy or /etc/apt/apt.conf wins over it and was
missed. The driver now supplies only the transports: reads on the exec
channel, root commands through _root_outcome, the file through the staged
_install_file_as_root. New: get_package_proxy_report() and
check_package_proxy(). configure_package_proxy() also comments out other
proxy lines, reads the result back and fetches through the proxy.

Requires napalm-device-types 4.22.0; version 0.14.0.
2026-10-22 19:16:40 +02:00
Christian Manivong 9b3ac3f3eb chore: adopt the NAPALM driver standard
driver / test (3.10) (pull_request) Failing after 5m48s
driver / test (3.11) (pull_request) Failing after 3m11s
driver / security (pull_request) Successful in 6m8s
driver / build (pull_request) Failing after 52s
CI / driver (pull_request) Failing after 30m42s
driver / standard (pull_request) Successful in 56s
driver / types (pull_request) Failing after 1m6s
driver / test (3.12) (pull_request) Successful in 2m48s
driver / test (3.13) (pull_request) Successful in 4m16s
driver / lowest (pull_request) Successful in 4m47s
driver / publish (pull_request) Skipped
driver / lint (pull_request) Successful in 49s
- CI moves to .gitea/workflows/ci.yml and calls the shared driver workflow
  of NAPALM/driver-standard; napalm-device-types comes from git until it is
  on PyPI.
- requires-python >=3.10 (napalm-device-types needs it), LICENSE file,
  py.typed, SPDX license string, links to git.netork.io.
- mypy strict for the package; napalm_linux.linux is exempt for now (21
  errors), recorded in the quality baseline with its long functions and
  the 2200-line module. Coverage floor 58 % (measured 58.23 %).
2026-10-22 19:11:50 +02:00
Christian Manivong 933f81bd44 fix: what bandit and the remaining lint rules found
- Long shell command lines are split into adjacent string literals.
- get_os_users: a first loop over /etc/group filled a map nobody read;
  it is gone, the output is unchanged.
- The five except Exception: pass now log at debug level (B110), so a
  swallowed failure leaves a trace.
- nosec for the staging path on the device (B108) and the sudo hint
  message (B105); both are false positives.
- tests: raise ... from exc, unused loop variable.
2026-10-22 19:10:26 +02:00
Christian Manivong 38391891ec style: ruff format and the lint rules of the driver standard
Mechanical: ruff format, and ruff check --fix with the rule set every NAPALM
driver uses (E, F, I, UP, B at line length 100, Python 3.10). What ruff
cannot fix comes in the next commit.
2026-10-22 19:09:42 +02:00
28 changed files with 3561 additions and 845 deletions

No files matched your search

+17
View File
@@ -0,0 +1,17 @@
name: CI
on:
push:
branches: [main, master]
tags: ["v*"]
pull_request:
jobs:
driver:
uses: NAPALM/driver-standard/.gitea/workflows/driver.yml@main
with:
standard-ref: main
# Until napalm-device-types 4.22.0 (AptProxyMixin, #53) is on PyPI.
pre-install: "git+https://git.netork.io/NAPALM/napalm-device-types.git"
secrets:
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
-48
View File
@@ -1,48 +0,0 @@
name: CI
on:
push:
branches: ["**"]
pull_request:
branches: ["**"]
jobs:
test:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.10", "3.11", "3.12"]
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
cache: pip
- name: Install package with dev extras
run: |
python -m pip install --upgrade pip
# napalm-device-types lives in git.netork.io/NAPALM, not on PyPI: without this
# pip looks there, finds an unrelated 0.1.0 and the job dies before any test.
python -m pip install "napalm-device-types @ git+https://git.netork.io/NAPALM/napalm-device-types.git"
python -m pip install -e ".[dev]"
- name: Run unit tests
run: |
python -m pytest -q --tb=short
- name: Build wheel and sdist
run: |
python -m pip install build
python -m build
- name: Upload dist artifacts
# v4 refuses to run on Gitea ("not currently supported on GHES").
uses: actions/upload-artifact@v3
with:
name: dist-${{ matrix.python-version }}
path: dist/*
+167
View File
@@ -7,7 +7,174 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
## [0.17.0] - 2026-11-04
### Added
- Personal accounts follow what the person changes (NetOrk/netork#2013):
`add_local_account(..., replaces=[...])` takes the old keys out of the account's key
files as the new one goes in, `remove_local_account_keys` takes deleted keys out and
leaves the account open, and `add_local_account(..., clear_password=True)` removes the
password (`usermod -p '*'`): the account logs in with its key only and has no sudo.
Keys the person added on the host stay.
### Changed
- Needs napalm-device-types 4.28.0.
## [0.16.0] - 2026-11-03
### Added
- Scheduled jobs (NetOrk/netork#1933, #67), through napalm-device-types' `PosixScheduledJobsMixin`:
`get_scheduled_jobs()` reads `/etc/crontab`, `/etc/cron.d`, the user crontabs (Debian,
RHEL, Alpine), the run-parts directories, `/etc/anacrontab` and every systemd timer in one
round trip as root; `manage_scheduled_job()` enables, disables or runs one now;
`put_scheduled_job()` and `delete_scheduled_job()` write and remove an application's own.
OpenMediaVault and QNAP QTS inherit it and decide per verb in their own packages.
- netOrk's own account with a fixed uid (NetOrk/netork#1817): `_account_create_with_uid`
makes it with `useradd -m -u <uid>`. Below `UID_MIN` useradd warns and goes on, as a
system's account.
- Personal accounts (NetOrk/netork#1793), through napalm-device-types' `LocalAccountsMixin`:
`get_local_accounts()`, `add_local_account()` and `lock_local_account()` with
shadow-utils' commands (`useradd -m -s /bin/bash`, `usermod`, `gpasswd -d`). A locked
account is an expired one (`usermod -L -e 1`): PAM refuses it a key login too, where a
`!` in front of the password stops only the password. Opening it again lifts the expiry
and gives the old password back. Checked on Debian 13 and Rocky Linux 9 with sshd and
sudo. OpenMediaVault (Debian) inherits it; QNAP QTS opts out in napalm-qnap-qts.
Requires the napalm-device-types release with `LocalAccountsMixin`.
- `open()` tries the connection again after 1, 3, 7 and 15 s when sshd closes it before
its banner -- what OpenSSH 9.8+ does to a source it has just penalised
(`PerSourcePenalties`), e.g. after a security scanner's probes. Needs
napalm-device-types' `retry_refused` (NAPALM/napalm-device-types#63,
NetOrk/netork#1800).
- The sudo password the old `_sudo` left in shell histories (NetOrk/netork#1090), through
napalm-device-types' `SudoHistoryMixin`. Until NetOrk/netork#1039 every privileged command
was typed into the interactive shell as `echo '<password>' | sudo -S -p "" …`, so the
login user's history kept the password once per command. `get_history_sudo_lines()`
counts those lines with `grep -c`, without reading them; `remove_history_sudo_lines()`
deletes exactly them and gives `/etc/snmp/snmpd.conf` and `/etc/apt/apt.conf.d/00proxy`
back to `root:root` where the old partial sudo left them to the login user (a regular
file, never a symbolic link). OpenMediaVault and QNAP inherit both. Requires the
napalm-device-types release with `SudoHistoryMixin`.
- `set_hostname()` (#45): netOrk could save a Linux host's new name but not apply it
("The driver linux does not support set_hostname()"). The host now takes the short
name through `hostnamectl`, or `/etc/hostname` and `hostname(1)` without systemd;
`/etc/hosts` follows (the lines naming the old name, else the `127.0.1.1` line), and a
cloud-init host gets `preserve_hostname: true` so its next boot keeps the name. Names
that are not valid hostnames are refused before anything runs on the host.
### Changed
- Python 3.12 is the floor (`requires-python = ">=3.12"`): netOrk runs every driver
on 3.12, so 3.10 and 3.11 are no longer tested (NAPALM/driver-standard#6).
- The floor on napalm-device-types is 4.24.0, for its shared `lldpctl` parser.
### Fixed
- `get_lldp_neighbors()` raises when lldpd runs but lldpctl fails (its socket out of
the login's reach, a daemon restarting), with lldpctl's message, instead of reporting
no neighbours (#66). A stopped lldpd is recognised as stopped: systemd's `inactive`
used to pass the running check, as it contains the word "active". A host without
lldpd, or with lldpd stopped, still reports no neighbours.
- `get_lldp_neighbors()` lists every neighbour of a port (#58): a phone and the PC
behind it, or the devices behind an unmanaged switch, used to merge into one entry
and only the last one was left. A neighbour whose chassis id is a MAC address now
carries it as `mac` (it never did), a port given as a MAC address or local id is
reported instead of coming back empty, and an interface with a dot in its name
(`eth0.100`) keeps its whole name.
- `get_route_to()` reads unreachable, blackhole, prohibit and throw routes and
multipath routes (#57). Their destinations came back as `unreachable/32`,
`blackhole/32` or `nexthop/32`, and a multipath route as one entry without a next
hop. A typed route now has its real prefix and its type in
`protocol_attributes` (`{"type": "blackhole"}`), with no next hop and no outgoing
interface, since it sends nothing out. A multipath route has one entry per next hop,
each with its gateway and interface. A host route that FRR reports without a prefix
length is a `/128` for IPv6 instead of a `/32` (#64), so it meets the kernel's route
for the same host and gets FRR's protocol.
- `get_route_to()` reads the next hop of an IPv4 route through an IPv6 gateway (RFC
8950, as BGP unnumbered sets up), which `ip route` prints as `via inet6 fe80::1`
(#65). The next hop came back as `inet6`; it is now the address, for multipath
routes too. Such a route stays `family: ipv4`: the family is the destination's,
never the next hop's.
- `get_available_updates()` works on dnf and yum hosts whose login user has
passwordless sudo (NOPASSWD), as netOrk's own account does, and marks the security
fixes there (#56). The security-advisory query did not parse under `sudo -n`, so no
answer came back and the read ran into its 120 s timeout. Without a sudo password a
privileged command now runs as root as a whole, in one `sh -c`, as it already did
with a password; before, only its first command did. A refused sudo still reports
its exit status at once.
- `ping()` passes `destination` and `source` to the host's shell as one quoted word
each (#55). A destination such as `192.0.2.1; id` ran the command after the `;` as
the login user. `count`, `timeout`, `size` and `ttl` must be numbers; anything else
raises `ValueError` before a command is sent. A destination or source that starts
with `-` is refused the same way (#63): `ping` would read `-f` as its flood option,
and no address or hostname starts with `-`.
- dnf and yum hosts read pending updates and security advisories from the cached
metadata only (`--cacheonly`), as apt reads its local index (#59). With an expired
cache `check-update` downloaded the repositories' metadata first, and on an Oracle
Linux host on OCI that outlasted netOrk's whole poll, every time. Refreshing stays
`refresh_available_updates()` (`dnf makecache`). Without a cache the read fails at
once and says to refresh the index. Requires the napalm-device-types release with
NAPALM/napalm-device-types#76 for dnf's security query.
- `get_arp_table()` reports an unknown age as `-1.0` (napalm-device-types'
`ARP_AGE_UNKNOWN`) instead of `0.0`, which means "confirmed just now": `ip neigh`
has no age, and a STALE entry may be hours old (NetOrk/netork#1327).
- `install_package()` reports success by the package manager's exit status, as
`uninstall_package()` already does (#4). It used to search the output for words like
"failed": an install whose postinst merely mentioned a failure read as failed, and a
failure that used none of the words read as success.
- `get_vpn_tunnels()` makes the public-key prefix in a WireGuard peer's key URL-safe
(`+` becomes `-`, `/` becomes `_`), as napalm-opnsense does (#43). A key with `/`
could not be used as a URL path segment, so such a tunnel could not be edited in
netOrk. The key of a peer whose first eight key characters hold `+` or `/` changes
once; `public_key` is reported unchanged.
- `get_processes()` reports a process's whole start time in `started`
(`Tue Oct 6 08:47:15 2026`) and only the command line in `command` (#21). `started`
held the weekday alone and `command` began with the rest of the date. The start time
is read in the C locale, so its words are English on every host.
- `get_packages()` on apt hosts no longer lists removed packages whose configuration
dpkg still keeps (state `rc`) (#17). They were reported as installed: old kernels, or
an agent that had been removed. A package that is held, unpacked or half-configured
still counts, since its files are on disk.
- `ping()` reads BusyBox's output, the `ping` on Alpine (#15). Its summary says
"2 packets received", which did not match, so every target came back as an error and
a LAN scan through an Alpine host found nothing. Replies to IPv6 targets, BusyBox's
`seq=` replies and replies from a name (`bytes from host (address)`) now appear in
`results`, BusyBox's `round-trip` line fills the RTT fields, and an iputils summary
that counts errors is read as well.
- `get_route_to()` reports a dual-stack host's IPv6 default route as `::/0` (#6). It
came back as a second `0.0.0.0/0` with `family: ipv6`, because `ip -6 route show`
calls its default route `default` as well. An IPv6 host route is now a `/128`
instead of a `/32`.
### Removed
- `get_cron_jobs()`: it read without root, missed other users' crontabs, `/etc/crontab`,
run-parts, anacron and every systemd timer, and nothing called it. `get_scheduled_jobs()`
replaces it.
## [0.15.1] - 2026-10-23
### Fixed
- Ubuntu 26.04 hosts could not be polled (#41). systemd 258's
`/etc/profile.d/80-systemd-osc-context.sh` wraps every command of an interactive bash
in OSC 3008 sequences, so they ended up in every value read through the shell, the
prompt line with them: `os_version` grew past 255 characters. The session now unsets
`PS0` and `PROMPT_COMMAND` right after switching the history off and reads its prompt
anew, and `_send()` strips terminal codes from what it returns.
## [0.15.0] - 2026-10-23
The first release on PyPI. It collects everything since 0.4.0, which was the last version recorded here.
### Changed
- The driver follows the NAPALM driver standard
(https://git.netork.io/NAPALM/driver-standard): CI on Gitea runs ruff, mypy, the
tests on Python 3.10–3.13 and at the lowest declared versions, bandit, pip-audit and
a build check, and a release tag publishes to PyPI. The package now ships `py.typed`
and a LICENSE file. **Python 3.9 is no longer supported**; napalm-device-types never
ran on it.
- Exceptions the driver deliberately ignores (the PTY width at login, closing a dead
session, unreadable route lines, the snmpd.conf community and port) are now logged
at debug level.
### Added
- apt's proxy through napalm-device-types' `AptProxyMixin` (NetOrk/netork#1397). `get_package_proxy()` is what `apt-config dump` says, not `00proxy` alone: a proxy in `90curtin-aptproxy` or `/etc/apt/apt.conf` wins over it, and was missed. New: `get_package_proxy_report()` (every line that sets it, per-host overrides, the https sources) and `check_package_proxy(url, expect)` (a fetch with `apt-helper`, past any proxy). `configure_package_proxy(url)` now also comments out other proxy lines, reads the result back and fetches one `InRelease` through the proxy; it fails when apt still fetches elsewhere. Reads run on the exec channel. Requires napalm-device-types 4.22.0; version 0.14.0.
- `get_host_firewall()` (napalm-device-types' `HostFirewallMixin`, NetOrk/netork#1344): the host's own netfilter rules — `nft -j list ruleset`, with the tables iptables manages taken from `iptables-save` — as chains and rules in one shape. Read-only, as root, on an exec channel (the nft JSON is one long line). Requires napalm-device-types 4.21.0; version 0.13.0.
- `get_service_packages()` (napalm-device-types' `ServicePackagesMixin`, NetOrk/netork#1236): which installed packages each systemd service is made of — the one shipping its unit file and the one shipping its `ExecStart` binary. Read-only, on an exec channel under `sh`, without sudo. Requires napalm-device-types 4.20.0; version 0.12.0.
+191
View File
@@ -0,0 +1,191 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship made available under
the License, as indicated by a copyright notice that is included in
or attached to the work (an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other transformations
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean, as submitted to the Licensor for inclusion
in the Work by the copyright owner or by an individual or Legal Entity
authorized to submit on behalf of the copyright owner. For the purposes
of this definition, "submitted" means any form of electronic, verbal,
or written communication sent to the Licensor or its representatives,
including but not limited to communication on electronic mailing lists,
source code control systems, and issue tracking systems that are managed
by, or on behalf of, the Licensor for the purpose of discussing and
improving the Work, but excluding communication that is conspicuously
marked or designated in writing by the copyright owner as "Not a
Contribution."
"Contributor" shall mean Licensor and any Legal Entity on behalf of
whom a Contribution has been received by the Licensor and incorporated
within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by the combined Contribution(s) and the Work
to which such Contribution(s) was submitted. If You institute patent
litigation against any entity (including a cross-claim or counterclaim
in a lawsuit) alleging that the Work or any Contribution embodied
within the Work constitutes direct or contributory patent infringement,
then any patent licenses granted to You under this License for that
Work shall terminate as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or Derivative
Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, You must include a readable copy of the
attribution notices contained within such NOTICE file, in
at least one of the following places: within a NOTICE text file
distributed as part of the Derivative Works; within the Source
form or documentation, if provided along with the Derivative
Works; or, within a display generated by the Derivative Works,
if and wherever such third-party notices normally appear. The
contents of the NOTICE file are for informational purposes only
and do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own license statement for Your modifications and
may provide additional grant of rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Work,
and to permit persons to whom the Work is furnished to do so,
subject to the following conditions:
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any conditions of TITLE,
MERCHANTIBILITY, or FITNESS FOR A PARTICULAR PURPOSE.
See the License for the specific language governing permissions and
limitations under the License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or exemplary damages of any character arising as a
result of this License or out of the use or inability to use the
Work (even if such Contributor has been advised of the possibility
of such damages).
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may offer only
conditions consistent with this License, subject to the following
additional conditions:
(a) You may offer additional warranty, indemnity, or other liability
terms and conditions; and
(b) You may offer support for the Work in return for a fee.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format in question. It may also be
possible to make it available with a creative commons license.
Copyright 2026 Christian Manivong
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+18 -8
View File
@@ -24,7 +24,7 @@ pip install napalm napalm-linux
Or from source:
```bash
git clone https://github.com/chrismanivong/napalm-linux
git clone https://git.netork.io/NAPALM/napalm-linux
pip install -e napalm-linux/
```
@@ -58,11 +58,11 @@ with Driver(
# OS-specific methods (from napalm-device-types OSDriver)
packages = dev.get_packages()
updates = dev.get_pending_updates()
updates = dev.get_pending_updates()
services = dev.get_services()
users = dev.get_os_users()
procs = dev.get_processes()
jobs = dev.get_cron_jobs()
users = dev.get_os_users()
procs = dev.get_processes()
jobs = dev.get_scheduled_jobs()["jobs"]
# Upgrade specific packages
result = dev.apply_updates(["openssh-server", "curl"])
@@ -108,7 +108,9 @@ with Driver(
| `manage_service(name, action)` | ✅ | systemd: start, stop, restart, enable, disable |
| `get_os_users()` | ✅ | `/etc/passwd` + `/etc/group` |
| `get_processes()` | ✅ | `ps axo` |
| `get_cron_jobs()` | ✅ | user crontabs + `/etc/cron.d/` |
| `get_scheduled_jobs()` | ✅ | `/etc/crontab`, `/etc/cron.d`, user crontabs, run-parts, anacron, systemd timers (napalm-device-types' `PosixScheduledJobsMixin`) |
| `manage_scheduled_job(key, action, digest=)` | ✅ | enable, disable, run now |
| `put_scheduled_job(spec)` / `delete_scheduled_job(key, digest=)` | ✅ | an application's own job: a systemd timer, else `/etc/cron.d`, else the user's crontab |
## Package manager auto-detection
@@ -121,7 +123,7 @@ apt → dnf → yum → apk → pacman
Force a specific package manager:
```python
optional_args={"pkg_manager": "dnf"}
optional_args = {"pkg_manager": "dnf"}
```
## SSH user permissions
@@ -136,7 +138,7 @@ The SSH user needs read access to:
| `systemctl list-unit-files`, `systemctl show` | unprivileged |
| `systemctl start/stop/restart/enable/disable` | `root`, or `sudo` (with `sudo_password`, or passwordless) |
| `apt list --upgradable` | may require `apt-get update` (root) |
| `dnf check-update` / `yum check-update` | unprivileged, but slower without cache |
| `dnf --cacheonly check-update` / `yum --cacheonly check-update` | `root` or `sudo`; reads the cache that `dnf makecache` (root) fills |
For full functionality it is recommended to run as `root` or grant passwordless `sudo` for
the above commands.
@@ -146,6 +148,14 @@ shell: the password reaches `sudo -S` on stdin, never a command line, so it show
the process list nor in a shell history. The interactive session switches its history off
before its first command.
Versions before that typed `echo '<password>' | sudo -S -p "" <command>` into the interactive
shell, so the login user's history kept the password once per command.
`get_history_sudo_lines()` counts those lines per history file without reading them, and
`remove_history_sudo_lines()` deletes exactly them and gives `/etc/snmp/snmpd.conf` and
`/etc/apt/apt.conf.d/00proxy` back to root where they were left to the login user
(napalm-device-types' `SudoHistoryMixin`). Rotate the sudo password afterwards: backups,
snapshots and audit logs may still hold it.
`get_services()` and `manage_service()` come from napalm-device-types'
`SystemdServicesMixin`; this driver supplies only the transport. An action runs as
`timeout 45 systemctl --no-ask-password <action> -- <unit>.service`, so a unit that hangs
+73
View File
@@ -0,0 +1,73 @@
"""The packages dpkg has on a Debian-family host: the query and its parse."""
from __future__ import annotations
from napalm_device_types.models import PackageDict
#: One line per package dpkg knows, its state first (``ii``, ``rc``, ``hi``, …):
#: dpkg also lists removed packages whose configuration it still keeps (#17).
DPKG_QUERY_COMMAND = (
"dpkg-query -W -f='${db:Status-Abbrev}\\t${Package}\\t${Version}\\t${Installed-Size}"
"\\t${source:Package}\\t${source:Version}\\t${binary:Summary}\\n' 2>/dev/null"
)
#: The second letter of ``db:Status-Abbrev`` for a package whose files are gone:
#: ``n`` not installed, ``c`` only its configuration left (``rc``). Every other
#: state -- half-installed, unpacked, half-configured, awaiting triggers -- has
#: its files on disk.
_NOT_ON_DISK = frozenset("nc")
class DpkgPackageDict(PackageDict):
"""A dpkg package with the source package it was built from."""
source_package: str
source_version: str
def parse_dpkg_query(out: str) -> list[PackageDict]:
"""The packages in ``DPKG_QUERY_COMMAND``'s output whose files are on disk."""
packages: list[PackageDict] = []
for line in out.splitlines():
# Summary stays last and keeps whatever it contains: maxsplit must
# equal the number of tabs the format writes, not the field count.
status, _, line = line.partition("\t")
if status[1:2] in _NOT_ON_DISK:
continue
package = _package(line.split("\t", 5))
if package is not None:
packages.append(package)
return packages
def _package(parts: list[str]) -> DpkgPackageDict | None:
if len(parts) < 2:
return None
name = parts[0].strip()
version = parts[1].strip()
size = int(parts[2].strip()) * 1024 if len(parts) > 2 and parts[2].strip().isdigit() else 0
# Debian source package (e.g. openssh-server → openssh) for OSV matching.
source_package = parts[3].strip() if len(parts) > 3 and parts[3].strip() else name
# And its version, which is a different number from this package's.
#
# OSV states Debian ranges in *source* versions. A source package
# that ships several binaries gives each its own upstream version:
# libldb2 is 2:2.11.0+samba4.22.11+dfsg-… while its source, samba,
# is 2:4.22.11+dfsg-…. A consumer matching on source_package and
# comparing `version` compares two unrelated numbers — dpkg reads
# ldb's 2.11.0 as older than the 2:4.17.4+dfsg-1 that fixed
# CVE-2022-44640, and a host five releases past the fix was reported
# vulnerable on four packages at once.
#
# dpkg leaves this empty when it equals `Version`; so does an older
# dpkg that does not know the field at all.
source_version = parts[4].strip() if len(parts) > 4 and parts[4].strip() else version
return {
"name": name,
"version": version,
"installed": True,
"description": parts[5].strip() if len(parts) > 5 else "",
"size": size,
"source": "apt",
"source_package": source_package,
"source_version": source_version,
}
+145
View File
@@ -0,0 +1,145 @@
"""Renaming the host: static and runtime hostname, ``/etc/hosts``, cloud-init (#45)."""
from __future__ import annotations
import re
from shlex import quote as _shlex_quote
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from napalm_device_types import CommandResult
from napalm_device_types.models import FixStepOutcomeDict
#: One label of a hostname (RFC 1123): letters, digits and inner hyphens. It
#: also keeps every name ``set_hostname`` accepts safe in a root shell.
_LABEL_RE = re.compile(r"^(?!-)[A-Za-z0-9-]{1,63}(?<!-)$")
#: Names ``/etc/hosts`` keeps whatever the host was called.
_LOOPBACK_NAMES = frozenset({"localhost", "localhost.localdomain"})
#: What the host is called before the rename: its short name and its FQDN.
_OLD_NAME_COMMANDS = ("hostname", "hostname -f 2>/dev/null")
#: Without this, cloud-init's ``update_hostname`` puts the image's name back on
#: the next boot.
_CLOUD_INIT_PRESERVE = "/etc/cloud/cloud.cfg.d/99-preserve-hostname.cfg"
_CLOUD_INIT_PRESERVE_CONTENT = (
"# The hostname was set on purpose: keep it across reboots.\npreserve_hostname: true\n"
)
def _split_hostname(name: str) -> tuple[str, str | None]:
"""``(short name, FQDN or None)`` of *name*.
:raises ValueError: when *name* is not a valid hostname or FQDN.
"""
labels = name.split(".")
if len(name) > 253 or not all(_LABEL_RE.match(label) for label in labels):
raise ValueError(f"not a valid hostname: {name!r}")
return labels[0], (name if len(labels) > 1 else None)
def _renamed_line(line: str, targets: set[str], new: list[str]) -> str | None:
"""*line* of ``/etc/hosts`` with *new* where the first of *targets* stood.
The other names on it stay; ``None`` when the line names none of *targets*.
"""
entry, hash_, comment = line.partition("#")
address, *names = entry.split() or [""]
if not any(n.lower() in targets for n in names):
return None
result: list[str] = []
inserted = False
for name in names:
if name.lower() not in targets:
result.append(name)
elif not inserted:
result += new
inserted = True
tail = f" {hash_}{comment}" if hash_ else ""
return f"{address}\t{' '.join(dict.fromkeys(result))}{tail}"
def _rename_in_hosts(content: str, old_names: set[str], short: str, fqdn: str | None) -> str:
"""*content* of ``/etc/hosts`` with the host's old names replaced by the new.
Every line naming the host gets the new names. When no line names it, the
Debian ``127.0.1.1`` line takes them; a file with neither is returned
unchanged -- nothing is appended to a host that never listed itself.
"""
old = {n.lower() for n in old_names} - _LOOPBACK_NAMES
new = [fqdn, short] if fqdn else [short]
lines = content.split("\n")
renamed = [_renamed_line(line, old, new) for line in lines]
if all(r is None for r in renamed):
renamed = _renamed_self_line(lines, new)
return "\n".join(r or line for line, r in zip(lines, renamed, strict=True))
def _renamed_self_line(lines: list[str], new: list[str]) -> list[str | None]:
"""The first ``127.0.1.1`` line of *lines* naming *new* instead, the rest ``None``."""
result: list[str | None] = [None] * len(lines)
for i, line in enumerate(lines):
address, *names = line.partition("#")[0].split() or [""]
if address == "127.0.1.1" and names:
result[i] = _renamed_line(line, {n.lower() for n in names}, new)
break
return result
class HostnameMixin:
"""``set_hostname`` for a Linux host, over the driver's command channel."""
if TYPE_CHECKING:
def run_command(
self,
command: str,
*,
privileged: bool = False,
timeout: float = 60,
stdin: bytes | None = None,
) -> CommandResult: ...
def _install_file_as_root(self, path: str, content: str) -> CommandResult: ...
def _root_outcome(self, command: str, timeout: float, done: str) -> FixStepOutcomeDict: ...
def set_hostname(self, new_hostname: str) -> None:
"""Rename the host: static and runtime hostname, ``/etc/hosts``, cloud-init.
Takes a bare name or an FQDN; the hostname itself is the short name, and
an FQDN goes to ``/etc/hosts`` in front of it. ``hostnamectl`` sets it
where there is one, otherwise ``/etc/hostname`` and ``hostname(1)``.
Files are installed from a staged copy (``_install_file_as_root``).
:raises ValueError: for a name that is not a valid hostname, before
anything runs on the host.
:raises RuntimeError: when the host refuses a step; the steps before it
stay done.
"""
short, fqdn = _split_hostname(new_hostname)
old_names = {self.run_command(c, timeout=30).stdout.strip() for c in _OLD_NAME_COMMANDS}
hosts = self.run_command("cat /etc/hosts", timeout=30)
name = _shlex_quote(short)
outcome = self._root_outcome(
f"if command -v hostnamectl >/dev/null 2>&1 && hostnamectl set-hostname {name} "
f"2>/dev/null; then :; else printf '%s\\n' {name} > /etc/hostname "
f"&& hostname {name}; fi",
30,
"",
)
if not outcome["ok"]:
raise RuntimeError(outcome["output"] or "the host refused the new hostname")
if hosts.exit_code == 0:
renamed = _rename_in_hosts(hosts.stdout, old_names - {""}, short, fqdn)
if renamed != hosts.stdout:
self._install_or_raise("/etc/hosts", renamed)
if self.run_command("test -d /etc/cloud/cloud.cfg.d", timeout=30).exit_code == 0:
self._install_or_raise(_CLOUD_INIT_PRESERVE, _CLOUD_INIT_PRESERVE_CONTENT)
def _install_or_raise(self, path: str, content: str) -> None:
"""``_install_file_as_root``, raising its output when it failed."""
result = self._install_file_as_root(path, content)
if result.exit_code != 0:
reason = (result.stderr or result.stdout).strip() or f"status {result.exit_code}"
raise RuntimeError(f"hostname set, but {path} could not be written: {reason}")
+82
View File
@@ -0,0 +1,82 @@
"""Personal accounts on a Linux host, with shadow-utils (NetOrk/netork#1793).
napalm-device-types' ``LocalAccountsMixin`` runs the steps; this names the
commands. A locked account is an expired one (``usermod -L -e 1``): PAM's
account check refuses it every login, a key's too, where a ``!`` in front of
the password -- ``usermod -L`` alone -- stops only the password. Opening it
again lifts the expiry and gives the old password back.
An account whose password is removed (NetOrk/netork#2013) gets ``*`` as its
password field, which no hash matches: it logs in with a key only. Not an
empty field (``passwd -d``), which pam_unix's ``nullok`` -- on by default on
Debian and Ubuntu -- takes as "no password needed" for ``su`` and the console.
Not ``!``, which sshd takes for a locked account and refuses a key too where
PAM is off (``UsePAM no``). And not the expiry, which is the lock.
"""
from __future__ import annotations
import shlex
import time
from napalm_device_types import LocalAccountsMixin
#: What the password field holds when the account never had a password.
_NO_PASSWORD = frozenset({"", "!", "!!", "!*", "*"})
#: The password field of an account that logs in with a key only: no hash matches it.
_KEY_ONLY = "*"
class LinuxLocalAccountsMixin(LocalAccountsMixin):
ACCOUNT_SHELL = "/bin/bash"
#: Debian and Ubuntu grant ``%sudo``, the Red Hat family ``%wheel``, old Ubuntu ``%admin``.
ACCOUNT_ADMIN_GROUPS = ("sudo", "wheel", "admin")
SUDOERS_DIR = "/etc/sudoers.d"
ROOT_GROUP = "root"
def _account_create(self, name: str, password_hash: str | None) -> list[list[str]]:
password = ["-p", password_hash] if password_hash else []
return [["useradd", "-m", "-s", self.ACCOUNT_SHELL, *password, name]]
def _account_create_with_uid(self, name: str, uid: int) -> list[list[str]]:
# Below UID_MIN useradd warns and goes on: netOrk's own account is a system's.
return [["useradd", "-m", "-u", str(uid), "-s", self.ACCOUNT_SHELL, name]]
def _account_open(
self, name: str, password_hash: str | None, *, locked: bool
) -> list[list[str]]:
if password_hash:
return [["usermod", "-e", "", "-p", password_hash, name]]
# usermod -U refuses to leave an account without any password.
had_one = self._shadow(name)[1].lstrip("!") not in _NO_PASSWORD
return [["usermod", *(["-U"] if had_one else []), "-e", "", name]]
def _account_lock(self, name: str, *, locked: bool) -> list[list[str]]:
return [] if locked else [["usermod", "-L", "-e", "1", name]]
def _account_locked(self, name: str, passwd: list[str]) -> bool:
expire = self._shadow(name)[7]
# pam_unix: expired from the day sp_expire names on.
return bool(expire) and int(expire) <= int(time.time() // 86400)
def _account_leave_group(self, name: str, group: str, groups: list[str]) -> list[str]:
return ["gpasswd", "-d", name, group]
def _account_clear_password(self, name: str) -> list[list[str]]:
# usermod -p leaves the expiry -- the lock -- alone, and dates the change today,
# so pam_unix asks for no new password at the next key login.
return [["usermod", "-p", _KEY_ONLY, name]]
def _shadow(self, name: str) -> list[str]:
"""*name*'s shadow entry, split; only the lock and the expiry are looked at.
:raises RuntimeError: when it cannot be read.
"""
result = self.run_command(
shlex.join(["getent", "shadow", name]), privileged=True, timeout=30
)
fields = result.stdout.strip().split(":")
if result.exit_code != 0 or len(fields) < 9 or fields[0] != name:
reason = (result.stderr or result.stdout).strip() or f"exit {result.exit_code}"
raise RuntimeError(f"cannot read the shadow entry of {name}: {reason}")
return fields
+65
View File
@@ -0,0 +1,65 @@
"""NAPALM's ``ping()`` reply from what ``ping(8)`` prints: iputils and BusyBox, IPv4 and IPv6."""
from __future__ import annotations
import re
from shlex import quote
from typing import Any
#: iputils: ``5 packets transmitted, 5 received, +2 errors, 0% packet loss, time 4005ms``;
#: BusyBox: ``2 packets transmitted, 2 packets received, 0% packet loss`` (#15).
_SUMMARY = re.compile(
r"(\d+) packets transmitted, (\d+) (?:packets )?received,(?: [^,]*,)*? ([\d.]+)% packet loss"
)
#: iputils: ``rtt min/avg/max/mdev = 0.1/0.2/0.3/0.05 ms``;
#: BusyBox: ``round-trip min/avg/max = 0.1/0.2/0.3 ms``, without a deviation.
_RTT = re.compile(
r"(?:rtt|round-trip) min/avg/max(?:/\w+)? = ([\d.]+)/([\d.]+)/([\d.]+)(?:/([\d.]+))? ms"
)
#: One reply: ``bytes from <address>:`` or, for a name, ``bytes from <name> (<address>):``.
#: The address may be IPv6 (``2001:db8::1``, ``fe80::1%eth0``); ``icmp_seq=`` (iputils)
#: or ``seq=`` (BusyBox), and a ``ttl=`` that is not always there, come before the time.
_PROBE = re.compile(r"bytes from (?:\S+ \()?([^\s()]+?)\)?: .*?\btime=([\d.]+) ?ms")
def ping_command(
destination: str, source: str, ttl: int, timeout: int, size: int, count: int
) -> str:
"""The shell line that pings *destination*: the names quoted, the numbers numbers (#55).
:raises ValueError: for a count, timeout, size or ttl that is no number, and for a
destination or source that ping would read as an option (#63): no address or
hostname starts with ``-``.
"""
for name in (destination, source):
if name.startswith("-"):
raise ValueError(f"{name!r} would be read as a ping option, not an address")
numbers = f"-c {int(count)} -W {int(timeout)} -s {int(size)} -t {int(ttl)}"
src_opt = f" -I {quote(source)}" if source else ""
return f"ping {numbers}{src_opt} {quote(destination)} 2>&1"
def parse_ping(output: str) -> dict[str, Any]:
"""``{"success": {...}}`` for *output* with a summary line, else ``{"error": output}``."""
summary = _SUMMARY.search(output)
if not summary:
return {"error": output}
sent, received = int(summary.group(1)), int(summary.group(2))
rtt = _RTT.search(output)
rtts = [float(v) if v else 0.0 for v in rtt.groups()] if rtt else [0.0] * 4
results = [
{"ip_address": probe.group(1), "rtt": float(probe.group(2))}
for probe in map(_PROBE.search, output.splitlines())
if probe
]
return {
"success": {
"probes_sent": sent,
"packet_loss": sent - received,
"rtt_min": rtts[0],
"rtt_avg": rtts[1],
"rtt_max": rtts[2],
"rtt_stddev": rtts[3],
"results": results,
}
}
+106
View File
@@ -0,0 +1,106 @@
"""Routes from ``ip route show``, one address family at a time."""
from __future__ import annotations
import re
from collections.abc import Iterator
from typing import NamedTuple
#: The command per family. ``ip -6 route show`` names its default route ``default``
#: as well, so only the command a line came from says which family it is (#6).
IP_ROUTE_COMMANDS = {"ipv4": "ip -4 route show", "ipv6": "ip -6 route show"}
_DEFAULT = {"ipv4": "0.0.0.0/0", "ipv6": "::/0"}
_HOST_PREFIX = {"ipv4": "/32", "ipv6": "/128"}
#: The route types ``ip route`` prints in front of the destination; a unicast route
#: carries none (#57).
_ROUTE_TYPES = frozenset(
{
"unicast",
"local",
"broadcast",
"anycast",
"multicast",
"blackhole",
"unreachable",
"prohibit",
"throw",
"nat",
"xresolve",
}
)
#: Route types that send nothing out of an interface: no next hop, and no outgoing
#: interface either, though IPv6 names ``lo`` for them.
_NO_FORWARDING = frozenset({"blackhole", "unreachable", "prohibit", "throw"})
#: The line a multipath route's next hops start with, one each, after the route.
_NEXTHOP = "nexthop"
#: ``via 192.0.2.1``, or with the gateway's family in front: ``via inet6 fe80::1`` for an
#: IPv4 route with an IPv6 next hop (RFC 8950, #65).
_VIA = re.compile(r"via\s+(?:inet6?\s+)?(\S+)")
_DEV = re.compile(r"dev\s+(\S+)")
_PROTO = re.compile(r"proto\s+(\S+)")
_METRIC = re.compile(r"metric\s+(\d+)")
class IpRoute(NamedTuple):
"""One route of ``ip route show``; a multipath route is one per next hop."""
network: str
proto: str
nexthop: str
iface: str
metric: int
route_type: str = "unicast"
@property
def attributes(self) -> dict[str, str]:
"""NAPALM's ``protocol_attributes`` for this route: its type, unless unicast."""
return {} if self.route_type == "unicast" else {"type": self.route_type}
def parse_ip_route(out: str, family: str) -> Iterator[IpRoute]:
"""The routes in *out*, the output of ``IP_ROUTE_COMMANDS[family]``."""
route = ""
hops: list[str] = []
for line in out.splitlines():
line = line.strip()
if not line or line.startswith("#"):
continue
if line.split(None, 1)[0] == _NEXTHOP:
hops.append(line)
continue
if route:
yield from _routes(route, hops, family)
route, hops = line, []
if route:
yield from _routes(route, hops, family)
def with_length(prefix: str) -> str:
"""*prefix* with a prefix length: a host route without one is ``/32`` or ``/128``
by the address's family (#64)."""
if "/" in prefix:
return prefix
return prefix + _HOST_PREFIX["ipv6" if ":" in prefix else "ipv4"]
def _routes(line: str, hops: list[str], family: str) -> Iterator[IpRoute]:
"""The route *line* with its multipath next-hop lines *hops*: one per next hop."""
words = line.split()
route_type = words.pop(0) if words[0] in _ROUTE_TYPES and len(words) > 1 else "unicast"
network = _DEFAULT[family] if words[0] == "default" else words[0]
if "/" not in network:
network += _HOST_PREFIX[family]
proto = _first(_PROTO, line) or "kernel"
metric = int(_first(_METRIC, line) or 0)
if route_type in _NO_FORWARDING:
yield IpRoute(network, proto, "", "", metric, route_type)
return
for hop in hops or [line]:
yield IpRoute(network, proto, _first(_VIA, hop), _first(_DEV, hop), metric, route_type)
def _first(pattern: re.Pattern[str], line: str) -> str:
match = pattern.search(line)
return match.group(1) if match else ""
+97
View File
@@ -0,0 +1,97 @@
"""The interactive shell netmiko opens, made fit to be read before the first command."""
from __future__ import annotations
import logging
import re
from shlex import quote
from typing import Any
logger = logging.getLogger(__name__)
#: The end of a command's output when nothing better is known: a line that looks
#: like a shell prompt.
PROMPT_RE = r"[#$\>]\s*$"
#: A command ending in ``echo __NAME=$?`` reports its exit status on a line of its
#: own: the driver's ``_RC_MARKER``, ``__APT_RC=`` and ``__SVC_RC=`` in
#: napalm-device-types.
STATUS_ECHO_RE = re.compile(r"echo\s+(__[A-Z_]+=)\$\?")
#: The same echo as the last command of a line: ``sudo_without_password`` keeps it
#: outside sudo.
_TRAILING_STATUS_ECHO_RE = re.compile(r";\s*echo\s+__[A-Z_]+=\$\?\s*$")
def expect_for(command: str) -> str:
"""The pattern that ends *command*'s output.
netmiko stops reading as soon as the pattern matches what it has read so far.
A line the command prints can end in ``#``, ``$`` or ``>`` -- apt's
``<ftpmaster@ubuntu.com>`` after a bad signature -- and was taken for the
prompt: half the output came back, and the rest started the next command's
(#615). A command that echoes its exit status is read until that marker, with
a number, and the prompt line after it. The echoed command line carries a
literal ``$?`` and cannot match.
"""
markers: list[str] = STATUS_ECHO_RE.findall(command)
if not markers:
return PROMPT_RE
return re.escape(markers[-1]) + r"\d+\s*\n.*" + PROMPT_RE
def sudo_without_password(command: str) -> str:
"""The line that runs all of *command* as root through ``sudo -n`` (#56).
The command goes to ``sh -c`` as one argument: ``sudo -n <command>`` covered only
its first simple command, and one that starts with a brace group did not parse.
A status echo at its end stays outside and reports sh's status, the command's:
it arrives when sudo refuses as well, where netmiko would otherwise wait for it
until the read timeout.
"""
echo = _TRAILING_STATUS_ECHO_RE.search(command)
body, tail = (command[: echo.start()], echo.group()) if echo else (command, "")
return f"sudo -n sh -c {quote(body)}{tail}"
#: Sent before anything else in the interactive session (NetOrk/netork#1039):
#: the shell writes no history file and records nothing more. The leading space
#: keeps this line itself out of a history under ``HISTCONTROL=ignorespace``;
#: a shell without ``set -o history`` (dash) only complains, to /dev/null.
HISTORY_OFF = " unset HISTFILE; set +o history 2>/dev/null; true"
#: Sent right after ``HISTORY_OFF`` (#41): systemd 258's
#: ``/etc/profile.d/80-systemd-osc-context.sh`` wraps every command in OSC 3008
#: sequences from ``PS0`` and ``PROMPT_COMMAND``, each with a fresh UUID. It appends
#: to ``PROMPT_COMMAND`` as an array, so only ``unset`` removes its hook.
PROMPT_HOOKS_OFF = " unset PS0 PROMPT_COMMAND; true"
#: Keeps the PTY from wrapping long output lines (e.g. docker JSON).
NO_LINE_WRAP = "stty cols 10000 2>/dev/null || true"
def prepare_shell(device: Any, hostname: str) -> None:
"""Make netmiko's fresh shell *device* fit to read, one step at a time.
A step the shell refuses is logged and skipped: none of them is worth
failing the connection for.
"""
# No history before anything else is typed (NetOrk/netork#1039).
try:
device.send_command(HISTORY_OFF, expect_string=PROMPT_RE)
except Exception:
logger.debug("Could not switch the shell history off on %s", hostname, exc_info=True)
# No systemd OSC 3008 context around every command (#41). netmiko learned
# the prompt with those sequences in front, and a prompt carrying a fresh
# UUID never matches again, so it reads the prompt anew once they are gone.
try:
device.send_command(PROMPT_HOOKS_OFF, expect_string=PROMPT_RE)
device.set_base_prompt()
except Exception:
logger.debug("Could not switch the prompt hooks off on %s", hostname, exc_info=True)
try:
device.send_command(NO_LINE_WRAP, expect_string=PROMPT_RE)
except Exception:
logger.debug("%s: ignored", hostname, exc_info=True)
+19
View File
@@ -0,0 +1,19 @@
"""What the old ``_sudo`` left on every host it reached (NetOrk/netork#1090).
Until NetOrk/netork#1039, ``_sudo`` typed ``echo '<password>' | sudo -S -p ""
<command>`` into netmiko's interactive shell, and only the part before the first
``&&`` ran as root. napalm-device-types' ``SudoHistoryMixin`` counts and deletes
those lines and gives the files back to root; this says what to look for.
"""
from __future__ import annotations
from napalm_device_types import AptProxyMixin, SudoHistoryMixin
class LinuxSudoHistoryMixin(SudoHistoryMixin):
#: Every line the old ``_sudo`` typed carries it, with the sudo password before it.
SUDO_HISTORY_MARKER = "| sudo -S -p "
#: Written as the login user where the part that should have been root's came
#: after the first ``&&``: snmpd.conf (``configure_snmp_agent``) and apt's proxy.
SUDO_ROOT_FILES = ("/etc/snmp/snmpd.conf", AptProxyMixin.APT_PROXY_FILE)
+451 -640
View File
File diff suppressed because it is too large. Load diff
View File
Whitespace-only changes.
+48 -16
View File
@@ -1,14 +1,14 @@
[build-system]
requires = ["setuptools>=68", "wheel"]
requires = ["setuptools>=77"]
build-backend = "setuptools.build_meta"
[project]
name = "napalm-linux"
version = "0.13.0"
version = "0.17.0"
description = "NAPALM driver for generic Linux systems via SSH"
readme = "README.md"
requires-python = ">=3.9"
license = { text = "Apache-2.0" }
requires-python = ">=3.12"
license = "Apache-2.0"
authors = [
{ name = "Christian Manivong", email = "christian@manivong.de" },
]
@@ -24,43 +24,75 @@ classifiers = [
"Development Status :: 3 - Alpha",
"Intended Audience :: Developers",
"Intended Audience :: System Administrators",
"License :: OSI Approved :: Apache Software License",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Topic :: System :: Networking",
"Topic :: System :: Systems Administration",
"Typing :: Typed",
]
dependencies = [
"napalm>=4.0",
"napalm-device-types>=4.21.0",
"napalm-device-types>=4.28.0",
"netmiko>=4.0.0",
"paramiko>=5.0.0", # CVE-2026-44405
]
[project.optional-dependencies]
dev = [
"pytest",
"pytest-cov",
"black",
"ruff",
"mypy",
"pytest>=8",
"pytest-cov>=5",
"ruff>=0.6",
"mypy>=1.11",
]
[project.entry-points."napalm.drivers"]
linux = "napalm_linux:LinuxDriver"
[project.urls]
Repository = "https://github.com/chrismanivong/napalm-linux"
Repository = "https://git.netork.io/NAPALM/napalm-linux"
Issues = "https://git.netork.io/NAPALM/napalm-linux/issues"
Changelog = "https://git.netork.io/NAPALM/napalm-linux/src/branch/main/CHANGELOG.md"
[tool.setuptools.packages.find]
where = ["."]
include = ["napalm_linux*"]
[tool.setuptools.package-data]
napalm_linux = ["py.typed"]
[tool.ruff]
line-length = 100
target-version = "py39"
target-version = "py312"
[tool.ruff.lint]
select = ["E", "F", "I", "UP", "B"]
[tool.ruff.lint.per-file-ignores]
# Recorded device output keeps its lines.
"tests/**" = ["E501"]
[tool.mypy]
python_version = "3.12"
strict = true
# napalm itself is untyped, so every driver subclasses Any.
disallow_subclassing_any = false
[[tool.mypy.overrides]]
module = ["napalm.*", "netmiko.*", "paramiko.*"]
ignore_missing_imports = true
[[tool.mypy.overrides]]
# Not yet under strict mypy (quality baseline); may only shrink.
module = ["napalm_linux.linux"]
ignore_errors = true
[tool.pytest.ini_options]
testpaths = ["tests"]
[tool.coverage.run]
source = ["napalm_linux"]
[tool.coverage.report]
fail_under = 57
+26
View File
@@ -0,0 +1,26 @@
{
"coverage_floor": 57.0,
"function_complexity": {
"napalm_linux/linux.py::LinuxDriver._collect_platform_info": 24,
"napalm_linux/linux.py::LinuxDriver.get_networks": 13,
"napalm_linux/linux.py::LinuxDriver.get_route_to": 13,
"napalm_linux/linux.py::LinuxDriver.get_snmp_config": 13,
"napalm_linux/linux.py::LinuxDriver.get_vpn_tunnels": 28,
"napalm_linux/linux.py::LinuxDriver.search_packages": 26
},
"function_lines": {
"napalm_linux/linux.py::LinuxDriver._collect_platform_info": 106,
"napalm_linux/linux.py::LinuxDriver.get_networks": 52,
"napalm_linux/linux.py::LinuxDriver.get_route_to": 101,
"napalm_linux/linux.py::LinuxDriver.get_vpn_tunnels": 152,
"napalm_linux/linux.py::LinuxDriver.search_packages": 106,
"napalm_linux/linux.py::LinuxDriver.uninstall_package": 51
},
"mypy_relaxed": [
"napalm_linux.linux"
],
"python_file_lines": {
"napalm_linux/linux.py": 2048
},
"untyped_public": []
}
+3 -1
View File
@@ -70,7 +70,9 @@ class FakeTransport:
def _driver(*, root=False, sudo_password=None):
driver = LinuxDriver("h", "u", "p", optional_args={"sudo_password": sudo_password})
transport = FakeTransport()
driver._device = SimpleNamespace(remote_conn_pre=SimpleNamespace(get_transport=lambda: transport))
driver._device = SimpleNamespace(
remote_conn_pre=SimpleNamespace(get_transport=lambda: transport)
)
driver._root = root
return driver, transport
+80 -5
View File
@@ -123,21 +123,75 @@ class TestSnmpAgentSteps:
driver._install_file_as_root.assert_not_called()
_REPORT = (
"APROXY_BEGIN\n[dump]\n{dump}[parts]\n{parts}[main]\n[sources]\n"
"http://deb.debian.org/debian/dists/trixie/\nAPROXY_END\n"
)
def _host(driver, proxy="", parts="", fetched=0):
"""What the host answers on the exec channel: apt's report, then a fetch."""
ran: list[str] = []
def run_command(command, *, privileged=False, timeout=60, stdin=None):
ran.append(command)
if "apt-config dump" in command:
dump = f'Acquire::http::Proxy "{proxy}";\n' if proxy else ""
return MagicMock(exit_code=0, stdout=_REPORT.format(dump=dump, parts=parts), stderr="")
out = f"APROXY_BEGIN\n[fetch]\nGet:1 x\n[rc]\n{fetched}\nAPROXY_END\n"
return MagicMock(exit_code=0, stdout=out, stderr="")
driver.run_command = run_command
return ran
class TestPackageProxyAndEngineAccess:
def test_the_proxy_is_the_caller_s(self, driver):
driver._install_file_as_root = MagicMock(
return_value=MagicMock(exit_code=0, stdout="", stderr="")
)
_host(driver, proxy="http://cache.lan:3142")
result = driver.configure_package_proxy("http://cache.lan:3142")
assert result["success"] is True
assert result["success"] is True, result["output"]
path, content = driver._install_file_as_root.call_args.args
assert (path, content) == (
"/etc/apt/apt.conf.d/00proxy",
'Acquire::http::Proxy "http://cache.lan:3142";\n',
)
def test_it_reads_back_and_fetches_through_it(self, driver):
driver._install_file_as_root = MagicMock(
return_value=MagicMock(exit_code=0, stdout="", stderr="")
)
ran = _host(driver, proxy="http://cache.lan:3142")
result = driver.configure_package_proxy("http://cache.lan:3142")
# The steps napalm-device-types runs on this driver's transports; later ones
# (https, NetOrk/netork#1811) are the mixin's own.
steps = [s["step"] for s in result["steps"]]
assert steps[:4] == ["configure", "conflicts", "verify", "fetch"]
assert any("dists/trixie/InRelease" in c for c in ran)
def test_another_file_s_proxy_is_commented_out_as_root(self, driver):
driver._install_file_as_root = MagicMock(
return_value=MagicMock(exit_code=0, stdout="", stderr="")
)
_host(
driver,
proxy="http://cache.lan:3142",
parts='/etc/apt/apt.conf.d/90curtin-aptproxy:1:Acquire::http::Proxy "http://old:3128";\n',
)
ran = []
driver._sudo_status = lambda command, read_timeout=100: ran.append(command) or ("", 0)
driver.configure_package_proxy("http://cache.lan:3142")
assert ran and ran[0].startswith("sed -i -e '1{")
assert ran[0].endswith("/etc/apt/apt.conf.d/90curtin-aptproxy")
def test_a_proxy_url_that_would_break_the_file_is_refused(self, driver):
driver._install_file_as_root = MagicMock()
@@ -151,6 +205,15 @@ class TestPackageProxyAndEngineAccess:
assert driver.configure_package_proxy("http://cache.lan:3142")["success"] is False
def test_the_proxy_answers_past_apt_s_proxy(self, driver):
out = "APROXY_BEGIN\n[fetch]\nGet:1 x\n[rc]\n0\n[match]\n3\nAPROXY_END\n"
driver.run_command = MagicMock(return_value=MagicMock(exit_code=0, stdout=out, stderr=""))
result = driver.check_package_proxy("http://c:3142/acng-report.html", expect="Cache")
assert result == {"reachable": True, "expected": True, "error": ""}
assert "Proxy::c=DIRECT" in driver.run_command.call_args.args[0]
def test_engine_access_for_the_user_the_caller_names(self, driver):
ran = []
driver._sudo_status = lambda command, read_timeout=100: ran.append(command) or ("", 0)
@@ -188,7 +251,7 @@ def test_every_annotation_resolves():
import inspect
import typing
for name, member in inspect.getmembers(LinuxDriver, inspect.isfunction):
for _name, member in inspect.getmembers(LinuxDriver, inspect.isfunction):
if member.__module__ == "napalm_linux.linux":
typing.get_type_hints(member)
@@ -203,7 +266,9 @@ class TestManagementPeer:
return d
def test_the_client_side_of_ssh_connection(self):
assert self._driver("10.7.224.20 51234 10.0.0.5 22\n").get_management_peer() == "10.7.224.20"
assert (
self._driver("10.7.224.20 51234 10.0.0.5 22\n").get_management_peer() == "10.7.224.20"
)
def test_an_ipv6_client(self):
assert self._driver("fd00::20 51234 fd00::5 22\n").get_management_peer() == "fd00::20"
@@ -220,16 +285,26 @@ class TestFactsNotWarnings:
assert "get_device_warnings" not in vars(LinuxDriver)
def test_the_package_proxy_apt_fetches_through(self, driver):
driver._send = lambda command, read_timeout=100: 'Acquire::http::Proxy "http://c:3142";'
_host(driver, proxy="http://c:3142")
assert driver.get_package_proxy() == "http://c:3142"
def test_no_proxy_set(self, driver):
driver._send = lambda command, read_timeout=100: ""
_host(driver)
assert driver.get_package_proxy() is None
def test_where_apt_s_proxy_is_set(self, driver):
_host(
driver,
proxy="http://old:3128",
parts='/etc/apt/apt.conf.d/90curtin-aptproxy:1:Acquire::http::Proxy "http://old:3128";\n',
)
report = driver.get_package_proxy_report()
assert report["settings"][0]["file"] == "/etc/apt/apt.conf.d/90curtin-aptproxy"
def test_not_an_apt_host(self, driver):
driver._pkg_manager = "dnf"
assert driver.get_package_proxy() is None
assert driver.get_package_proxy_report() is None
def test_the_applications_proxy_url_is_no_argument_any_more(self):
d = LinuxDriver("h", "admin", "p", optional_args={"apt_proxy_url": "http://c:3142"})
+801 -118
View File
File diff suppressed because it is too large. Load diff
+232
View File
@@ -0,0 +1,232 @@
"""get_lldp_neighbors: every neighbour of a port, its chassis MAC and its port (#58).
lldpd's ``lldpctl -f keyvalue`` is parsed by napalm-device-types'
``parse_lldpctl_keyvalue``. Before, the driver grouped the lines by interface,
so a second neighbour on a port overwrote the first; it looked for
``chassis.id.subtype``/``chassis.id.value`` and ``port.id.value``, keys lldpd
never prints, so the chassis MAC was never reported and a port given by MAC or
local id came back empty; and it cut ``eth0.100`` at its dot.
#66: the running check took systemctl's ``inactive`` for running, and a failed
lldpctl read as no neighbours.
"""
from __future__ import annotations
import subprocess
import pytest
from napalm_device_types import LLDPCTL_KEYVALUE_COMMAND
from napalm_linux.linux import LinuxDriver
_RC = "__LLDPCTL_RC"
# Laid out the way lldpd's keyvalue writer prints ``show neighbors details``
# (src/client/display.c, kv_writer.c): every neighbour opens with ``via``, an id
# is printed under its type. Not recorded from a device. On eth0 a phone and the
# PC behind it (an unmanaged switch between them and the host), on the VLAN
# interface eth0.100 a switch that names its port by a local id.
LLDPCTL_KEYVALUE = """\
lldp.eth0.via=LLDP
lldp.eth0.rid=1
lldp.eth0.age=0 day, 00:10:00
lldp.eth0.chassis.mac=00:11:22:33:44:AA
lldp.eth0.chassis.name=desk-phone
lldp.eth0.chassis.descr=SIP phone
lldp.eth0.chassis.Tel.enabled=on
lldp.eth0.port.mac=00:11:22:33:44:aa
lldp.eth0.port.descr=WAN
lldp.eth0.port.ttl=120
lldp.eth0.via=LLDP
lldp.eth0.rid=2
lldp.eth0.age=0 day, 00:09:00
lldp.eth0.chassis.mac=00:11:22:33:44:bb
lldp.eth0.chassis.name=desk-pc
lldp.eth0.chassis.Station.enabled=on
lldp.eth0.port.ifname=eno1
lldp.eth0.port.ttl=120
lldp.eth0.100.via=LLDP
lldp.eth0.100.rid=3
lldp.eth0.100.age=1 day, 02:00:00
lldp.eth0.100.chassis.local=access-sw-01
lldp.eth0.100.chassis.name=access-sw
lldp.eth0.100.chassis.Bridge.enabled=on
lldp.eth0.100.port.local=gi1/0/7
lldp.eth0.100.port.descr=GigabitEthernet1/0/7
"""
#: Shell stubs for the host's lldpd state: ``systemctl`` and ``service`` as a
#: systemd host answers them, ``pgrep`` as procps does.
_RUNNING = (
"systemctl() { case $* in *--quiet*) ;; *) echo active ;; esac; return 0; }; "
"service() { echo ' Active: active (running)'; return 0; }; "
"pgrep() { return 0; }; "
)
_STOPPED = (
"systemctl() { case $* in *--quiet*) ;; *) echo inactive ;; esac; return 3; }; "
"service() { echo ' Active: inactive (dead)'; return 3; }; "
"pgrep() { return 1; }; "
)
_FAILED = (
"systemctl() { case $* in *--quiet*) ;; *) echo failed ;; esac; return 3; }; "
"service() { echo ' Active: failed (Result: exit-code)'; return 3; }; "
"pgrep() { return 1; }; "
)
#: No systemd, lldpd started by its init script: only pgrep finds it.
_RUNNING_WITHOUT_SYSTEMD = (
"systemctl() { return 127; }; service() { return 1; }; pgrep() { return 0; }; "
)
def _shell(stubs: str, command: str) -> str:
"""What *command* prints in ``sh`` with the state commands stubbed out."""
done = subprocess.run( # a local sh, no network
["sh", "-c", stubs + command], capture_output=True, text=True, check=False, timeout=10
)
return done.stdout.strip()
def _answer(
driver: LinuxDriver,
lldpctl: str,
*,
installed: bool = True,
state: str = _RUNNING,
lldpctl_error: str = "",
lldpctl_status: int = 0,
):
"""Answer ``_send`` the way the host's shell would.
lldpctl prints *lldpctl* on stdout, *lldpctl_error* on stderr and exits with
*lldpctl_status*; the redirections and the status echo of the command sent
decide what of that comes back.
"""
sent: list[str] = []
def send(command: str, read_timeout: float = 100) -> str:
sent.append(command)
if command.startswith("command -v lldpctl"):
return "/usr/sbin/lldpctl" if installed else ""
if "lldpd" in command and "lldpctl" not in command:
return _shell(state, command)
if command.startswith("lldpctl"):
out = lldpctl
if "2>&1" in command:
out += lldpctl_error
if f"echo {_RC}" in command:
out += f"\n{_RC}={lldpctl_status}"
return out.strip()
raise AssertionError(f"unexpected command {command!r}")
driver._send = send # type: ignore[method-assign]
return sent
@pytest.fixture()
def driver() -> LinuxDriver:
return LinuxDriver.__new__(LinuxDriver)
class TestNeighbours:
def test_every_neighbour_of_a_port_is_reported(self, driver):
_answer(driver, LLDPCTL_KEYVALUE)
result = driver.get_lldp_neighbors()
assert [n["hostname"] for n in result["eth0"]] == ["desk-phone", "desk-pc"]
def test_the_chassis_mac_is_reported_in_lower_case(self, driver):
_answer(driver, LLDPCTL_KEYVALUE)
phone, pc = driver.get_lldp_neighbors()["eth0"]
assert phone["mac"] == "00:11:22:33:44:aa"
assert pc["mac"] == "00:11:22:33:44:bb"
def test_a_port_given_by_mac_or_local_id_is_reported(self, driver):
_answer(driver, LLDPCTL_KEYVALUE)
result = driver.get_lldp_neighbors()
assert result["eth0"][0]["port"] == "00:11:22:33:44:aa"
assert result["eth0"][1]["port"] == "eno1"
assert result["eth0.100"][0]["port"] == "gi1/0/7"
def test_a_dotted_interface_name_stays_whole(self, driver):
_answer(driver, LLDPCTL_KEYVALUE)
assert sorted(driver.get_lldp_neighbors()) == ["eth0", "eth0.100"]
def test_a_chassis_not_named_by_a_mac_has_no_mac(self, driver):
_answer(driver, LLDPCTL_KEYVALUE)
assert driver.get_lldp_neighbors()["eth0.100"] == [
{"hostname": "access-sw", "port": "gi1/0/7"}
]
def test_a_chassis_mac_that_is_no_mac_address_is_left_out(self, driver):
_answer(driver, "lldp.eth0.via=LLDP\nlldp.eth0.chassis.mac=00:11\n")
assert driver.get_lldp_neighbors() == {"eth0": [{"hostname": "", "port": ""}]}
class TestWithoutLldpd:
def test_without_lldpctl_there_are_no_neighbours(self, driver):
sent = _answer(driver, LLDPCTL_KEYVALUE, installed=False)
assert driver.get_lldp_neighbors() == {}
assert not any(c.startswith("lldpctl") for c in sent)
def test_lldpd_without_neighbours_lists_none(self, driver):
_answer(driver, "")
assert driver.get_lldp_neighbors() == {}
class TestLldpdState:
"""Only a running lldpd is asked; a stopped one is no neighbours (#66)."""
@pytest.mark.parametrize("state", [_STOPPED, _FAILED], ids=["inactive", "failed"])
def test_a_stopped_lldpd_is_not_asked(self, driver, state):
sent = _answer(driver, LLDPCTL_KEYVALUE, state=state)
assert driver.get_lldp_neighbors() == {}
assert not any(c.startswith("lldpctl") for c in sent)
@pytest.mark.parametrize(
"state", [_RUNNING, _RUNNING_WITHOUT_SYSTEMD], ids=["systemd", "without-systemd"]
)
def test_a_running_lldpd_is_asked(self, driver, state):
_answer(driver, LLDPCTL_KEYVALUE, state=state)
assert sorted(driver.get_lldp_neighbors()) == ["eth0", "eth0.100"]
class TestFailedRead:
"""With lldpd running, a failed lldpctl raises instead of reading as none (#66)."""
def test_lldpctl_is_asked_with_its_exit_status(self, driver):
sent = _answer(driver, LLDPCTL_KEYVALUE)
driver.get_lldp_neighbors()
assert sent[-1] == LLDPCTL_KEYVALUE_COMMAND
def test_an_unreachable_lldpd_raises(self, driver):
_answer(
driver,
"",
lldpctl_error="[WARN/control] unable to connect to socket /run/lldpd.socket: "
"Permission denied",
lldpctl_status=1,
)
with pytest.raises(ValueError, match="Permission denied"):
driver.get_lldp_neighbors()
def test_lldpctl_without_neighbours_lists_none(self, driver):
_answer(driver, "")
assert driver.get_lldp_neighbors() == {}
+215
View File
@@ -0,0 +1,215 @@
"""Personal accounts on a Linux host (NetOrk/netork#1793).
napalm-device-types' ``LocalAccountsMixin`` runs the steps; the driver names
shadow-utils' commands. A locked account is an expired one (``usermod -e 1``):
PAM refuses it a key login too, where a ``!`` in front of the password alone
stops only the password.
"""
from __future__ import annotations
import shlex
import time
import pytest
from napalm_device_types import CommandResult, LocalAccountsMixin
from napalm_linux import LinuxDriver
HASH = "$6$salt$" + "x" * 86
_TODAY = int(time.time() // 86400)
class _Driver(LinuxDriver):
"""A Linux driver whose host answers ``getent shadow`` with *shadow*."""
def __init__(self, shadow: str = "alice:$6$old:20000:0:99999:7:::") -> None:
super().__init__("host", "netadmin", "pw")
self.shadow = shadow
self.ran: list[tuple[str, bool]] = []
def run_command(self, command, *, privileged=False, timeout=60, stdin=None):
self.ran.append((command, privileged))
if command == "getent shadow alice":
return CommandResult(self.shadow + "\n", "", 0 if self.shadow else 2)
return CommandResult("", "", 0)
def _passwd() -> list[str]:
return "alice:x:1001:1001::/home/alice:/bin/bash".split(":")
def test_a_linux_host_can_add_and_lock_personal_accounts() -> None:
assert issubclass(LinuxDriver, LocalAccountsMixin)
assert LinuxDriver.ACCOUNT_PASSWORD_SCHEME == "sha512"
assert LinuxDriver.ACCOUNT_SHELL == "/bin/bash"
# Debian and Ubuntu grant %sudo, the Red Hat family %wheel, old Ubuntu %admin.
assert set(LinuxDriver.ACCOUNT_ADMIN_GROUPS) == {"sudo", "wheel", "admin"}
def test_a_new_account_gets_a_home_and_bash() -> None:
d = _Driver()
assert d._account_create("alice", HASH) == [
["useradd", "-m", "-s", "/bin/bash", "-p", HASH, "alice"]
]
assert d._account_create("alice", None) == [["useradd", "-m", "-s", "/bin/bash", "alice"]]
def test_locking_expires_the_account_and_locks_its_password() -> None:
d = _Driver()
assert d._account_lock("alice", locked=False) == [["usermod", "-L", "-e", "1", "alice"]]
assert d._account_lock("alice", locked=True) == []
def test_opening_lifts_the_expiry_and_sets_the_new_password() -> None:
d = _Driver()
assert d._account_open("alice", HASH, locked=True) == [
["usermod", "-e", "", "-p", HASH, "alice"]
]
def test_opening_without_a_new_password_gives_back_the_old_one() -> None:
d = _Driver(shadow="alice:!$6$old:20000:0:99999:7::1:")
assert d._account_open("alice", None, locked=True) == [["usermod", "-U", "-e", "", "alice"]]
def test_an_account_that_never_had_a_password_keeps_it_locked() -> None:
# usermod -U refuses to leave an account without a password.
for field in ("!", "!!", "!*", "*"):
d = _Driver(shadow=f"alice:{field}:20000:0:99999:7::1:")
assert d._account_open("alice", None, locked=True) == [["usermod", "-e", "", "alice"]]
@pytest.mark.parametrize(
("expire", "locked"),
[("", False), ("1", True), (str(_TODAY), True), (str(_TODAY + 30), False)],
)
def test_an_expired_account_is_locked(expire: str, locked: bool) -> None:
d = _Driver(shadow=f"alice:$6$old:20000:0:99999:7::{expire}:")
assert d._account_locked("alice", _passwd()) is locked
assert d.ran == [("getent shadow alice", True)]
def test_a_shadow_that_cannot_be_read_raises() -> None:
with pytest.raises(RuntimeError, match="alice"):
_Driver(shadow="")._account_locked("alice", _passwd())
def test_leaving_a_group_is_gpasswd() -> None:
assert _Driver()._account_leave_group("alice", "sudo", ["alice", "sudo"]) == [
"gpasswd",
"-d",
"alice",
"sudo",
]
def test_netorks_own_account_is_made_with_its_uid() -> None:
"""A fixed uid on every host, below UID_MIN (NetOrk/netork#1817)."""
assert _Driver()._account_create_with_uid("netork", 900) == [
["useradd", "-m", "-u", "900", "-s", "/bin/bash", "netork"]
]
# -- what a person changes follows them (NetOrk/netork#2013) ----------------------------
ALICE_KEY = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAlice alice@laptop"
OLD_KEY = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIOld alice@lost-laptop"
OWN_KEY = "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQOwn own@desktop"
_KEYS = "/home/alice/.ssh/authorized_keys"
class _Host(LinuxDriver):
"""A Linux host with Alice's account, her key files and what ran as whom."""
def __init__(self, shadow: str, keys: str) -> None:
super().__init__("host", "netadmin", "pw")
self.shadow = shadow
self.files = {_KEYS: keys}
self.ran: list[tuple[str, bool]] = []
def run_command(self, command, *, privileged=False, timeout=60, stdin=None):
self.ran.append((command, privileged))
if stdin is not None:
self.files["/tmp/staged"] = stdin.decode()
return CommandResult("/tmp/staged", "", 0)
argv = shlex.split(command)
answers = {
"id -un": "netadmin\n",
"getent passwd alice": "alice:x:1001:1001::/home/alice:/bin/bash\n",
"getent shadow alice": self.shadow + "\n",
"id -Gn alice": "alice sudo\n",
"sudo -l -U alice": "User alice is not allowed to run sudo on host.\n",
}
if command in answers:
return CommandResult(answers[command], "", 0)
if argv[:2] == ["test", "-e"]:
return CommandResult("", "", 0 if argv[2] in self.files else 1)
if argv[:4] == ["sudo", "-n", "-u", "alice"]:
return self._as_alice(argv[4:])
return CommandResult("", "", 0)
def _as_alice(self, argv: list[str]) -> CommandResult:
if argv[0] == "cat":
return CommandResult(self.files.get(argv[-1], ""), "", 0)
if argv[0] == "install":
self.files[argv[-1]] = self.files[argv[-2]]
return CommandResult("", "", 0)
def as_root(self) -> list[list[str]]:
"""What root ran that changes something: no reads, nothing as Alice."""
reads = ("getent", "id", "test")
words = [shlex.split(c) for c, privileged in self.ran if privileged]
return [
w for w in words if w[0] not in reads and w[:2] not in (["sudo", "-n"], ["sudo", "-l"])
]
_OPEN = "alice:$6$old:20000:0:99999:7:::"
def test_clearing_the_password_is_a_star_no_hash_matches() -> None:
# Not passwd -d: an empty password and pam_unix's nullok let anyone su to it.
# Not "!": sshd without PAM takes it for a lock and refuses the key too.
# Not an expiry: that is the lock, and PAM refuses a key of an expired account.
assert _Driver()._account_clear_password("alice") == [["usermod", "-p", "*", "alice"]]
def test_a_key_only_account_opens_again_without_its_password_coming_back() -> None:
d = _Driver(shadow="alice:!*:20000:0:99999:7::1:")
assert d._account_open("alice", None, locked=True) == [["usermod", "-e", "", "alice"]]
def test_removing_the_password_runs_usermod_and_takes_sudo_away() -> None:
host = _Host(_OPEN, keys=ALICE_KEY + "\n")
result = host.add_local_account("alice", ALICE_KEY, clear_password=True)
assert result["success"], result["output"]
assert host.as_root() == [
["usermod", "-U", "-e", "", "alice"],
["rm", "-f", "--", "/etc/sudoers.d/80-account-alice"],
["gpasswd", "-d", "alice", "sudo"],
["usermod", "-p", "*", "alice"],
]
def test_a_replaced_key_is_written_out_of_the_key_file_as_the_person() -> None:
host = _Host(_OPEN, keys=f"{OLD_KEY}\n{OWN_KEY}\n")
result = host.add_local_account("alice", ALICE_KEY, replaces=[OLD_KEY])
assert result["success"], result["output"]
assert host.files[_KEYS] == f"{OWN_KEY}\n{ALICE_KEY}\n"
installs = [c for c, _ in host.ran if "install -m 600" in c]
assert installs and all(c.startswith("sudo -n -u alice install") for c in installs)
def test_a_deleted_key_goes_and_the_account_stays_open() -> None:
host = _Host(_OPEN, keys=f"{ALICE_KEY}\n{OWN_KEY}\n")
result = host.remove_local_account_keys("alice", [ALICE_KEY])
assert result["success"], result["output"]
assert host.files[_KEYS] == f"{OWN_KEY}\n"
assert host.as_root() == []
+58
View File
@@ -0,0 +1,58 @@
"""Scheduled jobs on a Linux host: napalm-device-types' POSIX implementation (#67).
The report, its parse and every write are ``PosixScheduledJobsMixin``'s; the
driver carries the command across ``run_command``, as root, in one round trip.
"""
from __future__ import annotations
from unittest.mock import MagicMock
from napalm_device_types import CommandResult, PosixScheduledJobsMixin
from napalm_linux import LinuxDriver
REPORT = """SJ_BEGIN
[system /etc/cron.d/certbot]
|0 */12 * * * root certbot -q renew
[tz]
/usr/share/zoneinfo/Europe/Berlin
[owners]
certbot: /etc/cron.d/certbot
SJ_END
"""
def _driver() -> LinuxDriver:
driver = LinuxDriver("host", "user", "pw")
driver.run_command = MagicMock(return_value=CommandResult(REPORT, "", 0)) # type: ignore[method-assign]
return driver
def test_a_linux_host_offers_every_verb():
assert issubclass(LinuxDriver, PosixScheduledJobsMixin)
for verb in (
"get_scheduled_jobs",
"manage_scheduled_job",
"put_scheduled_job",
"delete_scheduled_job",
):
assert callable(getattr(LinuxDriver, verb))
def test_the_jobs_are_read_as_root_in_one_round_trip():
driver = _driver()
reading = driver.get_scheduled_jobs()
assert reading["time_zone"] == "Europe/Berlin"
(job,) = reading["jobs"]
assert (job["run_as"], job["managed_by"], job["command"]) == (
"root",
"package",
"certbot -q renew",
)
driver.run_command.assert_called_once()
assert driver.run_command.call_args.kwargs["privileged"] is True
def test_the_old_cron_reader_is_gone():
assert not hasattr(LinuxDriver, "get_cron_jobs")
+289
View File
@@ -0,0 +1,289 @@
"""``set_hostname`` renames the host itself, not only what netOrk calls it (#45).
The static and runtime hostname take the short name; ``/etc/hosts`` follows, so
the host still resolves its own name; and a cloud-init host is told to keep the
name, or its next boot puts the image's name back. Every file root writes is
staged without privilege first, as ``_install_file_as_root`` does for the fixes.
"""
from __future__ import annotations
import shlex
from types import SimpleNamespace
from unittest.mock import MagicMock
import pytest
from napalm_linux import LinuxDriver
from napalm_linux._hostname import _rename_in_hosts, _split_hostname
_PW = "pw-45"
_STAGED = "/tmp/netork-stage.Xy34Zw"
_HOSTS = "127.0.0.1\tlocalhost\n127.0.1.1\told.example.net old\n\n::1 localhost ip6-localhost\n"
class Host:
"""The host's exec channels: every line, its stdin, and whether it ran as root."""
def __init__(self, *, hosts=_HOSTS, cloud_init=False, rename_status=0, hosts_status=0):
self.runs: list[SimpleNamespace] = []
self.hosts = hosts
self.cloud_init = cloud_init
self.rename_status = rename_status
self.hosts_status = hosts_status
def open_session(self):
return _Channel(self)
def answer(self, command: str, script: str) -> tuple[str, int]:
if command.startswith("sudo -n "):
return "sudo: a password is required\n", 1
if script == "hostname":
return "old\n", 0
if script.startswith("hostname -f"):
return "old.example.net\n", 0
if script == "cat /etc/hosts":
return self.hosts, 0
if script.startswith("test -d /etc/cloud"):
return "", 0 if self.cloud_init else 1
if "mktemp" in script:
return _STAGED, 0
if "hostnamectl" in script:
return (
"hostname: you must be root\n" if self.rename_status else ""
), self.rename_status
if "/etc/hosts" in script and "install" in script:
return ("install: cannot create\n" if self.hosts_status else ""), self.hosts_status
return "", 0
@property
def root_scripts(self) -> list[str]:
return [run.script for run in self.runs if run.root]
def staged(self) -> list[bytes]:
return [run.stdin for run in self.runs if "mktemp" in run.script]
class _Channel:
def __init__(self, host: Host):
self._host = host
self._run: SimpleNamespace | None = None
self._out = b""
self._status = 0
def exec_command(self, command):
assert _PW not in command
root = command.startswith(("sudo ", "sh -c "))
parts = shlex.split(command)
script = parts[parts.index("-c") + 1] if root else command
script = script.removeprefix("exec </dev/null; ")
self._run = SimpleNamespace(line=command, script=script, root=root, stdin=b"")
self._host.runs.append(self._run)
output, self._status = self._host.answer(command, script)
self._out = output.encode()
def settimeout(self, timeout):
pass
def sendall(self, data):
self._run.stdin += data
def shutdown_write(self):
pass
def close(self):
pass
def recv_ready(self):
return bool(self._out)
def recv(self, size):
chunk, self._out = self._out[:size], self._out[size:]
return chunk
def recv_stderr_ready(self):
return False
def recv_stderr(self, size):
return b""
def exit_status_ready(self):
return not self._out
def recv_exit_status(self):
return self._status
def _driver(host: Host, *, sudo_password: str | None = _PW) -> LinuxDriver:
optional_args = {"sudo_password": sudo_password} if sudo_password else {}
driver = LinuxDriver("h", "admin", "p", optional_args=optional_args)
driver._device = MagicMock()
driver._device.remote_conn_pre = SimpleNamespace(get_transport=lambda: host)
driver._root = False
driver._pkg_manager = "apt"
return driver
def _hosts_written(host: Host) -> str:
"""What was staged for /etc/hosts, or "" when it was left alone."""
staged = b""
for run in host.runs:
if "mktemp" in run.script:
staged = run.stdin
elif run.root and "/etc/hosts" in run.script:
return staged.decode()
return ""
class TestSplitHostname:
@pytest.mark.parametrize(
"name, expected",
[
("web-01", ("web-01", None)),
("web-01.example.net", ("web-01", "web-01.example.net")),
("A1", ("A1", None)),
("a" * 63, ("a" * 63, None)),
],
)
def test_valid(self, name, expected):
assert _split_hostname(name) == expected
@pytest.mark.parametrize(
"name",
[
"",
"web_01",
"-web",
"web-",
"a" * 64,
".".join(["a" * 60] * 5),
"web 01",
"web;reboot",
"web.",
".web",
"web..example",
"$(id)",
],
)
def test_invalid(self, name):
with pytest.raises(ValueError):
_split_hostname(name)
class TestRenameInHosts:
def test_old_names_replaced_on_every_line_they_appear(self):
content = "127.0.0.1 localhost old\n10.0.0.5 old.example.net old # me\n"
assert _rename_in_hosts(content, {"old", "old.example.net"}, "new", "new.example.net") == (
"127.0.0.1\tlocalhost new.example.net new\n10.0.0.5\tnew.example.net new # me\n"
)
def test_other_aliases_and_lines_kept(self):
content = "# static\n127.0.1.1 old mail\n::1 localhost\n"
assert _rename_in_hosts(content, {"old"}, "new", None) == (
"# static\n127.0.1.1\tnew mail\n::1 localhost\n"
)
def test_names_compared_without_case(self):
assert _rename_in_hosts("127.0.1.1 OLD\n", {"old"}, "new", None) == "127.0.1.1\tnew\n"
def test_no_old_name_but_a_127_0_1_1_line_takes_the_new_name(self):
content = "127.0.0.1 localhost\n127.0.1.1 ubuntu\n"
assert _rename_in_hosts(content, {"old"}, "new", "new.example.net") == (
"127.0.0.1 localhost\n127.0.1.1\tnew.example.net new\n"
)
def test_neither_leaves_the_file_alone(self):
content = "127.0.0.1 localhost localhost.localdomain\n::1 localhost\n"
assert _rename_in_hosts(content, {"old"}, "new", None) == content
def test_localhost_is_never_renamed(self):
content = "127.0.0.1 localhost\n"
assert _rename_in_hosts(content, {"localhost"}, "new", None) == content
class TestSetHostname:
def test_short_name_set_as_root(self):
host = Host()
_driver(host).set_hostname("new")
rename = host.root_scripts[0]
assert "hostnamectl set-hostname new" in rename
assert "/etc/hostname" in rename and "hostname new" in rename
def test_fqdn_sets_the_short_name_and_both_in_hosts(self):
host = Host()
_driver(host).set_hostname("new.example.net")
assert "hostnamectl set-hostname new " in host.root_scripts[0]
assert "example" not in host.root_scripts[0]
assert _hosts_written(host) == (
"127.0.0.1\tlocalhost\n127.0.1.1\tnew.example.net new\n\n::1 localhost ip6-localhost\n"
)
def test_hosts_installed_from_a_staged_file_never_privileged_stdin(self):
host = Host()
_driver(host).set_hostname("new")
hosts_install = [s for s in host.root_scripts if "/etc/hosts" in s]
assert len(hosts_install) == 1
assert f"install -m 644 -o root -g root -- {_STAGED}" in hosts_install[0]
for run in host.runs:
if run.root:
assert run.stdin == f"{_PW}\n".encode()
def test_unchanged_hosts_not_rewritten(self):
host = Host(hosts="127.0.0.1 localhost\n")
_driver(host).set_hostname("new")
assert not any("/etc/hosts" in s for s in host.root_scripts)
def test_cloud_init_host_keeps_the_name(self):
host = Host(cloud_init=True)
_driver(host).set_hostname("new")
assert any(
"/etc/cloud/cloud.cfg.d/99-preserve-hostname.cfg" in s for s in host.root_scripts
)
assert any(b"preserve_hostname: true" in staged for staged in host.staged())
def test_no_cloud_init_no_drop_in(self):
host = Host()
_driver(host).set_hostname("new")
assert not any("cloud.cfg.d" in s for s in host.root_scripts)
def test_invalid_name_runs_nothing(self):
host = Host()
driver = _driver(host)
with pytest.raises(ValueError):
driver.set_hostname("new;reboot")
assert host.runs == []
driver._device.send_command.assert_not_called()
def test_failed_rename_raises_and_writes_nothing(self):
host = Host(rename_status=1)
with pytest.raises(RuntimeError):
_driver(host).set_hostname("new")
assert not any("/etc/hosts" in s for s in host.root_scripts)
def test_sudo_without_password_says_what_to_do(self):
host = Host()
with pytest.raises(RuntimeError, match="no sudo password was given"):
_driver(host, sudo_password=None).set_hostname("new")
def test_failed_hosts_write_raises(self):
host = Host(hosts_status=1)
with pytest.raises(RuntimeError, match="/etc/hosts"):
_driver(host).set_hostname("new")
+31 -2
View File
@@ -27,7 +27,9 @@ OTHER_KEY = paramiko.ECDSAKey.generate()
def _device() -> MagicMock:
device = MagicMock()
device.send_command.return_value = "/usr/bin/apt"
device.remote_conn_pre.get_transport.return_value.get_remote_server_key.return_value = SERVER_KEY
device.remote_conn_pre.get_transport.return_value.get_remote_server_key.return_value = (
SERVER_KEY
)
return device
@@ -76,7 +78,7 @@ def test_a_changed_key_is_refused():
try:
raise paramiko.BadHostKeyException("10.0.0.8", SERVER_KEY, OTHER_KEY)
except paramiko.SSHException as exc: # what netmiko does with it
raise NetmikoTimeoutException(f"A paramiko SSHException occurred: {exc}")
raise NetmikoTimeoutException(f"A paramiko SSHException occurred: {exc}") from exc
driver = _driver(seen, SshHostKey.of(OTHER_KEY))
with patch("napalm_linux.linux.ConnectHandler", side_effect=refuse):
@@ -84,3 +86,30 @@ def test_a_changed_key_is_refused():
driver.open()
assert driver._device is None
assert seen[0]["accepted"] is False
def test_a_connection_sshd_turns_away_is_tried_again(monkeypatch):
"""OpenSSH 9.8+ closes every connection from a source it has just penalised,
before its banner; the penalty ends after seconds (NetOrk/netork#1800)."""
from napalm_device_types import ssh_host_keys
slept: list[float] = []
monkeypatch.setattr(ssh_host_keys.time, "sleep", slept.append)
attempts: list[int] = []
def turned_away(**kwargs):
attempts.append(1)
if len(attempts) < 3:
try:
raise paramiko.SSHException("Error reading SSH protocol banner")
except paramiko.SSHException as exc:
raise NetmikoTimeoutException(f"A paramiko SSHException occurred: {exc}") from exc
return _device()
driver = _driver([])
with patch("napalm_linux.linux.ConnectHandler", side_effect=turned_away):
driver.open()
assert driver._device is not None
assert len(attempts) == 3
assert slept == list(ssh_host_keys.REFUSED_RETRY_WAITS[:2])
+140
View File
@@ -0,0 +1,140 @@
"""What the old ``_sudo`` left on every host, and taking it back (NetOrk/netork#1090).
Until NetOrk/netork#1039, ``_sudo`` typed ``echo '<password>' | sudo -S -p ""
<command>`` into netmiko's interactive shell: the login user's history kept the
password once per command. Where only the part before the first ``&&`` ran as
root, snmpd.conf and apt's proxy file were left to the login user. The driver
says so through napalm-device-types' ``SudoHistoryMixin``, which counts and
deletes the lines and gives the files back to root.
"""
from __future__ import annotations
import shlex
from types import SimpleNamespace
from unittest.mock import MagicMock
from napalm_device_types import SudoHistoryMixin
from napalm_linux import LinuxDriver
from napalm_linux.linux import _SNMPD_CONF
_PW = "s3cr3t"
class _Channel:
def __init__(self, transport: _Transport):
self.transport = transport
self.command = ""
self.stdin = b""
self._out = b""
def exec_command(self, command):
self.command = command
self.transport.commands.append(command)
self._out = self.transport.answer(command).encode()
def settimeout(self, timeout):
pass
def sendall(self, data):
self.stdin += data
def shutdown_write(self):
pass
def close(self):
pass
def recv_ready(self):
return bool(self._out)
def recv(self, size):
chunk, self._out = self._out[:size], self._out[size:]
return chunk
def recv_stderr_ready(self):
return False
def recv_stderr(self, size):
return b""
def exit_status_ready(self):
return not self._out
def recv_exit_status(self):
return 0
class _Transport:
def __init__(self, answers: dict[str, str]):
self.answers = answers
self.commands: list[str] = []
self.channels: list[_Channel] = []
def answer(self, command: str) -> str:
return next((out for key, out in self.answers.items() if key in command), "")
def open_session(self):
self.channels.append(_Channel(self))
return self.channels[-1]
def _driver(answers: dict[str, str]) -> tuple[LinuxDriver, _Transport]:
driver = LinuxDriver("h", "admin", "p", optional_args={"sudo_password": _PW})
transport = _Transport(answers)
driver._device = MagicMock()
driver._device.remote_conn_pre = SimpleNamespace(get_transport=lambda: transport)
driver._root = False
return driver, transport
def test_the_marker_is_what_the_old_sudo_typed():
typed = f'echo {shlex.quote(_PW)} | sudo -S -p "" apt-get update'
assert isinstance(LinuxDriver.SUDO_HISTORY_MARKER, str)
assert LinuxDriver.SUDO_HISTORY_MARKER in typed
def test_the_files_the_partial_sudo_left_to_the_login_user():
assert LinuxDriver.SUDO_ROOT_FILES == (
_SNMPD_CONF,
LinuxDriver.APT_PROXY_FILE,
)
assert LinuxDriver.APT_PROXY_FILE == "/etc/apt/apt.conf.d/00proxy"
def test_it_is_the_device_types_mixin():
assert issubclass(LinuxDriver, SudoHistoryMixin)
def test_counting_runs_as_the_login_user_on_the_exec_channel():
driver, transport = _driver({"grep -c": "121 .bash_history\n0 .zsh_history\n"})
assert driver.get_history_sudo_lines() == [{"file": "~/.bash_history", "lines": 121}]
# No sudo, no password on stdin, nothing typed into the interactive shell
# (whose history is where the lines came from).
assert not transport.channels[-1].command.startswith("sudo")
assert transport.channels[-1].stdin == b""
driver._device.send_command.assert_not_called()
def test_the_owner_fix_runs_as_root_without_stdin_but_the_password():
driver, transport = _driver(
{
"sed -i": "done 3 0 .bash_history\n",
"id -u": "1000\nadmin\n",
"chown": "fixed /etc/snmp/snmpd.conf\n",
}
)
result = driver.remove_history_sudo_lines()
assert result["success"] is True
assert result["removed"] == 3
assert result["owners_restored"] == ["/etc/snmp/snmpd.conf"]
root = [c for c in transport.channels if c.command.startswith("sudo -S")]
assert len(root) == 1 and "chown -h 0:0" in root[0].command
# sudo -S reads the password, and the command itself reads nothing.
assert root[0].stdin == f"{_PW}\n".encode()
assert all(c.stdin == b"" for c in transport.channels if c is not root[0])
+2 -2
View File
@@ -21,7 +21,7 @@ from unittest.mock import MagicMock, patch
import pytest
from napalm_linux import LinuxDriver
from napalm_linux.linux import _HISTORY_OFF
from napalm_linux._shell import HISTORY_OFF as _HISTORY_OFF
_PW = "s3cr3t 'q' $x"
@@ -30,7 +30,7 @@ class Channel:
"""An exec channel answering with *output* and *status*; it refuses a line
that holds the password, which is what ``ps`` would show."""
def __init__(self, host: "Transport"):
def __init__(self, host: Transport):
self.host = host
self.command = ""
self.stdin = b""
+199
View File
@@ -0,0 +1,199 @@
"""Without a sudo password the whole command runs as root, in one ``sh -c`` (#56).
A login that is not root and has no sudo password (NOPASSWD sudo, e.g. netOrk's
own account from NetOrk/netork#1817) types its privileged commands into the
interactive shell. ``sudo -n <command>`` covered only the first simple command of
the line, and a command that starts with a brace group did not even parse:
``sudo -n { LC_ALL=C dnf …; echo __DNF_RC=$?; } | cat`` is a syntax error, so dnf's
and yum's security advisories were always unknown.
The command now goes to ``sudo -n sh -c`` as one argument, as ``_as_root`` does.
A status echo at its end (``; echo __NETORK_RC=$?``) stays outside: it reports
sh's status, which is the command's, and still arrives when sudo refuses.
"""
from __future__ import annotations
import re
import shutil
import subprocess
from pathlib import Path
from shlex import quote
from unittest.mock import MagicMock
import pytest
from napalm_device_types import DNF_SECURITY_COMMAND
from napalm_linux import LinuxDriver
from napalm_linux.linux import _YUM_SECURITY_COMMAND
BASH = shutil.which("bash")
needs_bash = pytest.mark.skipif(BASH is None, reason="needs bash")
#: dnf's answer on a Fedora 40 host with one pending security advisory.
_ADVISORY = "FEDORA-2024-1a2b3c4d5e Important/Sec. openssl-libs-1:3.1.4-2.fc40.x86_64"
def _driver(pkg_manager: str = "dnf", answers: list[str] | None = None) -> LinuxDriver:
"""A driver logged in as a user that is not root, without a sudo password."""
d = LinuxDriver.__new__(LinuxDriver)
d.hostname = "testhost"
d._sudo_password = None
d._pkg_manager = pkg_manager
d._root = False
d._device = MagicMock()
d._device.send_command.side_effect = answers or []
return d
def _sent(driver: LinuxDriver) -> list[str]:
return [c[0][0] for c in driver._device.send_command.call_args_list]
def _bash_parses(line: str) -> str:
"""bash's complaint about *line*, empty when it parses."""
assert BASH is not None
checked = subprocess.run( # noqa: S603 - a fixed interpreter, the line only parsed
[BASH, "-n", "-c", line], capture_output=True, text=True, check=False
)
return checked.stderr
class TestTheSecurityAdvisories:
@needs_bash
@pytest.mark.parametrize("manager", ["dnf", "yum"])
def test_the_line_parses(self, manager):
driver = _driver(manager, [f"{_ADVISORY}\n__DNF_RC=0\n__NETORK_RC=0"])
driver._rpm_security_names()
assert _bash_parses(_sent(driver)[0]) == ""
@pytest.mark.parametrize(
("manager", "command"), [("dnf", DNF_SECURITY_COMMAND), ("yum", _YUM_SECURITY_COMMAND)]
)
def test_all_of_it_runs_as_root_and_the_status_stays_outside(self, manager, command):
driver = _driver(manager, [f"{_ADVISORY}\n__DNF_RC=0\n__NETORK_RC=0"])
driver._rpm_security_names()
assert _sent(driver) == [f"sudo -n sh -c {quote(command)}; echo __NETORK_RC=$?"]
def test_the_advisories_are_read(self):
driver = _driver("dnf", [f"{_ADVISORY}\n__DNF_RC=0\n__NETORK_RC=0"])
assert driver._rpm_security_names() == {"openssl-libs"}
#: Every caller of ``_run_privileged``, with an answer that satisfies it.
_CALLERS = {
"reboot_host": (lambda d: d.reboot_host(), ["__NETORK_RC=0"]),
"refresh apt": (lambda d: d.refresh_available_updates(), ["__NETORK_RC=0"]),
"check-update": (
lambda d: d.get_available_updates(),
["__NETORK_RC=0", "__DNF_RC=0\n__NETORK_RC=0"],
),
"manage_service": (lambda d: d.manage_service("wg-quick@wg0", "restart"), ["__SVC_RC=0"]),
"listening sockets": (
lambda d: d._run_listening_sockets_command("sh -c 'ss -H -ltn'", privileged=True),
[""],
),
}
@needs_bash
@pytest.mark.parametrize("caller", sorted(_CALLERS))
def test_every_privileged_line_parses_and_runs_whole_as_root(caller):
call, answers = _CALLERS[caller]
driver = _driver("apt" if caller == "refresh apt" else "dnf", answers)
call(driver)
for line in _sent(driver):
assert line.startswith("sudo -n sh -c '")
assert _bash_parses(line) == ""
def test_the_service_status_stays_outside():
driver = _driver(answers=["__SVC_RC=0"])
driver.manage_service("cron", "restart")
assert _sent(driver) == [
"sudo -n sh -c 'timeout 45 systemctl --no-ask-password restart -- cron.service 2>&1';"
" echo __SVC_RC=$?"
]
def test_a_command_without_a_status_echo_is_wrapped_whole():
driver = _driver(answers=[""])
driver._run_privileged("ss -H -ltnp | sort")
assert _sent(driver) == ["sudo -n sh -c 'ss -H -ltnp | sort'"]
# ---------------------------------------------------------------------------
# The lines run in a real bash, with a stand-in sudo and package manager
# ---------------------------------------------------------------------------
_SUDO_OK = '#!/bin/sh\n[ "$1" = -n ] && shift\nexec "$@"\n'
_SUDO_REFUSES = "#!/bin/sh\necho 'sudo: a password is required' >&2\nexit 1\n"
_DNF = f"#!/bin/sh\necho '{_ADVISORY}'\n"
def _shell_host(tmp_path: Path, sudo: str) -> LinuxDriver:
"""A driver whose interactive shell is a real bash with stand-ins on its PATH.
Like netmiko, it reads until the command's expect pattern matches and fails
when it never does.
"""
for name, script in (("sudo", sudo), ("dnf", _DNF)):
stub = tmp_path / name
stub.write_text(script)
stub.chmod(0o755)
env = {"PATH": f"{tmp_path}:/usr/bin:/bin", "LC_ALL": "C"}
def send_command(command, *, expect_string, **_kwargs):
assert BASH is not None
ran = subprocess.run( # noqa: S603 - a fixed interpreter and stand-ins
[BASH, "-c", command],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT, # one stream, in order, as on the PTY
text=True,
env=env,
check=False,
)
output = f"{ran.stdout}user@host:~$ "
if not re.search(expect_string, output):
raise TimeoutError(f"pattern not detected: {expect_string!r} in {output!r}")
return output
driver = _driver("dnf")
driver._device.send_command.side_effect = send_command
return driver
@needs_bash
def test_a_real_shell_reads_the_advisories(tmp_path):
driver = _shell_host(tmp_path, _SUDO_OK)
assert driver._rpm_security_names() == {"openssl-libs"}
@needs_bash
def test_a_refused_sudo_still_reports_its_status(tmp_path):
driver = _shell_host(tmp_path, _SUDO_REFUSES)
result = driver.refresh_available_updates()
assert result["success"] is False
assert "a password is required" in result["output"]
assert "NOPASSWD" in result["output"] # the hint
@needs_bash
def test_a_refused_sudo_leaves_the_advisories_unknown(tmp_path):
driver = _shell_host(tmp_path, _SUDO_REFUSES)
assert driver._rpm_security_names() is None
+6 -5
View File
@@ -11,7 +11,8 @@ characters and netOrk could not store the poll.
from unittest.mock import MagicMock, patch
from napalm_linux.linux import _HISTORY_OFF, _PROMPT_HOOKS_OFF, LinuxDriver
from napalm_linux._shell import HISTORY_OFF, PROMPT_HOOKS_OFF
from napalm_linux.linux import LinuxDriver
#: What ``cat /etc/os-release | grep PRETTY_NAME ...`` returned through netmiko on
#: an Ubuntu 26.04.1 host (2026-10-23), the prompt line already gone.
@@ -39,13 +40,13 @@ class TestPromptHooksOff:
_opened(device)
sent = [c.args[0] for c in device.send_command.call_args_list]
assert sent[:2] == [_HISTORY_OFF, _PROMPT_HOOKS_OFF]
assert sent[:2] == [HISTORY_OFF, PROMPT_HOOKS_OFF]
def test_it_unsets_both_hooks_including_an_array_prompt_command(self):
# The script appends to PROMPT_COMMAND as an array; assigning the empty
# string would only clear element 0 and leave systemd's hook running.
assert _PROMPT_HOOKS_OFF.startswith(" ")
assert "unset PS0 PROMPT_COMMAND" in _PROMPT_HOOKS_OFF
assert PROMPT_HOOKS_OFF.startswith(" ")
assert "unset PS0 PROMPT_COMMAND" in PROMPT_HOOKS_OFF
def test_the_prompt_is_read_again_once_the_hooks_are_gone(self):
# netmiko learned the prompt with the sequences in front of it; a prompt
@@ -56,7 +57,7 @@ class TestPromptHooksOff:
_opened(device)
calls = [(c[0], c.args[0] if c.args else None) for c in device.mock_calls]
hooks_off = calls.index(("send_command", _PROMPT_HOOKS_OFF))
hooks_off = calls.index(("send_command", PROMPT_HOOKS_OFF))
assert "set_base_prompt" in [name for name, _ in calls[hooks_off + 1 :]]
def test_a_shell_that_refuses_it_does_not_stop_the_connection(self):