f81c94af43
Two corrections from reading the live USG instead of trusting UniFi's fields,
which report wan_type=dhcp for both WANs and are simply wrong:
- There are TWO WANs, not one. WAN2 is the 10 gig ISP on VLAN 53, plain DHCP
with a PUBLIC address (87.192.101.48/21, gw 87.192.96.1) on the USG's eth2 --
and it is what actually carries traffic. WAN1 is Vodafone PPPoE on VLAN 51,
the failover. The delta had PPPoE as the only WAN, which would have left the
primary line unconfigured.
- The DHCP lease is bound to MAC, so bond0.53 now clones the USG's WAN2 MAC
(f0:9f:c2:12:9b:4f). That is how VyOS keeps the existing public lease rather
than negotiating a new one -- or getting none, if the ISP allows one per
line. Distances: 10 gig at 1, Vodafone at 10.
Only ONE box may hold the cloned MAC, so --with-wan gates the entire WAN, NAT
and firewall section. vyos001 gets it (320 set lines); vyos002 gets none (234,
zero WAN/NAT/firewall) and routes the LAN only. Pretending both could hold it
would have meant a duplicate MAC on VLAN 53 and a flapping switch table.
Private was rebuilt at 10.8.0.0/23 (VLAN 9) after the old 10.0.8.0/23 was
deleted. bond0.9 and the VRRP group were moved to 10.8.0.252/.253 with VIP
10.8.0.254 on both boxes, and the delta now targets 10.8.0.1.
Creating that network first required breaking a deadlock in UniFi: every LAN
write was rejected with api.err.WanIpOverlapped / 0.0.0.0/0, because WAN1 was
set to DHCP on a line that only speaks PPPoE, so it sat at 0.0.0.0 forever and
the validator treated that as a subnet overlapping everything. Verified
server-side, not a UI bug -- the API rejected it identically. Setting
wan_type=pppoe let it dial (90.241.226.213, MTU 1492), which cleared the phantom
overlap and incidentally PROVED the Vodafone credentials and line work, which
had been listed as untestable before cutover.
dhcp-options no-default-route-dns does not exist; the valid set is client-id,
default-route-distance, host-name, mtu, no-default-route, reject, user-class,
vendor-class-id. Caught by validating the delta against vyos001's real config on
the labsim router before installing.
After adding the network, the gateway's dhcpd.conf was checked with
`dhcpd3 -t -cf` (valid) and confirmed to contain the new subnet only after a
force-provision -- controller state is not device state.
Both boxes: mode unifi, VRRP unchanged, unifi.boot re-captured (232 lines,
carrying the new VLAN 9), no config drift.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DMVzWZgiKW2wquf5z8S1yH
342 lines
18 KiB
Python
Executable File
342 lines
18 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
"""Generate the delta that turns a passive VyOS pair into the gateway.
|
|
|
|
The switch works as: load the known-good `unifi.boot` snapshot, apply this
|
|
delta, commit-confirm. Deriving the gateway mode from base+delta every time
|
|
means there is no inverse to maintain and no drift between two hand-kept
|
|
configs -- the revert is just loading the snapshot again.
|
|
|
|
./vyos-mode-delta.py --priority 200 -o to-vyos.commands # vyos001 (master)
|
|
./vyos-mode-delta.py --priority 100 -o to-vyos.commands # vyos002 (backup)
|
|
./vyos-mode-delta.py --emit-secrets /path/wan-secrets # credentials, 0600
|
|
|
|
The PPPoE password is NOT written into the delta. The delta carries the
|
|
placeholder @@WAN_PASSWORD@@ and the switch script substitutes it at apply time
|
|
from /config/wan-secrets, so the generated artifact can be read, diffed and
|
|
copied around without carrying a credential.
|
|
"""
|
|
from __future__ import annotations
|
|
|
|
import argparse
|
|
import importlib.util
|
|
import ipaddress
|
|
import json
|
|
import os
|
|
import sys
|
|
|
|
HERE = os.path.dirname(os.path.abspath(__file__))
|
|
|
|
# unifi-to-vyos.py has hyphens, so it cannot be imported by name. Reuse it
|
|
# rather than duplicating the DHCP/DNS generation -- the whole point is that
|
|
# what labsim proved and what production gets come from one code path.
|
|
_spec = importlib.util.spec_from_file_location(
|
|
"unifi_to_vyos", os.path.join(HERE, "unifi-to-vyos.py"))
|
|
unifi_to_vyos = importlib.util.module_from_spec(_spec)
|
|
_spec.loader.exec_module(unifi_to_vyos)
|
|
|
|
# Two WANs, established by reading the live USG rather than the UniFi fields
|
|
# (which report wan_type=dhcp for both and are simply wrong):
|
|
#
|
|
# WAN1 Vodafone, PPPoE on the USG's eth0, ~900/700 Mbit. Verified working:
|
|
# pppoe0 came up with 90.241.226.213 peer 84.65.128.1, MTU 1492.
|
|
# WAN2 10 gig ISP, plain DHCP on the USG's eth2, public 87.192.101.48/21
|
|
# gw 87.192.96.1. This is what carries traffic today.
|
|
#
|
|
# Both reach the USG as untagged access ports but are carried across the switch
|
|
# fabric as vlan-only networks 51 and 53, so VyOS picks them up as bond vifs.
|
|
WAN_PPPOE_VIF = "bond0.51" # Vodafone
|
|
WAN_PPPOE_IF = "pppoe0"
|
|
WAN_DHCP_VIF = "bond0.53" # 10 gig ISP
|
|
|
|
# The DHCP lease is bound to the MAC, so cloning the USG's WAN2 MAC is how VyOS
|
|
# keeps 87.192.101.48 instead of negotiating a fresh lease -- or getting none,
|
|
# if the ISP hands out one per line. Only ONE box may carry this at a time.
|
|
WAN_DHCP_MAC = "f0:9f:c2:12:9b:4f"
|
|
|
|
# Route distances: the 10 gig line wins, Vodafone is failover.
|
|
DIST_DHCP, DIST_PPPOE = 1, 10
|
|
|
|
PLACEHOLDER = "@@WAN_PASSWORD@@"
|
|
|
|
|
|
def vrrp_group(vlan: int) -> str:
|
|
"""VRRP group names as configured on the boxes: 'native' for the untagged
|
|
VLAN, 'vlan<id>' otherwise."""
|
|
return "native" if vlan == 1 else f"vlan{vlan}"
|
|
|
|
|
|
def build_delta(inv: dict, priority: int, wan_user: str, with_wan: bool) -> list[str]:
|
|
out: list[str] = []
|
|
nets = [n for n in inv["networks"] if n["dhcp_enabled"] and n["subnet"]]
|
|
nets.sort(key=unifi_to_vyos.vlan_of)
|
|
|
|
out += [
|
|
"# ==========================================================",
|
|
"# Delta: passive VyOS pair -> gateway. Applied on top of a",
|
|
"# freshly loaded unifi.boot, never on top of itself.",
|
|
"# ==========================================================",
|
|
"",
|
|
"# An unconfirmed commit must reload the previous config, NOT reboot.",
|
|
"# 'reboot' is the VyOS default and would turn a failed switch into a",
|
|
"# real outage on the box that is meant to be carrying the network.",
|
|
"set system config-management commit-confirm action reload",
|
|
"",
|
|
"# --- gateway addresses ------------------------------------",
|
|
"# The VIP takes over the address the USG holds today, so no client",
|
|
"# changes anything: no renewal needed, hardcoded gateways keep working.",
|
|
]
|
|
for n in nets:
|
|
vlan = unifi_to_vyos.vlan_of(n)
|
|
grp = vrrp_group(vlan)
|
|
iface = ipaddress.ip_interface(n["subnet"])
|
|
out.append(f"# {n['name']} (VLAN {vlan}) -> {iface.with_prefixlen}")
|
|
# Delete the whole address node rather than a computed old value.
|
|
# `address` is multi-value, and the current VIPs are NOT at
|
|
# network+254 on the /23 networks -- they are 192.168.9.254,
|
|
# 10.0.9.254 and 10.0.1.254, in the upper half. A delete naming the
|
|
# wrong address fails quietly and leaves the group holding two VIPs.
|
|
out.append(f"delete high-availability vrrp group {grp} address")
|
|
out.append(f"set high-availability vrrp group {grp} address {iface.with_prefixlen}")
|
|
out.append(f"set high-availability vrrp group {grp} priority {priority}")
|
|
|
|
out += [
|
|
"",
|
|
]
|
|
|
|
if with_wan:
|
|
out += [
|
|
"# --- WAN -----------------------------------------------",
|
|
"# Both vifs must be created before anything references them.",
|
|
"# Neither firewall has vif 51 or 53 today (only 2, 3, 9, 10, 200),",
|
|
"# and pppoe source-interface points at an interface that must",
|
|
"# already exist -- without this the commit fails and, since the",
|
|
"# delta commits as one unit, takes the whole switch with it.",
|
|
f"set interfaces bonding bond0 vif {WAN_PPPOE_VIF.split('.')[1]} description 'WAN1 Vodafone (PPPoE)'",
|
|
f"set interfaces bonding bond0 vif {WAN_DHCP_VIF.split('.')[1]} description 'WAN2 10gig ISP (DHCP)'",
|
|
"",
|
|
"# WAN2, the 10 gig line -- primary. The cloned MAC is what keeps",
|
|
"# the existing public lease (87.192.101.48) instead of asking for",
|
|
"# a new one. Only the box carrying the WAN may set this.",
|
|
f"set interfaces bonding bond0 vif {WAN_DHCP_VIF.split('.')[1]} mac '{WAN_DHCP_MAC}'",
|
|
f"set interfaces bonding bond0 vif {WAN_DHCP_VIF.split('.')[1]} address dhcp",
|
|
f"set interfaces bonding bond0 vif {WAN_DHCP_VIF.split('.')[1]} dhcp-options default-route-distance {DIST_DHCP}",
|
|
"",
|
|
"# WAN1, Vodafone -- failover at a higher distance. Verified working",
|
|
"# on the USG: pppoe0 came up with a public address, MTU 1492.",
|
|
f"set interfaces pppoe {WAN_PPPOE_IF} source-interface {WAN_PPPOE_VIF}",
|
|
f"set interfaces pppoe {WAN_PPPOE_IF} authentication username '{wan_user}'",
|
|
f"set interfaces pppoe {WAN_PPPOE_IF} authentication password '{PLACEHOLDER}'",
|
|
f"set interfaces pppoe {WAN_PPPOE_IF} mtu 1492",
|
|
f"set interfaces pppoe {WAN_PPPOE_IF} default-route-distance {DIST_PPPOE}",
|
|
# The peer's resolvers would otherwise overwrite resolv.conf.
|
|
f"set interfaces pppoe {WAN_PPPOE_IF} no-peer-dns",
|
|
"",
|
|
"# The static default route exists only for unifi mode, where the",
|
|
"# USG is the next hop. Both WANs supply one here.",
|
|
"delete protocols static route 0.0.0.0/0",
|
|
"",
|
|
"# --- NAT -----------------------------------------------",
|
|
f"set nat source rule 100 outbound-interface name {WAN_DHCP_VIF}",
|
|
"set nat source rule 100 translation address masquerade",
|
|
"set nat source rule 100 description 'LAN out via the 10gig line'",
|
|
f"set nat source rule 110 outbound-interface name {WAN_PPPOE_IF}",
|
|
"set nat source rule 110 translation address masquerade",
|
|
"set nat source rule 110 description 'LAN out via Vodafone (failover)'",
|
|
]
|
|
else:
|
|
out += [
|
|
"# --- WAN -----------------------------------------------",
|
|
"# This box carries NO WAN. Only one of the pair may hold the",
|
|
"# cloned WAN MAC, so the backup routes the LAN and holds the VIPs",
|
|
"# if the master dies, but has no internet path until the WAN is",
|
|
"# moved to it deliberately.",
|
|
"",
|
|
]
|
|
|
|
if with_wan:
|
|
# NAT and the WAN firewall only mean anything on the box that has a
|
|
# WAN. On the other one they would reference interfaces that do not
|
|
# exist and fail the commit.
|
|
# Port forwards, straight from UniFi.
|
|
for i, p in enumerate(inv["port_forwards"]):
|
|
if not p.get("enabled"):
|
|
continue
|
|
rule = 100 + i * 10
|
|
proto = p["proto"] # tcp | udp | tcp_udp -- all valid VyOS values
|
|
out += [
|
|
"",
|
|
f"set nat destination rule {rule} description '{p['name']}'",
|
|
f"set nat destination rule {rule} inbound-interface name {WAN_DHCP_VIF}",
|
|
f"set nat destination rule {rule} protocol {proto}",
|
|
f"set nat destination rule {rule} destination port '{p['dst_port']}'",
|
|
f"set nat destination rule {rule} translation address {p['fwd']}",
|
|
]
|
|
# `destination port` accepts a comma list but `translation port` does
|
|
# NOT -- "16881,6881 is not a valid service name" -- because mapping a
|
|
# list onto a list is ambiguous. Every forward here maps a port to
|
|
# itself, and omitting translation port makes VyOS preserve the
|
|
# original, which is exactly right. Only emit it when it genuinely
|
|
# differs, and refuse rather than guess when a differing list appears.
|
|
if p["fwd_port"] != p["dst_port"]:
|
|
if "," in str(p["fwd_port"]) or "," in str(p["dst_port"]):
|
|
raise SystemExit(
|
|
f"port forward '{p['name']}' remaps a LIST of ports "
|
|
f"({p['dst_port']} -> {p['fwd_port']}). VyOS cannot express "
|
|
f"that in one rule; split it into one rule per port by hand.")
|
|
out.append(f"set nat destination rule {rule} translation port '{p['fwd_port']}'")
|
|
|
|
out += [
|
|
"",
|
|
"# --- firewall ----------------------------------------------",
|
|
"# VyOS defaults to accepting everything. The USG has an implicit",
|
|
"# WAN drop, so migrating the port forwards alone would leave the",
|
|
"# router's own services and the whole LAN reachable from the WAN.",
|
|
"#",
|
|
"# Scoped to the WAN interface rather than a global default-action",
|
|
"# drop: that way a mistake here cannot lock anyone out over the LAN,",
|
|
"# which is the only path back in during a cutover.",
|
|
"",
|
|
"# Traffic TO the router.",
|
|
"set firewall ipv4 input filter default-action accept",
|
|
"set firewall ipv4 input filter rule 100 action accept",
|
|
"set firewall ipv4 input filter rule 100 state established",
|
|
"set firewall ipv4 input filter rule 100 state related",
|
|
"set firewall ipv4 input filter rule 100 description 'established/related'",
|
|
]
|
|
# The two WAN_LOCAL accepts carried over from UniFi.
|
|
out += [
|
|
"",
|
|
"set firewall ipv4 input filter rule 110 action accept",
|
|
"set firewall ipv4 input filter rule 110 protocol esp",
|
|
f"set firewall ipv4 input filter rule 110 inbound-interface name {WAN_DHCP_VIF}",
|
|
"set firewall ipv4 input filter rule 110 description 'VPN accept ESP (from UniFi WAN_LOCAL)'",
|
|
"",
|
|
"set firewall ipv4 input filter rule 120 action accept",
|
|
"set firewall ipv4 input filter rule 120 protocol udp",
|
|
"set firewall ipv4 input filter rule 120 destination port '500,4500'",
|
|
f"set firewall ipv4 input filter rule 120 inbound-interface name {WAN_DHCP_VIF}",
|
|
"set firewall ipv4 input filter rule 120 description 'VPN accept UDP500/4500 (from UniFi WAN_LOCAL)'",
|
|
"",
|
|
"set firewall ipv4 input filter rule 130 action accept",
|
|
"set firewall ipv4 input filter rule 130 protocol icmp",
|
|
f"set firewall ipv4 input filter rule 130 inbound-interface name {WAN_DHCP_VIF}",
|
|
"set firewall ipv4 input filter rule 130 description 'ICMP to the router (path MTU discovery)'",
|
|
"",
|
|
"# Everything else arriving from the WAN is dropped. LAN is untouched.",
|
|
"set firewall ipv4 input filter rule 900 action drop",
|
|
f"set firewall ipv4 input filter rule 900 inbound-interface name {WAN_DHCP_VIF}",
|
|
f"set firewall ipv4 input filter rule 910 action drop",
|
|
f"set firewall ipv4 input filter rule 910 inbound-interface name {WAN_PPPOE_IF}",
|
|
"set firewall ipv4 input filter rule 910 description 'drop all other WAN-to-router (Vodafone)'",
|
|
"set firewall ipv4 input filter rule 900 description 'drop all other WAN-to-router'",
|
|
"",
|
|
"# Traffic THROUGH the router.",
|
|
"set firewall ipv4 forward filter default-action accept",
|
|
"set firewall ipv4 forward filter rule 100 action accept",
|
|
"set firewall ipv4 forward filter rule 100 state established",
|
|
"set firewall ipv4 forward filter rule 100 state related",
|
|
"set firewall ipv4 forward filter rule 100 description 'established/related'",
|
|
]
|
|
|
|
# Destination NAT happens before the forward filter, so these rules must
|
|
# match the translated destination, not the WAN address.
|
|
for i, p in enumerate(inv["port_forwards"]):
|
|
if not p.get("enabled"):
|
|
continue
|
|
rule = 200 + i * 10
|
|
out += [
|
|
"",
|
|
f"set firewall ipv4 forward filter rule {rule} action accept",
|
|
f"set firewall ipv4 forward filter rule {rule} inbound-interface name {WAN_DHCP_VIF}",
|
|
f"set firewall ipv4 forward filter rule {rule} protocol {p['proto']}",
|
|
f"set firewall ipv4 forward filter rule {rule} destination address {p['fwd']}",
|
|
f"set firewall ipv4 forward filter rule {rule} destination port '{p['fwd_port']}'",
|
|
f"set firewall ipv4 forward filter rule {rule} description 'port forward: {p['name']}'",
|
|
]
|
|
|
|
out += [
|
|
"",
|
|
"# New inbound connections from the WAN that are not a port forward.",
|
|
"set firewall ipv4 forward filter rule 900 action drop",
|
|
f"set firewall ipv4 forward filter rule 900 inbound-interface name {WAN_DHCP_VIF}",
|
|
f"set firewall ipv4 forward filter rule 910 action drop",
|
|
f"set firewall ipv4 forward filter rule 910 inbound-interface name {WAN_PPPOE_IF}",
|
|
"set firewall ipv4 forward filter rule 910 description 'drop unsolicited WAN-to-LAN (Vodafone)'",
|
|
"set firewall ipv4 forward filter rule 900 description 'drop unsolicited WAN-to-LAN'",
|
|
"",
|
|
]
|
|
|
|
# DHCP + DNS, from the same generator labsim proved.
|
|
dhcp_lines, stats = unifi_to_vyos.build(inv, "prod")
|
|
expected = len(inv["reservations"])
|
|
if stats["mappings"] != expected:
|
|
raise SystemExit(
|
|
f"refusing to generate: {expected - stats['mappings']} reservation(s) "
|
|
f"missing -- every one must survive the cutover")
|
|
out += dhcp_lines
|
|
return out
|
|
|
|
|
|
def main() -> int:
|
|
ap = argparse.ArgumentParser()
|
|
ap.add_argument("--priority", type=int, required=True,
|
|
help="VRRP priority: 200 for the master, 100 for the backup")
|
|
ap.add_argument("--inventory", default=os.path.join(HERE, "export", "inventory.json"))
|
|
ap.add_argument("--raw-networkconf", default=os.path.join(HERE, "export", "rest_networkconf.json"))
|
|
ap.add_argument("--with-wan", action="store_true",
|
|
help="configure the WAN on this box. Only ONE of the pair may have\n it, because the cloned WAN MAC must be unique.")
|
|
ap.add_argument("-o", "--out")
|
|
ap.add_argument("--emit-secrets", metavar="PATH",
|
|
help="write the PPPoE credential to PATH with mode 0600 and exit")
|
|
args = ap.parse_args()
|
|
|
|
with open(args.inventory) as fh:
|
|
inv = json.load(fh)
|
|
with open(args.raw_networkconf) as fh:
|
|
raw_nets = json.load(fh)
|
|
|
|
wan = next((n for n in raw_nets
|
|
if n.get("purpose") == "wan" and n.get("wan_username")), None)
|
|
if wan is None:
|
|
print("no WAN network with credentials found in the export", file=sys.stderr)
|
|
return 1
|
|
|
|
if args.emit_secrets:
|
|
fd = os.open(args.emit_secrets, os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600)
|
|
with os.fdopen(fd, "w") as fh:
|
|
fh.write(f"WAN_PASSWORD='{wan.get('x_wan_password', '')}'\n")
|
|
# Re-assert the mode in case the file already existed with a wider one.
|
|
os.chmod(args.emit_secrets, 0o600)
|
|
mode = oct(os.stat(args.emit_secrets).st_mode & 0o777)
|
|
print(f"wrote {args.emit_secrets} (mode {mode}) for user {wan['wan_username']}",
|
|
file=sys.stderr)
|
|
return 0
|
|
|
|
lines = build_delta(inv, args.priority, wan["wan_username"], args.with_wan)
|
|
text = "\n".join(lines) + "\n"
|
|
|
|
# Only a WAN-carrying delta has a credential to placeholder-substitute.
|
|
if args.with_wan and PLACEHOLDER not in text:
|
|
print("BUG: password placeholder missing from a WAN delta", file=sys.stderr)
|
|
return 1
|
|
if wan.get("x_wan_password") and wan["x_wan_password"] in text:
|
|
print("BUG: the WAN password leaked into the delta", file=sys.stderr)
|
|
return 1
|
|
|
|
n_set = sum(1 for l in lines if l.startswith("set "))
|
|
n_del = sum(1 for l in lines if l.startswith("delete "))
|
|
print(f"delta: {n_set} set, {n_del} delete, priority {args.priority}, "
|
|
f"{len(inv['reservations'])} reservations", file=sys.stderr)
|
|
|
|
if args.out:
|
|
with open(args.out, "w") as fh:
|
|
fh.write(text)
|
|
print(f"wrote {args.out}", file=sys.stderr)
|
|
else:
|
|
sys.stdout.write(text)
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|