op-mode: T4416: Rewrite 'traceroute' op-command and expand available options using python

3 files changed, 217 insertions, 213 deletions

diff --git a/Makefile b/Makefile
index 3e838540c..2333eebed 100644
--- a/Makefile
+++ b/Makefile
@@ -60,9 +60,10 @@ op_mode_definitions: $(op_xml_obj)
 	rm -f $(OP_TMPL_DIR)/show/node.def
 	rm -f $(OP_TMPL_DIR)/show/system/node.def
 
-	# XXX: ping must be able to recursivly call itself as the
+	# XXX: ping and traceroute must be able to recursivly call itself as the
 	# options are provided from the script itself
 	ln -s ../node.tag $(OP_TMPL_DIR)/ping/node.tag/node.tag/
+	ln -s ../node.tag $(OP_TMPL_DIR)/traceroute/node.tag/node.tag/
 
 	# XXX: test if there are empty node.def files - this is not allowed as these
 	# could mask help strings or mandatory priority statements
diff --git a/op-mode-definitions/traceroute.xml.in b/op-mode-definitions/traceroute.xml.in
index e3217235c..aba0f45e3 100644
--- a/op-mode-definitions/traceroute.xml.in
+++ b/op-mode-definitions/traceroute.xml.in
@@ -2,226 +2,22 @@
 <interfaceDefinition>
   <tagNode name="traceroute">
     <properties>
-      <help>Track network path to node</help>
-      <completionHelp>
-        <list>&lt;hostname&gt; &lt;x.x.x.x&gt; &lt;h:h:h:h:h:h:h:h&gt;</list>
-      </completionHelp>
-    </properties>
-    <command>/usr/bin/traceroute "$2"</command>
-  </tagNode>
-  <node name="traceroute">
-    <properties>
-      <help>Track network path to node</help>
+      <help>Trace network path to node</help>
       <completionHelp>
         <list>&lt;hostname&gt; &lt;x.x.x.x&gt; &lt;h:h:h:h:h:h:h:h&gt;</list>
       </completionHelp>
     </properties>
+    <command>${vyos_op_scripts_dir}/traceroute.py ${@:2}</command>
     <children>
-      <tagNode name="ipv4">
+      <leafNode name="node.tag">
         <properties>
-          <help>Explicitly use IPv4 when tracing the path</help>
+          <help>Traceroute options</help>
           <completionHelp>
-            <list>&lt;hostname&gt; &lt;x.x.x.x&gt;</list>
+            <script>${vyos_op_scripts_dir}/traceroute.py --get-options "${COMP_WORDS[@]}"</script>
           </completionHelp>
         </properties>
-        <command>/usr/bin/traceroute -4 "$3"</command>
-        <children>
-          <node name="tcp">
-            <properties>
-              <help>Route tracing and port detection using TCP</help>
-            </properties>
-            <command>sudo /usr/bin/tcptraceroute "$3" </command>
-            <children>
-              <tagNode name="port">
-                <properties>
-                  <help>TCP port to connect to for path tracing</help>
-                  <completionHelp>
-                    <list>0-65535</list>
-                  </completionHelp>
-                </properties>
-                <command>sudo /usr/bin/tcptraceroute "$3" $6</command>
-              </tagNode>
-            </children>
-          </node>
-        </children>
-      </tagNode>
-      <tagNode name="ipv6">
-        <properties>
-          <help>Explicitly use IPv6 when tracing the path</help>
-          <completionHelp>
-            <list>&lt;hostname&gt; &lt;h:h:h:h:h:h:h:h&gt;</list>
-          </completionHelp>
-        </properties>
-        <command>/usr/bin/traceroute -6 "$3"</command>
-        <children>
-          <node name="tcp">
-            <properties>
-              <help>Use TCP/IPv6 packets to perform a traceroute</help>
-            </properties>
-            <command>sudo /usr/bin/tcptraceroute6 "$3" </command>
-            <children>
-              <tagNode name="port">
-                <properties>
-                  <help>TCP port to connect to for path tracing</help>
-                  <completionHelp>
-                    <list>0-65535</list>
-                  </completionHelp>
-                </properties>
-                <command>sudo /usr/bin/tcptraceroute6 "$3" $6</command>
-              </tagNode>
-            </children>
-          </node>
-        </children>
-      </tagNode>
-      <tagNode name="vrf">
-        <properties>
-          <help>Track network path to specified node via given VRF</help>
-          <completionHelp>
-            <path>vrf name</path>
-          </completionHelp>
-        </properties>
-        <children>
-          <!-- we need an empty tagNode to pass in a plain fqdn/ip address and
-               let traceroute decide how to handle this parameter -->
-          <tagNode name="">
-            <properties>
-              <help>Track network path to specified node via given VRF</help>
-              <completionHelp>
-                <list>&lt;hostname&gt; &lt;x.x.x.x&gt; &lt;h:h:h:h:h:h:h:h&gt;</list>
-              </completionHelp>
-            </properties>
-            <command>sudo ip vrf exec "$3" /usr/bin/traceroute "$4"</command>
-          </tagNode>
-          <tagNode name="ipv4">
-            <properties>
-              <help>Explicitly use IPv4 when tracing the path via given VRF</help>
-              <completionHelp>
-                <list>&lt;hostname&gt; &lt;x.x.x.x&gt;</list>
-              </completionHelp>
-            </properties>
-            <command>sudo ip vrf exec "$3" /usr/bin/traceroute -4 "$5"</command>
-            <children>
-              <node name="tcp">
-                <properties>
-                  <help>Route tracing and port detection using TCP</help>
-                </properties>
-                <command>sudo ip vrf exec "$3" /usr/bin/tcptraceroute "$5" </command>
-                <children>
-                  <tagNode name="port">
-                    <properties>
-                      <help>TCP port to connect to for path tracing</help>
-                      <completionHelp>
-                        <list>0-65535</list>
-                      </completionHelp>
-                    </properties>
-                    <command>sudo ip vrf exec "$3" /usr/bin/tcptraceroute "$5" $8</command>
-                  </tagNode>
-                </children>
-              </node>
-            </children>
-          </tagNode>
-          <tagNode name="ipv6">
-            <properties>
-              <help>Explicitly use IPv6 when tracing the path via given VRF</help>
-              <completionHelp>
-                <list>&lt;hostname&gt; &lt;h:h:h:h:h:h:h:h&gt;</list>
-              </completionHelp>
-            </properties>
-            <command>sudo ip vrf exec "$3" /usr/bin/traceroute -6 "$5"</command>
-            <children>
-              <node name="tcp">
-                <properties>
-                  <help>Use TCP/IPv6 packets to perform a traceroute</help>
-                </properties>
-                <command>sudo ip vrf exec "$3" /usr/bin/tcptraceroute6 "$5" </command>
-                <children>
-                  <tagNode name="port">
-                    <properties>
-                      <help>TCP port to connect to for path tracing</help>
-                      <completionHelp>
-                        <list>0-65535</list>
-                      </completionHelp>
-                    </properties>
-                    <command>sudo ip vrf exec "$3" /usr/bin/tcptraceroute6 "$5" $8</command>
-                  </tagNode>
-                </children>
-              </node>
-            </children>
-          </tagNode>
-        </children>
-      </tagNode>
-    </children>
-  </node>
-  <node name="monitor">
-    <children>
-      <tagNode name="traceroute">
-        <properties>
-          <help>Monitor path to destination in realtime</help>
-          <completionHelp>
-            <list>&lt;hostname&gt; &lt;x.x.x.x&gt; &lt;h:h:h:h:h:h:h:h&gt;</list>
-          </completionHelp>
-        </properties>
-        <command>/usr/bin/mtr "$3"</command>
-      </tagNode>
-      <node name="traceroute">
-        <children>
-          <tagNode name="ipv4">
-            <properties>
-              <help>IPv4 fully qualified domain name (FQDN)</help>
-              <completionHelp>
-                <list>&lt;fqdn&gt;</list>
-              </completionHelp>
-            </properties>
-            <command>/usr/bin/mtr -4 "$4"</command>
-          </tagNode>
-          <tagNode name="ipv6">
-            <properties>
-              <help>IPv6 fully qualified domain name (FQDN)</help>
-              <completionHelp>
-                <list>&lt;fqdn&gt;</list>
-              </completionHelp>
-            </properties>
-            <command>/usr/bin/mtr -6 "$4"</command>
-          </tagNode>
-          <tagNode name="vrf">
-            <properties>
-              <help>Monitor path to destination in realtime via given VRF</help>
-              <completionHelp>
-                <path>vrf name</path>
-              </completionHelp>
-            </properties>
-            <children>
-              <tagNode name="ipv4">
-                <properties>
-                  <help>IPv4 fully qualified domain name (FQDN)</help>
-                  <completionHelp>
-                    <list>&lt;fqdn&gt;</list>
-                  </completionHelp>
-                </properties>
-                <command>sudo ip vrf exec "$4" /usr/bin/mtr -4 "$6"</command>
-              </tagNode>
-              <tagNode name="ipv6">
-                <properties>
-                  <help>IPv6 fully qualified domain name (FQDN)</help>
-                  <completionHelp>
-                    <list>&lt;fqdn&gt;</list>
-                  </completionHelp>
-                </properties>
-                <command>sudo ip vrf exec "$4" /usr/bin/mtr -6 "$6"</command>
-              </tagNode>
-              <tagNode name="">
-                <properties>
-                  <help>Track network path to specified node via given VRF</help>
-                  <completionHelp>
-                    <list>&lt;hostname&gt; &lt;x.x.x.x&gt; &lt;h:h:h:h:h:h:h:h&gt;</list>
-                  </completionHelp>
-                </properties>
-                <command>sudo ip vrf exec "$4" /usr/bin/mtr "$5"</command>
-              </tagNode>
-            </children>
-          </tagNode>
-        </children>
-      </node>
+        <command>${vyos_op_scripts_dir}/traceroute.py ${@:2}</command>
+      </leafNode>
     </children>
-  </node>
+  </tagNode>
 </interfaceDefinition>
diff --git a/src/op_mode/traceroute.py b/src/op_mode/traceroute.py
new file mode 100755
index 000000000..4299d6e5f
--- /dev/null
+++ b/src/op_mode/traceroute.py
@@ -0,0 +1,207 @@
+#! /usr/bin/env python3
+
+# Copyright (C) 2022 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 os
+import sys
+import socket
+import ipaddress
+
+options = {
+    'backward-hops': {
+        'traceroute': '{command} --back',
+        'type': 'noarg',
+        'help': 'Display number of backward hops when they different from the forwarded path'
+    },
+    'bypass': {
+        'traceroute': '{command} -r',
+        'type': 'noarg',
+        'help': 'Bypass the normal routing tables and send directly to a host on an attached network'
+    },
+    'do-not-fragment': {
+        'traceroute': '{command} -F',
+        'type': 'noarg',
+        'help': 'Do not fragment probe packets.'
+    },
+    'first-ttl': {
+        'traceroute': '{command} -f {value}',
+        'type': '<ttl>',
+        'help': 'Specifies with what TTL to start. Defaults to 1.'
+    },
+    'icmp': {
+        'traceroute': '{command} -I',
+        'type': 'noarg',
+        'help': 'Use ICMP ECHO for tracerouting'
+    },
+    'interface': {
+        'traceroute': '{command} -i {value}',
+        'type': '<interface>',
+        'help': 'Source interface'
+    },
+    'lookup-as': {
+        'traceroute': '{command} -A',
+        'type': 'noarg',
+        'help': 'Perform AS path lookups'
+    },
+    'mark': {
+        'traceroute': '{command} --fwmark={value}',
+        'type': '<fwmark>',
+        'help': 'Set the firewall mark for outgoing packets'
+    },
+    'no-resolve': {
+        'traceroute': '{command} -n',
+        'type': 'noarg',
+        'help': 'Do not resolve hostnames'
+    },
+    'port': {
+        'traceroute': '{command} -p {value}',
+        'type': '<port>',
+        'help': 'Destination port'
+    },
+    'source-address': {
+        'traceroute': '{command} -s {value}',
+        'type': '<x.x.x.x> <h:h:h:h:h:h:h:h>',
+        'help': 'Specify source IP v4/v6 address'
+    },
+    'tcp': {
+        'traceroute': '{command} -T',
+        'type': 'noarg',
+        'help': 'Use TCP SYN for tracerouting (default port is 80)'
+    },
+    'tos': {
+        'traceroute': '{commad} -t {value}',
+        'type': '<tos>',
+        'help': 'Mark packets with specified TOS'
+    },
+    'ttl': {
+        'traceroute': '{command} -m {value}',
+        'type': '<ttl>',
+        'help': 'Maximum number of hops'
+    },
+    'udp': {
+        'traceroute': '{command} -U',
+        'type': 'noarg',
+        'help': 'Use UDP to particular port for tracerouting (default port is 53)'
+    },
+    'vrf': {
+        'traceroute': 'sudo ip vrf exec {value} {command}',
+        'type': '<vrf>',
+        'help': 'Use specified VRF table',
+        'dflt': 'default'}
+}
+
+traceroute = {
+    4: '/bin/traceroute -4',
+    6: '/bin/traceroute -6',
+}
+
+
+class List (list):
+    def first (self):
+        return self.pop(0) if self else ''
+
+    def last(self):
+        return self.pop() if self else ''
+
+    def prepend(self,value):
+        self.insert(0,value)
+
+
+def expension_failure(option, completions):
+    reason = 'Ambiguous' if completions else 'Invalid'
+    sys.stderr.write('\n\n  {} command: {} [{}]\n\n'.format(reason,' '.join(sys.argv), option))
+    if completions:
+        sys.stderr.write('  Possible completions:\n   ')
+        sys.stderr.write('\n   '.join(completions))
+        sys.stderr.write('\n')
+    sys.stdout.write('<nocomps>')
+    sys.exit(1)
+
+
+def complete(prefix):
+    return [o for o in options if o.startswith(prefix)]
+
+
+def convert(command, args):
+    while args:
+        shortname = args.first()
+        longnames = complete(shortname)
+        if len(longnames) != 1:
+            expension_failure(shortname, longnames)
+        longname = longnames[0]
+        if options[longname]['type'] == 'noarg':
+            command = options[longname]['traceroute'].format(
+                command=command, value='')
+        elif not args:
+            sys.exit(f'traceroute: missing argument for {longname} option')
+        else:
+            command = options[longname]['traceroute'].format(
+                command=command, value=args.first())
+    return command
+
+
+if __name__ == '__main__':
+    args = List(sys.argv[1:])
+    host = args.first()
+
+    if not host:
+        sys.exit("traceroute: Missing host")
+
+    if host == '--get-options':
+        args.first()  # pop traceroute
+        args.first()  # pop IP
+        while args:
+            option = args.first()
+
+            matched = complete(option)
+            if not args:
+                sys.stdout.write(' '.join(matched))
+                sys.exit(0)
+
+            if len(matched) > 1 :
+                sys.stdout.write(' '.join(matched))
+                sys.exit(0)
+
+            if options[matched[0]]['type'] == 'noarg':
+                continue
+
+            value = args.first()
+            if not args:
+                matched = complete(option)
+                sys.stdout.write(options[matched[0]]['type'])
+                sys.exit(0)
+
+    for name,option in options.items():
+        if 'dflt' in option and name not in args:
+            args.append(name)
+            args.append(option['dflt'])
+
+    try:
+        ip = socket.gethostbyname(host)
+    except UnicodeError:
+        sys.exit(f'tracroute: Unknown host: {host}')
+    except socket.gaierror:
+        ip = host
+
+    try:
+        version = ipaddress.ip_address(ip).version
+    except ValueError:
+        sys.exit(f'traceroute: Unknown host: {host}')
+
+    command = convert(traceroute[version],args)
+
+    # print(f'{command} {host}')
+    os.system(f'{command} {host}')
+