conntrack: T3579: initial implementation with XML and Python

5 files changed, 398 insertions, 0 deletions

diff --git a/data/configd-include.json b/data/configd-include.json
index f241d0cb6..712df3f19 100644
--- a/data/configd-include.json
+++ b/data/configd-include.json
@@ -1,5 +1,6 @@
 [
 "bcast_relay.py",
+"conntrack.py",
 "dhcp_relay.py",
 "dhcpv6_relay.py",
 "dns_forwarding.py",
diff --git a/data/templates/conntrack/sysctl.conf.tmpl b/data/templates/conntrack/sysctl.conf.tmpl
new file mode 100644
index 000000000..9e97c3286
--- /dev/null
+++ b/data/templates/conntrack/sysctl.conf.tmpl
@@ -0,0 +1,26 @@
+# Autogenerated by conntrack.py
+{# all values have defaults - thus no checking required #}
+
+net.netfilter.nf_conntrack_expect_max = {{ expect_table_size }}
+net.netfilter.nf_conntrack_max = {{ table_size }}
+
+net.ipv4.tcp_max_syn_backlog = {{ tcp.half_open_connections }}
+
+net.netfilter.nf_conntrack_tcp_loose = {{ '1' if tcp.loose == 'enable' else '0' }}
+net.netfilter.nf_conntrack_tcp_max_retrans = {{ tcp.max_retrans }}
+
+net.netfilter.nf_conntrack_icmp_timeout = {{ timeout.icmp }}
+net.netfilter.nf_conntrack_generic_timeout = {{ timeout.other }}
+
+net.netfilter.nf_conntrack_tcp_timeout_close_wait = {{ timeout.tcp.close_wait }}
+net.netfilter.nf_conntrack_tcp_timeout_close = {{ timeout.tcp.close }}
+net.netfilter.nf_conntrack_tcp_timeout_established = {{ timeout.tcp.established }}
+net.netfilter.nf_conntrack_tcp_timeout_fin_wait = {{ timeout.tcp.fin_wait }}
+net.netfilter.nf_conntrack_tcp_timeout_last_ack = {{ timeout.tcp.last_ack }}
+net.netfilter.nf_conntrack_tcp_timeout_syn_recv = {{ timeout.tcp.syn_recv }}
+net.netfilter.nf_conntrack_tcp_timeout_syn_sent = {{ timeout.tcp.syn_sent }}
+net.netfilter.nf_conntrack_tcp_timeout_time_wait = {{ timeout.tcp.time_wait }}
+
+net.netfilter.nf_conntrack_udp_timeout = {{ timeout.udp.other }}
+net.netfilter.nf_conntrack_udp_timeout_stream = {{ timeout.udp.stream }}
+
diff --git a/data/templates/conntrack/vyos_nf_conntrack.conf.tmpl b/data/templates/conntrack/vyos_nf_conntrack.conf.tmpl
new file mode 100644
index 000000000..111459485
--- /dev/null
+++ b/data/templates/conntrack/vyos_nf_conntrack.conf.tmpl
@@ -0,0 +1,3 @@
+# Autogenerated by conntrack.py
+options nf_conntrack hashsize={{ hash_size }} nf_conntrack_helper=1
+
diff --git a/interface-definitions/system-conntrack.xml.in b/interface-definitions/system-conntrack.xml.in
new file mode 100644
index 000000000..07a2c401d
--- /dev/null
+++ b/interface-definitions/system-conntrack.xml.in
@@ -0,0 +1,285 @@
+<?xml version="1.0"?>
+<interfaceDefinition>
+  <node name="system">
+    <children>
+      <node name="conntrack" owner="${vyos_conf_scripts_dir}/conntrack.py">
+        <properties>
+          <help>Connection Tracking Engine Options</help>
+          <!-- Before NAT and conntrack-sync are configured -->
+          <priority>218</priority>
+        </properties>
+        <children>
+          <leafNode name="expect-table-size">
+            <properties>
+              <help>Size of connection tracking expect table</help>
+              <valueHelp>
+                <format>u32:1-50000000</format>
+                <description>Number of entries allowed in connection tracking expect table</description>
+              </valueHelp>
+              <constraint>
+                <validator name="numeric" argument="--range 1-50000000"/>
+              </constraint>
+            </properties>
+            <defaultValue>2048</defaultValue>
+          </leafNode>
+          <leafNode name="hash-size">
+            <properties>
+              <help>Hash size for connection tracking table</help>
+              <valueHelp>
+                <format>u32:1-50000000</format>
+                <description>Size of hash to use for connection tracking table</description>
+              </valueHelp>
+              <constraint>
+                <validator name="numeric" argument="--range 1-50000000"/>
+              </constraint>
+            </properties>
+            <defaultValue>32768</defaultValue>
+          </leafNode>
+          <leafNode name="table-size">
+            <properties>
+              <help>Size of connection tracking table</help>
+              <valueHelp>
+                <format>u32:1-50000000</format>
+                <description>Number of entries allowed in connection tracking table</description>
+              </valueHelp>
+              <constraint>
+                <validator name="numeric" argument="--range 1-50000000"/>
+              </constraint>
+            </properties>
+            <defaultValue>262144</defaultValue>
+          </leafNode>
+          <node name="tcp">
+            <properties>
+              <help>TCP options</help>
+            </properties>
+            <children>
+              <leafNode name="half-open-connections">
+                <properties>
+                  <help>Maximum number of TCP half-open connections</help>
+                  <valueHelp>
+                    <format>u32:1-2147483647</format>
+                    <description>Generic connection timeout in seconds</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 1-2147483647"/>
+                  </constraint>
+                </properties>
+                <defaultValue>512</defaultValue>
+              </leafNode>
+              <leafNode name="loose">
+                <properties>
+                  <help>Policy to track previously established connections</help>
+                  <completionHelp>
+                    <list>enable disable</list>
+                  </completionHelp>
+                  <valueHelp>
+                    <format>enable</format>
+                    <description>Allow tracking of previously established connections</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>disable</format>
+                    <description>Do not allow tracking of previously established connections</description>
+                  </valueHelp>
+                  <constraint>
+                    <regex>^(enable|disable)$</regex>
+                  </constraint>
+                </properties>
+                <defaultValue>enable</defaultValue>
+              </leafNode>
+              <leafNode name="max-retrans">
+                <properties>
+                  <help>TCP maximum retransmit attempts</help>
+                  <valueHelp>
+                    <format>u32:1-2147483647</format>
+                    <description>Generic connection timeout in seconds</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 1-2147483647"/>
+                  </constraint>
+                </properties>
+                <defaultValue>3</defaultValue>
+              </leafNode>
+            </children>
+          </node>
+          <node name="timeout">
+            <properties>
+              <help>Connection timeout options</help>
+            </properties>
+            <children>
+              <leafNode name="icmp">
+                <properties>
+                  <help>ICMP timeout in seconds</help>
+                  <valueHelp>
+                    <format>u32:1-21474836</format>
+                    <description>ICMP timeout in seconds</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 1-21474836"/>
+                  </constraint>
+                </properties>
+                <defaultValue>30</defaultValue>
+              </leafNode>
+              <leafNode name="other">
+                <properties>
+                  <help>Generic connection timeout in seconds</help>
+                  <valueHelp>
+                    <format>u32:1-21474836</format>
+                    <description>Generic connection timeout in seconds</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="numeric" argument="--range 1-21474836"/>
+                  </constraint>
+                </properties>
+                <defaultValue>600</defaultValue>
+              </leafNode>
+              <node name="tcp">
+                <properties>
+                  <help>TCP connection timeout options</help>
+                </properties>
+                <children>
+                  <leafNode name="close-wait">
+                    <properties>
+                      <help>TCP CLOSE-WAIT timeout in seconds</help>
+                      <valueHelp>
+                        <format>u32:1-21474836</format>
+                        <description>TCP CLOSE-WAIT timeout in seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 1-21474836"/>
+                      </constraint>
+                    </properties>
+                    <defaultValue>60</defaultValue>
+                  </leafNode>
+                  <leafNode name="close">
+                    <properties>
+                      <help>TCP CLOSE timeout in seconds</help>
+                      <valueHelp>
+                        <format>u32:1-21474836</format>
+                        <description>TCP CLOSE timeout in seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 1-21474836"/>
+                      </constraint>
+                    </properties>
+                    <defaultValue>10</defaultValue>
+                  </leafNode>
+                  <leafNode name="established">
+                    <properties>
+                      <help>TCP ESTABLISHED timeout in seconds</help>
+                      <valueHelp>
+                        <format>u32:1-21474836</format>
+                        <description>TCP ESTABLISHED timeout in seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 1-21474836"/>
+                      </constraint>
+                    </properties>
+                    <defaultValue>432000</defaultValue>
+                  </leafNode>
+                  <leafNode name="fin-wait">
+                    <properties>
+                      <help>TCP FIN-WAIT timeout in seconds</help>
+                      <valueHelp>
+                        <format>u32:1-21474836</format>
+                        <description>TCP FIN-WAIT timeout in seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 1-21474836"/>
+                      </constraint>
+                    </properties>
+                    <defaultValue>120</defaultValue>
+                  </leafNode>
+                  <leafNode name="last-ack">
+                    <properties>
+                      <help>TCP LAST-ACK timeout in seconds</help>
+                      <valueHelp>
+                        <format>u32:1-21474836</format>
+                        <description>TCP LAST-ACK timeout in seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 1-21474836"/>
+                      </constraint>
+                    </properties>
+                    <defaultValue>30</defaultValue>
+                  </leafNode>
+                  <leafNode name="syn-recv">
+                    <properties>
+                      <help>TCP SYN-RECEIVED timeout in seconds</help>
+                      <valueHelp>
+                        <format>u32:1-21474836</format>
+                        <description>TCP SYN-RECEIVED timeout in seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 1-21474836"/>
+                      </constraint>
+                    </properties>
+                    <defaultValue>60</defaultValue>
+                  </leafNode>
+                  <leafNode name="syn-sent">
+                    <properties>
+                      <help>TCP SYN-SENT timeout in seconds</help>
+                      <valueHelp>
+                        <format>u32:1-21474836</format>
+                        <description>TCP SYN-SENT timeout in seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 1-21474836"/>
+                      </constraint>
+                    </properties>
+                    <defaultValue>120</defaultValue>
+                  </leafNode>
+                  <leafNode name="time-wait">
+                    <properties>
+                      <help>TCP TIME-WAIT timeout in seconds</help>
+                      <valueHelp>
+                        <format>u32:1-21474836</format>
+                        <description>TCP TIME-WAIT timeout in seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 1-21474836"/>
+                      </constraint>
+                    </properties>
+                    <defaultValue>120</defaultValue>
+                  </leafNode>
+                </children>
+              </node>
+              <node name="udp">
+                <properties>
+                  <help>UDP timeout options</help>
+                </properties>
+                <children>
+                  <leafNode name="other">
+                    <properties>
+                      <help>UDP generic timeout in seconds</help>
+                      <valueHelp>
+                        <format>u32:1-21474836</format>
+                        <description>UDP generic timeout in seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 1-21474836"/>
+                      </constraint>
+                    </properties>
+                    <defaultValue>30</defaultValue>
+                  </leafNode>
+                  <leafNode name="stream">
+                    <properties>
+                      <help>UDP stream timeout in seconds</help>
+                      <valueHelp>
+                        <format>u32:1-21474836</format>
+                        <description>UDP stream timeout in seconds</description>
+                      </valueHelp>
+                      <constraint>
+                        <validator name="numeric" argument="--range 1-21474836"/>
+                      </constraint>
+                    </properties>
+                    <defaultValue>180</defaultValue>
+                  </leafNode>
+                </children>
+              </node>
+            </children>
+          </node>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/src/conf_mode/conntrack.py b/src/conf_mode/conntrack.py
new file mode 100755
index 000000000..e834231cf
--- /dev/null
+++ b/src/conf_mode/conntrack.py
@@ -0,0 +1,83 @@
+#!/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 sys import exit
+
+from vyos.config import Config
+from vyos.configdict import dict_merge
+from vyos.util import cmd
+from vyos.util import run
+from vyos.util import process_named_running
+from vyos.template import render
+from vyos.xml import defaults
+from vyos import ConfigError
+from vyos import airbag
+airbag.enable()
+
+conntrack_config = r'/etc/modprobe.d/vyatta_nf_conntrack.conf'
+sysctl_file = r'/run/sysctl/10-vyos-conntrack.conf'
+
+def resync_conntrackd():
+    tmp = run('/usr/libexec/vyos/conf_mode/conntrack_sync.py')
+    if tmp > 0:
+        print('ERROR: error restarting conntrackd!')
+
+def get_config(config=None):
+    if config:
+        conf = config
+    else:
+        conf = Config()
+    base = ['system', 'conntrack']
+
+    conntrack = conf.get_config_dict(base, key_mangling=('-', '_'),
+                                     get_first_key=True)
+
+    # We have gathered the dict representation of the CLI, but there are default
+    # options which we need to update into the dictionary retrived.
+    default_values = defaults(base)
+    conntrack = dict_merge(default_values, conntrack)
+
+    return conntrack
+
+def verify(conntrack):
+    return None
+
+def generate(conntrack):
+    render(conntrack_config, 'conntrack/vyos_nf_conntrack.conf.tmpl', conntrack)
+    render(sysctl_file, 'conntrack/sysctl.conf.tmpl', conntrack)
+
+    return None
+
+def apply(conntrack):
+    if process_named_running('conntrackd'):
+        # Reload conntrack-sync daemon to fetch new sysctl values
+        resync_conntrackd()
+
+    # We silently ignore all errors
+    # See: https://bugzilla.redhat.com/show_bug.cgi?id=1264080
+    cmd(f'sysctl -f {sysctl_file}')
+
+    return None
+
+if __name__ == '__main__':
+    try:
+        c = get_config()
+        verify(c)
+        generate(c)
+        apply(c)
+    except ConfigError as e:
+        print(e)
+        exit(1)