[arp] - T1288: python implemtation of 'set protocols static arp'

4 files changed, 166 insertions, 0 deletions

diff --git a/Makefile b/Makefile
index dd3d2d00f..681df855b 100644
--- a/Makefile
+++ b/Makefile
@@ -11,6 +11,7 @@ interface_definitions:
 	# XXX: delete top level node.def's that now live in other packages
 	rm -f $(TMPL_DIR)/interfaces/node.def
 	rm -f $(TMPL_DIR)/protocols/node.def
+	rm -f $(TMPL_DIR)/protocols/static/node.def
 	rm -f $(TMPL_DIR)/system/node.def
 	rm -f $(TMPL_DIR)/system/options/node.def
 	rm -f $(TMPL_DIR)/vpn/node.def
diff --git a/interface-definitions/arp.xml b/interface-definitions/arp.xml
new file mode 100644
index 000000000..b72f025a8
--- /dev/null
+++ b/interface-definitions/arp.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<interfaceDefinition>
+  <node name="protocols">
+    <children>
+      <node name="static">
+        <children>
+          <tagNode name="arp" owner="${vyos_conf_scripts_dir}/arp.py">
+            <properties>
+              <help>Static ARP translation</help>
+              <valueHelp>
+                <format>ipv4</format>
+                <description>IPv4 destination address</description>
+              </valueHelp>
+              <constraint>
+                <validator name="ipv4-address"/>
+              </constraint>
+            </properties>
+            <children>
+              <leafNode name="hwaddr">
+                <properties>
+                  <help>mac address to translate to</help>
+                  <valueHelp>
+                    <format>h:h:h:h:h:h</format>
+                    <description>Hardware (MAC) address</description>
+                  </valueHelp>
+                  <constraint>
+                    <validator name="mac-address"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+            </children>
+          </tagNode>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>
diff --git a/src/conf_mode/arp.py b/src/conf_mode/arp.py
new file mode 100755
index 000000000..88c054010
--- /dev/null
+++ b/src/conf_mode/arp.py
@@ -0,0 +1,100 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2018 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/>.
+#
+#
+
+import sys
+import os
+import re
+import syslog as sl
+import subprocess
+
+from vyos.config import Config
+from vyos import ConfigError
+
+arp_cmd = '/usr/sbin/arp'
+
+def get_config():
+  c = Config()
+  if not c.exists('protocols static arp'):
+    return None
+
+  c.set_level('protocols static')
+  config_data = {}
+  
+  for ip_addr in c.list_nodes('arp'):
+    config_data.update(
+        {
+          ip_addr : c.return_value('arp ' + ip_addr + ' hwaddr')
+        }
+    )
+
+  return config_data
+
+def generate(c):
+  c_eff = Config()
+  c_eff.set_level('protocols static')
+  c_eff_cnf = {}
+  for ip_addr in c_eff.list_effective_nodes('arp'):
+    c_eff_cnf.update(
+        {
+          ip_addr : c_eff.return_effective_value('arp ' + ip_addr + ' hwaddr')
+        }
+    )
+
+  config_data = {
+    'remove'  : [],
+    'update'  : {}
+  }
+  ### removal
+  if c == None:
+    for ip_addr in c_eff_cnf:
+      config_data['remove'].append(ip_addr)
+  else:
+    for ip_addr in c_eff_cnf:
+      if not ip_addr in c:
+        config_data['remove'].append(ip_addr)
+
+  ### add/update
+  if c != None:
+    for ip_addr in c:
+      if not ip_addr in c_eff_cnf:
+        config_data['update'][ip_addr] = c[ip_addr]
+      if  ip_addr in c_eff_cnf:
+        if c[ip_addr] != c_eff_cnf[ip_addr]:
+          config_data['update'][ip_addr] = c[ip_addr]
+
+  return config_data
+
+def apply(c):
+  for ip_addr in c['remove']:
+    sl.syslog(sl.LOG_NOTICE, "arp -d " + ip_addr)
+    subprocess.call([arp_cmd + ' -d ' + ip_addr + ' >/dev/null 2>&1'], shell=True)
+
+  for ip_addr in c['update']:
+    sl.syslog(sl.LOG_NOTICE, "arp -s " + ip_addr + " " + c['update'][ip_addr])
+    subprocess.call([arp_cmd + ' -s ' + ip_addr + ' ' + c['update'][ip_addr] ], shell=True)
+
+
+if __name__ == '__main__':
+  try:
+    c = get_config()
+    ## syntax verification is done via cli
+    config = generate(c)
+    apply(config)
+  except ConfigError as e:
+    print(e)
+    sys.exit(1)
diff --git a/src/validators/mac-address b/src/validators/mac-address
new file mode 100755
index 000000000..d6ec6d712
--- /dev/null
+++ b/src/validators/mac-address
@@ -0,0 +1,28 @@
+#!/usr/bin/env python3
+#
+# Copyright (C) 2018 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/>.
+#
+#
+
+import sys
+import re
+
+if len(sys.argv) == 2:
+  pattern = "^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$"
+  if re.match(pattern, sys.argv[1]):
+    sys.exit(0)
+  else:
+    sys.exit(1)
+