Commit Graph
22 Commits
Author SHA1 Message Date
Christian Manivong a37802cf88 fix(driver): load_replace_candidate is None, not a stub that raises (NetOrk/netork#2503)
driver / standard (pull_request) Successful in 16s
driver / lint (pull_request) Successful in 11s
driver / test (3.12) (pull_request) Successful in 49s
driver / types (pull_request) Successful in 51s
driver / test (3.13) (pull_request) Successful in 45s
driver / lowest (pull_request) Successful in 22s
driver / build (pull_request) Successful in 26s
driver / security (pull_request) Successful in 56s
CI / driver (pull_request) Successful in 2m13s
driver / publish (pull_request) Skipped
The driver cannot replace a device's configuration, and said so with a
load_replace_candidate that raised NotImplementedError. A method that only
raises still looks like a replace to anyone who asks whether the driver has
one: netOrk offered a config restore for these devices that could only fail.

None is how a driver switches off a method, the convention netOrk's
capability checks and napalm-device-types follow, so asking now says no.
Nothing in the driver calls it.
2026-11-13 21:45:24 +01:00
Christian Manivong b6668eddbd test(facts): check get_facts against the gateway's recorded answers (#24)
driver / standard (pull_request) Successful in 18s
driver / lint (pull_request) Successful in 16s
driver / types (pull_request) Successful in 1m5s
driver / test (3.13) (pull_request) Successful in 1m10s
driver / test (3.12) (pull_request) Successful in 1m12s
driver / lowest (pull_request) Successful in 29s
driver / build (pull_request) Successful in 31s
driver / security (pull_request) Successful in 1m5s
CI / driver (pull_request) Successful in 2m35s
driver / publish (pull_request) Skipped
get_facts read SerialNumber, HostName, SystemUpTime and MacAddress
from getBasicInformation, which a VMG4005-B50A (V5.17(ABQA.3.1)C0)
answers with model, firmware and language settings only. The code
was fixed by #26 (host name and domain from the System page) and #28
(serial number and uptime from cardpage_status); the tests still fed
it an invented getBasicInformation (MOCK_BASIC_INFO) that carried
those fields, with an invented serial number and firmware.

MOCK_BASIC_INFO is now the recorded answer, and a new test reads the
facts from the recorded, sealed status page and the System page: it
fails against the driver before #26 with the symptoms of this issue
(serial "", uptime 0, host name the connection address). The README
names the sources get_facts reads.

Closes #24
2026-11-12 19:06:53 +01:00
Christian Manivong 3213dfaaaa fix(wan): read the uplink from the gateway's status page (#29)
get_wan_status built its answer from WanIp, WanAccessType,
SystemUpTime, MaxUpstream and MaxDownstream in getBasicInformation.
A VMG4005-B50A sends none of them there, so every gateway's uplink
read as down, with no address and no sync rate; get_nat_translations
built inside_global from the same WanIp and reported ":<port>".

Both now read the DAL's cardpage_status. A bridge has no WAN address
of its own, so it is connected when its DSL line is in sync (a
DslChannelInfo entry with Status "Up"); a router is connected when a
WAN interface that is not IP_Bridged is up with an address. The sync
rates are those of the channels in sync, added up for bonded lines;
a channel out of sync keeps its last rates, which are not reported.
A translation without a WAN address goes to 0.0.0.0, and without
enabled port forwards the status page is not read at all.

The tests read the recorded, anonymised status page of a
VMG4005-B50A bridge whose line was not in sync; the in-sync and
router states are derived from it.

Closes #29
2026-11-12 19:05:48 +01:00
Christian Manivong a47f9c3970 fix(dal): decrypt the DAL's answer before reading it (#25)
A GET of the DAL answers sealed ({"content", "iv"}), like a PUT does.
_read_dal_or_page parsed the envelope as it came, so hosts, the ARP
table, port forwards and the Wi-Fi getters found nothing on every
gateway, and since nothing raised the HTML fallback never ran either.

Every DAL GET now goes through one helper that decrypts the answer,
checks for ZCFG_SUCCESS and returns its Object list; the status page
and the System page share the decryption. Hosts are read from
lanhosts and port forwards from nat, the names the gateway's web
interface uses: LAN_HOSTS and NAT_PORTMAP are answered like any
unknown name, with an empty Object. The new parsers live in
napalm_zyxel/parsers.py, under strict mypy.

Tests seal recorded, anonymised answers of a VMG4005-B50A
(V5.17(ABQA.3.1)C0) with a real ZyxelCrypto, so the driver decrypts
them. The Wi-Fi DAL names stay unverified: that gateway has no Wi-Fi.

Closes #25
2026-11-12 19:03:40 +01:00
Christian Manivong a282836bd2 test: placeholders for the serial number and MAC addresses in fixtures
driver / lint (pull_request) Successful in 16s
driver / standard (pull_request) Successful in 18s
driver / types (pull_request) Successful in 1m5s
driver / test (3.13) (pull_request) Successful in 57s
driver / test (3.12) (pull_request) Successful in 1m13s
driver / lowest (pull_request) Successful in 27s
driver / build (pull_request) Successful in 27s
driver / security (pull_request) Successful in 1m13s
CI / driver (pull_request) Successful in 2m28s
driver / publish (pull_request) Skipped
The fixtures are a real gateway's answers. Its serial number and its MAC
addresses identify that one device and do not belong in a public
repository; the tests only need values of the right shape. The MACs keep
Zyxel's OUI.
2026-11-12 18:32:40 +01:00
Christian Manivong 1fda222d56 fix(facts): read serial number and uptime from the status page
driver / lint (pull_request) Successful in 20s
driver / standard (pull_request) Successful in 20s
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 26s
driver / build (pull_request) Successful in 36s
driver / security (pull_request) Successful in 1m5s
CI / driver (pull_request) Successful in 2m23s
driver / publish (pull_request) Skipped
get_facts read SerialNumber and SystemUpTime from getBasicInformation,
which a VMG4005-B50A does not send, and reported "" and 0. The gateway
has both in DeviceInfo of the DAL's cardpage_status, the answer the
interfaces are read from. get_facts now reads that answer once and takes
the interfaces, serial number and uptime from it. Model and firmware stay
with getBasicInformation, which does carry them.

Closes #27
2026-11-12 17:19:08 +01:00
Christian Manivong 61a6e4f7ba fix(facts): read the host name from the gateway's System page
driver / standard (pull_request) Successful in 16s
driver / lint (pull_request) Successful in 13s
driver / types (pull_request) Successful in 1m8s
driver / test (3.13) (pull_request) Successful in 1m5s
driver / test (3.12) (pull_request) Successful in 1m5s
driver / lowest (pull_request) Successful in 25s
driver / build (pull_request) Successful in 29s
driver / security (pull_request) Successful in 1m15s
CI / driver (pull_request) Successful in 2m37s
driver / publish (pull_request) Skipped
get_facts read HostName from getBasicInformation, which a VMG4005-B50A
does not send, and fell back to the address the driver connects to:
netOrk kept the gateway named 192.168.1.1. The gateway's own System page
reads host name and domain with GET /cgi-bin/System?oid=snmp, sealed like
a DAL answer; get_facts now reads them there. fqdn is the host name with
its domain. A gateway with no name set reports "", and get_facts raises
when the System page cannot be read.
2026-11-12 16:42:47 +01:00
Christian Manivong ec76c1d6e8 fix(interfaces): read interfaces and addresses from the gateway's status page
driver / standard (pull_request) Failing after 15s
driver / lint (pull_request) Successful in 13s
driver / types (pull_request) Successful in 59s
driver / test (3.13) (pull_request) Successful in 52s
driver / test (3.12) (pull_request) Successful in 56s
driver / lowest (pull_request) Successful in 25s
driver / build (pull_request) Successful in 27s
driver / security (pull_request) Successful in 54s
CI / driver (pull_request) Failing after 2m1s
driver / publish (pull_request) Skipped
get_interfaces reported a fixed set: wan, lan and two Wi-Fi radios, all
up at 1000 Mbit/s, the LAN with the WAN's MAC. get_interfaces_ip gave
both a /24, the LAN's address being the hostname the driver connected
to. getBasicInformation carries none of WanIp, LanIp or MacAddress on a
VMG4005-B50A, a VDSL bridge without Wi-Fi whose LAN is a /29, and the
gateway showed all of the invented values.

Both now read the DAL's cardpage_status, which a GET answers sealed like
a PUT: the IP interfaces in WanLanInfo (br0, atm0.1, ptm0.2) with their
status, MAC and netmask, the Ethernet ports in LanInfo (eth1) with their
speed. A speed or MTU the gateway does not report is 0, unknown. IPv6
addresses are not read yet: no gateway seen so far had IPv6 on.
2026-11-12 16:14:25 +01:00
Christian Manivong fe7c3fc7f9 fix(config): leave get_config to NAPALM's stub
driver / standard (pull_request) Successful in 17s
driver / lint (pull_request) Successful in 17s
driver / types (pull_request) Successful in 57s
driver / test (3.13) (pull_request) Successful in 54s
driver / test (3.12) (pull_request) Successful in 1m0s
driver / lowest (pull_request) Successful in 25s
driver / build (pull_request) Successful in 26s
driver / security (pull_request) Successful in 1m10s
CI / driver (pull_request) Successful in 2m24s
driver / publish (pull_request) Skipped
A VMG has no configuration export. The override returned {}, so a caller
could not tell "not supported" from "read an empty configuration": netOrk
took it for a backup that came back empty and raised config_backup_failed
on every poll. Without the override NAPALM's stub raises
NotImplementedError and the getter reads as not implemented.
2026-11-12 15:28:25 +01:00
Christian Manivong e5ce4e32b1 fix(session): report is_alive from the driver's own session
driver / standard (pull_request) Successful in 19s
driver / lint (pull_request) Successful in 19s
driver / types (pull_request) Successful in 1m5s
driver / test (3.12) (pull_request) Successful in 1m3s
driver / lowest (pull_request) Successful in 34s
driver / test (3.13) (pull_request) Successful in 1m9s
driver / build (pull_request) Successful in 31s
driver / security (pull_request) Successful in 1m12s
CI / driver (pull_request) Successful in 2m53s
driver / publish (pull_request) Skipped
is_alive() opened a TCP connection to the gateway whether or not the
driver was opened, and after close() too. NAPALM's __del__ asks it of
every collected driver, so each one connected once more and could stall
for up to five seconds. Without an open session it now answers False
and connects nowhere; with one, it reports whether the gateway still
answers on its port.

Closes #19
2026-11-02 10:58:14 +01:00
Christian Manivong 745946387f fix(tests): stub is_alive so no test opens a socket
driver / standard (pull_request) Successful in 18s
driver / lint (pull_request) Successful in 15s
driver / types (pull_request) Successful in 1m9s
driver / test (3.12) (pull_request) Successful in 1m9s
driver / test (3.13) (pull_request) Successful in 1m0s
driver / lowest (pull_request) Successful in 34s
driver / build (pull_request) Successful in 33s
driver / security (pull_request) Successful in 1m14s
CI / driver (pull_request) Successful in 2m56s
driver / publish (pull_request) Skipped
NAPALM's __del__ calls is_alive(), and this driver's is_alive() opens a
TCP connection to the gateway whether or not the driver was opened or
closed, so every driver a test built connected to 192.168.1.1:80 when
it was collected. The tests now build their drivers with an is_alive()
that opens nothing (the is_alive tests call the class's method), and a
session-wide guard in conftest refuses every connection and fails the
run if anything tried one.

Closes #17
2026-11-02 10:41:58 +01:00
Christian Manivong ded19238c0 fix(dal): raise on a failed request instead of reading it as empty
driver / standard (pull_request) Successful in 17s
driver / lint (pull_request) Successful in 15s
driver / types (pull_request) Successful in 1m10s
driver / test (3.12) (pull_request) Successful in 4m10s
driver / test (3.13) (pull_request) Successful in 4m6s
driver / lowest (pull_request) Successful in 3m43s
driver / build (pull_request) Successful in 31s
driver / security (pull_request) Successful in 1m17s
CI / driver (pull_request) Successful in 5m59s
driver / publish (pull_request) Skipped
_dal_query and _fetch_page returned None for any failure, and the
getters turned that into empty data, so a timeout or an expired session
read as a gateway with no hosts, port forwards, SSIDs or Wi-Fi clients.
Both now raise: ConnectionException when the gateway does not answer or
refuses the session, RuntimeError naming the request otherwise. A getter
whose DAL request fails still reads the HTML page and raises when that
fails too; get_facts no longer swallows a failed get_interfaces.

Closes #15
2026-11-02 09:18:50 +01:00
Christian Manivong 6f9b91ae9b fix(fingerprint): tell a DAL gateway from other Zyxel devices
driver / standard (pull_request) Successful in 17s
driver / lint (pull_request) Successful in 15s
driver / types (pull_request) Successful in 1m18s
driver / test (3.13) (pull_request) Successful in 4m9s
driver / test (3.12) (pull_request) Successful in 4m28s
driver / lowest (pull_request) Successful in 3m41s
driver / build (pull_request) Successful in 34s
driver / security (pull_request) Successful in 1m18s
CI / driver (pull_request) Successful in 6m0s
driver / publish (pull_request) Skipped
The driver's evidence was all vendor-wide: Zyxel's enterprise OID, Zyxel
OUIs and "zyxel" on the web page. Every managed Zyxel device has all
three, and they were the driver's whole maximum, so discovery named any
Zyxel switch this gateway with high confidence.

Discovery now also fetches /getRSAPublickKey on ports 80 and 443, the
DAL key exchange the driver logs in with, without counting the port.
Its "RSAPublicKey" answer weighs 24: vendor-wide evidence alone is 28 of
52 (medium), a gateway 52 of 52, or 37 of 52 without SNMP.

Closes #13
2026-11-02 08:47:46 +01:00
Christian Manivong fcee6d7ddd fix(ping): stop reporting every target alive
driver / standard (pull_request) Successful in 17s
driver / lint (pull_request) Successful in 16s
driver / types (pull_request) Successful in 1m13s
driver / test (3.12) (pull_request) Successful in 4m9s
driver / test (3.13) (pull_request) Successful in 4m1s
driver / lowest (pull_request) Successful in 3m33s
driver / build (pull_request) Successful in 30s
driver / security (pull_request) Successful in 1m6s
CI / driver (pull_request) Successful in 5m49s
driver / publish (pull_request) Skipped
ping() returned three replies of 0 ms whenever the DAL accepted a
PINGTEST request, without reading any result, so a LAN scan through
this gateway marked every address alive. The DAL answer is only an
acknowledgement with no reply count, so ping() now returns NAPALM's
error reply without contacting the gateway and the driver opts out of
ping sweeps with SUPPORTS_PING = False.

Closes #2
2026-11-01 21:56:45 +01:00
Christian Manivong f7002114ae fix(http): pass the timeout with every request
requests ignores a timeout attribute on a Session, so open() setting
one left every call without a timeout and an unresponsive gateway
could hang a worker indefinitely. Each get/post/put now carries the
driver's timeout.

Closes #3
2026-11-01 21:55:36 +01:00
Christian Manivong d5362fd382 fix(fingerprint): drop the GS1920 and GS2210 switch patterns
GS1920 and GS2210 are Zyxel switches. Counting them as evidence for a
VMG gateway driver made discovery score a Zyxel switch higher for this
driver than a real VMG gateway.

Closes #4
2026-11-01 21:54:55 +01:00
Christian Manivong 48fdda1904 fix: an unknown ARP age is -1.0, not 0.0
driver / standard (pull_request) Successful in 18s
driver / lint (pull_request) Successful in 23s
driver / types (pull_request) Successful in 1m24s
driver / test (3.12) (pull_request) Successful in 3m53s
driver / test (3.13) (pull_request) Successful in 3m37s
driver / lowest (pull_request) Successful in 3m14s
driver / build (pull_request) Successful in 31s
driver / security (pull_request) Successful in 1m11s
CI / driver (pull_request) Successful in 5m45s
driver / publish (pull_request) Skipped
The host list says a host is active, not when the gateway last saw it, 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
Christian Manivong 51b8cda3e4 chore: adopt the NAPALM driver standard
driver / standard (pull_request) Successful in 13s
driver / lint (pull_request) Successful in 11s
driver / types (pull_request) Successful in 42s
driver / test (3.10) (pull_request) Successful in 3m25s
driver / test (3.11) (pull_request) Successful in 3m23s
driver / test (3.12) (pull_request) Successful in 3m25s
driver / test (3.13) (pull_request) Successful in 3m19s
driver / lowest (pull_request) Successful in 3m7s
driver / security (pull_request) Successful in 53s
driver / build (pull_request) Successful in 34s
CI / driver (pull_request) Successful in 19m12s
driver / publish (pull_request) Skipped
- CI moves to .gitea/workflows/ci.yml and calls the shared driver workflow
  of NAPALM/driver-standard; .github/ is gone.
- requires-python >=3.10 (napalm-device-types needs it), floor
  napalm-device-types>=4.21.1 (was napalm_device_types>=0.4.0), LICENSE
  file, py.typed, SPDX license string, links to git.netork.io, a dev extra
  with floors.
- README (pyproject named one that did not exist) and CHANGELOG.md.
- mypy strict for the package; napalm_zyxel.zyxel_driver is exempt for now
  (24 errors), recorded in the quality baseline with its two complex
  functions. Coverage floor 68 % (measured 68.97 %).

Closes #8
2026-10-23 08:40:47 +02:00
Christian Manivong b306b64673 fix: what bandit and the remaining lint rules found
- nosec for SHA512_password in the login payload (B105): it is a flag
  telling the gateway how Input_Passwd is encoded, not a password; a false
  positive.
- A failed login raises ConnectionException from the underlying error, so
  the cause stays attached.
- tests: pytest.raises instead of try / assert False / except, which
  python -O would have turned into tests that always pass.
2026-10-23 08:39:32 +02:00
Christian Manivong f9fc4e3d06 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-23 08:38:39 +02:00
Christian Manivong 210f00f5e7 fix!: reboot_host instead of reboot; drop run_device_action (0.2.0)
CI / test (3.10) (push) Successful in 3m5s
CI / test (3.11) (push) Successful in 23s
CI / test (3.12) (push) Successful in 24s
CI / test (3.10) (pull_request) Successful in 3m3s
CI / test (3.11) (pull_request) Successful in 23s
CI / test (3.12) (pull_request) Successful in 24s
The gateway had reboot(), but the contract (HostRebootMixin) and the
application look for reboot_host(), so the gateway could not be
restarted from it. reboot_host() returns None and raises when the
gateway refuses, as the contract says.

run_device_action dispatched reboot, restart_wifi[:band] and
get_diagnostics by string, with a result shape other than its
contract's. restart_wifi(band) and get_diagnostics() are methods now;
napalm-device-types deprecates run_device_action.

BREAKING CHANGE: reboot() and run_device_action are removed.

Closes #5. Part of #6.
2026-10-17 08:40:28 +02:00
Christian Manivong 13e1aba5aa init 2026-06-13 03:18:28 +02:00