nhrp: T3599: Migrate NHRP to XML/Python

4 files changed, 274 insertions, 1 deletions

diff --git a/src/conf_mode/protocols_nhrp.py b/src/conf_mode/protocols_nhrp.py
new file mode 100755
index 000000000..12dacdba0
--- /dev/null
+++ b/src/conf_mode/protocols_nhrp.py
@@ -0,0 +1,122 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2021 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from vyos.config import Config
+from vyos.configdict import node_changed
+from vyos.template import render
+from vyos.util import process_named_running
+from vyos.util import run
+from vyos import ConfigError
+from vyos import airbag
+airbag.enable()
+
+opennhrp_conf = '/run/opennhrp/opennhrp.conf'
+
+def get_config(config=None):
+    if config:
+        conf = config
+    else:
+        conf = Config()
+    base = ['protocols', 'nhrp']
+
+    nhrp = conf.get_config_dict(base, key_mangling=('-', '_'),
+                                get_first_key=True, no_tag_node_value_mangle=True)
+    nhrp['del_tunnels'] = node_changed(conf, base + ['tunnel'], key_mangling=('-', '_'))
+
+    if not conf.exists(base):
+        return nhrp
+
+    nhrp['if_tunnel'] = conf.get_config_dict(['interfaces', 'tunnel'], key_mangling=('-', '_'),
+                                get_first_key=True, no_tag_node_value_mangle=True)
+
+    nhrp['profile_map'] = {}
+    profile = conf.get_config_dict(['vpn', 'ipsec', 'profile'], key_mangling=('-', '_'),
+                                get_first_key=True, no_tag_node_value_mangle=True)
+
+    for name, profile_conf in profile.items():
+        if 'bind' in profile_conf and 'tunnel' in profile_conf['bind']:
+            interfaces = profile_conf['bind']['tunnel']
+            if isinstance(interfaces, str):
+                interfaces = [interfaces]
+            for interface in interfaces:
+                nhrp['profile_map'][interface] = name
+
+    return nhrp
+
+def verify(nhrp):
+    if 'tunnel' in nhrp:
+        for name, nhrp_conf in nhrp['tunnel'].items():
+            if not nhrp['if_tunnel'] or name not in nhrp['if_tunnel']:
+                raise ConfigError(f'Tunnel interface "{name}" does not exist')
+
+            tunnel_conf = nhrp['if_tunnel'][name]
+
+            if 'encapsulation' not in tunnel_conf or tunnel_conf['encapsulation'] != 'gre':
+                raise ConfigError(f'Tunnel "{name}" is not an mGRE tunnel')
+
+            if 'remote' in tunnel_conf:
+                raise ConfigError(f'Tunnel "{name}" cannot have a remote address defined')
+
+            if 'map' in nhrp_conf:
+                for map_name, map_conf in nhrp_conf['map'].items():
+                    if 'nbma_address' not in map_conf:
+                        raise ConfigError(f'nbma-address missing on map {map_name} on tunnel {name}')
+
+            if 'dynamic_map' in nhrp_conf:
+                for map_name, map_conf in nhrp_conf['dynamic_map'].items():
+                    if 'nbma_domain_name' not in map_conf:
+                        raise ConfigError(f'nbma-domain-name missing on dynamic-map {map_name} on tunnel {name}')
+    return None
+
+def generate(nhrp):
+    render(opennhrp_conf, 'nhrp/opennhrp.conf.tmpl', nhrp)
+    return None
+
+def apply(nhrp):
+    if 'tunnel' in nhrp:
+        for tunnel, tunnel_conf in nhrp['tunnel'].items():
+            if 'source_address' in tunnel_conf:
+                chain = f'VYOS_NHRP_{tunnel}_OUT_HOOK'
+                source_address = tunnel_conf['source_address']
+
+                chain_exists = run(f'sudo iptables --check {chain} -j RETURN') == 0
+                if not chain_exists:
+                    run(f'sudo iptables --new {chain}')
+                    run(f'sudo iptables --append {chain} -p gre -s {source_address} -d 224.0.0.0/4 -j DROP')
+                    run(f'sudo iptables --append {chain} -j RETURN')
+                    run(f'sudo iptables --insert OUTPUT 2 -j {chain}')
+
+    for tunnel in nhrp['del_tunnels']:
+        chain = f'VYOS_NHRP_{tunnel}_OUT_HOOK'
+        chain_exists = run(f'sudo iptables --check {chain} -j RETURN') == 0
+        if chain_exists:
+            run(f'sudo iptables --delete OUTPUT -j {chain}')
+            run(f'sudo iptables --flush {chain}')
+            run(f'sudo iptables --delete-chain {chain}')
+
+    action = 'restart' if nhrp and 'tunnel' in nhrp else 'stop'
+    run(f'systemctl {action} opennhrp')
+    return None
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)
diff --git a/src/conf_mode/vpn_ipsec.py b/src/conf_mode/vpn_ipsec.py
index c57697a8f..eedb9098c 100755
--- a/src/conf_mode/vpn_ipsec.py
+++ b/src/conf_mode/vpn_ipsec.py
@@ -356,7 +356,9 @@ def resync_nhrp(ipsec):
     if ipsec and not ipsec['nhrp_exists']:
         return
 
-    run('/opt/vyatta/sbin/vyos-update-nhrp.pl --set_ipsec')
+    tmp = run('/usr/libexec/vyos/conf_mode/protocols_nhrp.py')
+    if tmp > 0:
+        print('ERROR: failed to reapply NHRP settings!')
 
 def apply(ipsec):
     if not ipsec:
diff --git a/src/etc/opennhrp/opennhrp-script.py b/src/etc/opennhrp/opennhrp-script.py
new file mode 100755
index 000000000..74c45f2f6
--- /dev/null
+++ b/src/etc/opennhrp/opennhrp-script.py
@@ -0,0 +1,136 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2021 VyOS maintainers and contributors
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 2 or later as
+# published by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+from pprint import pprint
+import os
+import re
+import sys
+import vici
+
+from vyos.util import cmd
+from vyos.util import process_named_running
+
+NHRP_CONFIG="/etc/opennhrp/opennhrp.conf"
+
+def parse_type_ipsec(interface):
+    with open(NHRP_CONFIG, 'r') as f:
+        lines = f.readlines()
+        match = rf'^interface {interface} #(hub|spoke)(?:\s([\w-]+))?$'
+        for line in lines:
+            m = re.match(match, line)
+            if m:
+                return m[1], m[2]
+    return None, None
+
+def vici_initiate(conn, child_sa, src_addr, dest_addr):
+    try:
+        session = vici.Session()
+        logs = session.initiate({
+            'ike': conn,
+            'child': child_sa,
+            'timeout': '-1',
+            'my-host': src_addr,
+            'other-host': dest_addr
+        })
+        for log in logs:
+            message = log['msg'].decode('ascii')
+            print('INIT LOG:', message)
+        return True
+    except:
+        return None
+
+def vici_terminate(conn, child_sa, src_addr, dest_addr):
+    try:
+        session = vici.Session()
+        logs = session.terminate({
+            'ike': conn,
+            'child': child_sa,
+            'timeout': '-1',
+            'my-host': src_addr,
+            'other-host': dest_addr
+        })
+        for log in logs:
+            message = log['msg'].decode('ascii')
+            print('TERM LOG:', message)
+        return True
+    except:
+        return None
+
+def iface_up(interface):
+    cmd(f'sudo ip route flush proto 42 dev {interface}')
+    cmd(f'sudo ip neigh flush dev {interface}')
+
+def peer_up(dmvpn_type, conn):
+    src_addr = os.getenv('NHRP_SRCADDR')
+    src_nbma = os.getenv('NHRP_SRCNBMA')
+    dest_addr = os.getenv('NHRP_DESTADDR')
+    dest_nbma = os.getenv('NHRP_DESTNBMA')
+    dest_mtu = os.getenv('NHRP_DESTMTU')
+
+    if dest_mtu:
+        args = cmd(f'sudo ip route get {dest_nbma} from {src_nbma}')
+        cmd(f'sudo ip route add {args} proto 42 mtu {dest_mtu}')
+
+    if conn and dmvpn_type == 'spoke' and process_named_running('charon'):
+        vici_terminate(conn, 'dmvpn', src_nbma, dest_nbma)
+        vici_initiate(conn, 'dmvpn', src_nbma, dest_nbma)
+
+def peer_down(dmvpn_type, conn):
+    src_nbma = os.getenv('NHRP_SRCNBMA')
+    dest_nbma = os.getenv('NHRP_DESTNBMA')
+
+    if conn and dmvpn_type == 'spoke' and process_named_running('charon'):
+        vici_terminate(conn, 'dmvpn', src_nbma, dest_nbma)
+
+    cmd(f'sudo ip route del {dest_nbma} src {src_nbma} proto 42')
+
+def route_up(interface):
+    dest_addr = os.getenv('NHRP_DESTADDR')
+    dest_prefix = os.getenv('NHRP_DESTPREFIX')
+    next_hop = os.getenv('NHRP_NEXTHOP')
+
+    cmd(f'sudo ip route replace {dest_addr}/{dest_prefix} proto 42 via {next_hop} dev {interface}')
+    cmd('sudo ip route flush cache')
+
+def route_down(interface):
+    dest_addr = os.getenv('NHRP_DESTADDR')
+    dest_prefix = os.getenv('NHRP_DESTPREFIX')
+
+    cmd(f'sudo ip route del {dest_addr}/{dest_prefix} proto 42')
+    cmd('sudo ip route flush cache')
+
+if __name__ == '__main__':
+    action = sys.argv[1]
+    interface = os.getenv('NHRP_INTERFACE')
+    dmvpn_type, profile_name = parse_type_ipsec(interface)
+
+    dmvpn_conn = None
+
+    if profile_name:
+        dmvpn_conn = f'dmvpn-{profile_name}-{interface}'
+
+    if action == 'interface-up':
+        iface_up(interface)
+    elif action == 'peer-register':
+        pass
+    elif action == 'peer-up':
+        peer_up(dmvpn_type, dmvpn_conn)
+    elif action == 'peer-down':
+        peer_down(dmvpn_type, dmvpn_conn)
+    elif action == 'route-up':
+        route_up(interface)
+    elif action == 'route-down':
+        route_down(interface)
diff --git a/src/systemd/opennhrp.service b/src/systemd/opennhrp.service
new file mode 100644
index 000000000..70235f89d
--- /dev/null
+++ b/src/systemd/opennhrp.service
@@ -0,0 +1,13 @@
+[Unit]
+Description=OpenNHRP
+After=vyos-router.service
+ConditionPathExists=/run/opennhrp/opennhrp.conf
+StartLimitIntervalSec=0
+
+[Service]
+Type=forking
+ExecStart=/usr/sbin/opennhrp -d -v -a /run/opennhrp.socket -c /run/opennhrp/opennhrp.conf -s /etc/opennhrp/opennhrp-script.py -p /run/opennhrp.pid
+ExecReload=/usr/bin/kill -HUP $MAINPID
+PIDFile=/run/opennhrp.pid
+Restart=on-failure
+RestartSec=20