Files
napalm-opnsense/napalm_opnsense/ssh_settings.py
T
Christian Manivong b50732c63c
driver / lint (pull_request) Successful in 15s
driver / standard (pull_request) Successful in 18s
driver / types (pull_request) Successful in 1m13s
driver / test (3.13) (pull_request) Successful in 1m13s
driver / test (3.12) (pull_request) Successful in 1m15s
driver / lowest (pull_request) Successful in 40s
driver / build (pull_request) Successful in 37s
driver / security (pull_request) Successful in 1m6s
CI / driver (pull_request) Successful in 2m37s
driver / publish (pull_request) Skipped
feat(ssh): say where the SSH algorithm lists are set
OPNsense writes sshd_config from config.xml (<system><ssh>), set on the
legacy Administration page; no API controller reads or writes that
section (26.1, 26.7, master). The driver cannot harden the SSH server,
so it declares, as data, the page and the field of each algorithm list:
SSH_SETTINGS_MENU and SSH_SETTINGS_FIELDS, keyed like device-types'
SSH_ALGORITHM_CLASSES. An application tells a person what to set there.

The CARP master check moves to virtual_ips, next to the CARP reader, so
opnsense.py stays under its line ratchet.

Refs NetOrk/netork#1769
2026-11-07 16:39:12 +01:00

33 lines
1.5 KiB
Python

"""Where the firewall's SSH server takes its algorithm lists from (NetOrk/netork#1769).
OPNsense writes sshd_config itself, from config.xml (``<system><ssh>``: ``kex``,
``ciphers``, ``macs``, ``keys`` and ``keysig``, comma-separated), whenever the
service is configured (``openssh_configure_do`` in ``plugins.inc.d/openssh.inc``).
The section is set on the legacy page ``system_advanced_admin.php``; no API
controller reads or writes it, up to 26.7 and on ``master``. So this driver cannot
take algorithms out of what sshd offers -- it does not offer ``harden_ssh_server``
-- and says, as data, where a person sets the lists instead.
A field left empty is OpenSSH's defaults. In an HA pair the configuration sync
carries the section to the backup when its "OpenSSH" item is ticked (sync id
``ssh``, :data:`napalm_opnsense.ha.SYNC_ITEM_SERVICES`).
"""
from __future__ import annotations
class OPNsenseSshSettingsMixin:
"""The page and fields that set the SSH server's algorithm lists, as the web
interface names them."""
#: The menu path to the page, ending in the section that holds the lists.
SSH_SETTINGS_MENU: tuple[str, ...] = ("System", "Settings", "Administration", "Secure Shell")
#: Each list's field, by its algorithm class (napalm-device-types'
#: ``SSH_ALGORITHM_CLASSES``).
SSH_SETTINGS_FIELDS: dict[str, str] = {
"kex": "Key exchange algorithms",
"cipher": "Ciphers",
"mac": "MACs",
"hostkey": "Host key algorithms",
}