From dc36644a1e9182da8dc9fdfdcf488483d572f115 Mon Sep 17 00:00:00 2001
From: Mark Qvist <mark@unsigned.io>
Date: Fri, 24 Sep 2021 12:42:24 +0200
Subject: [PATCH] Added rnpath utility

---
 RNS/Transport.py        | 22 +++++++++++
 RNS/Utilities/rnpath.py | 87 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 109 insertions(+)
 create mode 100644 RNS/Utilities/rnpath.py

diff --git a/RNS/Transport.py b/RNS/Transport.py
index e43b22f..f5ef83c 100755
--- a/RNS/Transport.py
+++ b/RNS/Transport.py
@@ -1276,6 +1276,28 @@ class Transport:
         else:
             return Transport.PATHFINDER_M
 
+    @staticmethod
+    def next_hop(destination_hash):
+        """
+        :param destination_hash: A destination hash as *bytes*.
+        :returns: The destination hash as *bytes* for the next hop to the specified destination, or *None* if the next hop is unknown.
+        """
+        if destination_hash in Transport.destination_table:
+            return Transport.destination_table[destination_hash][1]
+        else:
+            return None
+
+    @staticmethod
+    def next_hop_interface(destination_hash):
+        """
+        :param destination_hash: A destination hash as *bytes*.
+        :returns: The interface for the next hop to the specified destination, or *None* if the interface is unknown.
+        """
+        if destination_hash in Transport.destination_table:
+            return Transport.destination_table[destination_hash][5]
+        else:
+            return None
+
     @staticmethod
     def request_path(destination_hash):
         """
diff --git a/RNS/Utilities/rnpath.py b/RNS/Utilities/rnpath.py
new file mode 100644
index 0000000..3251438
--- /dev/null
+++ b/RNS/Utilities/rnpath.py
@@ -0,0 +1,87 @@
+#!/usr/bin/env python3
+
+import RNS
+import sys
+import time
+import argparse
+
+from RNS._version import __version__
+
+
+def program_setup(configdir, destination_hexhash):
+    try:
+        dest_len = (RNS.Reticulum.TRUNCATED_HASHLENGTH//8)*2
+        if len(destination_hexhash) != dest_len:
+            raise ValueError("Destination length is invalid, must be {hex} hexadecimal characters ({byte} bytes).".format(hex=dest_len, byte=dest_len//2))
+        try:
+            destination_hash = bytes.fromhex(destination_hexhash)
+        except Exception as e:
+            raise ValueError("Invalid destination entered. Check your input.")
+    except Exception as e:
+        print(str(e))
+        exit()
+
+
+    reticulum = RNS.Reticulum(configdir = configdir)
+
+    if not RNS.Transport.has_path(destination_hash):
+        RNS.Transport.request_path(destination_hash)
+        print("Path to "+RNS.prettyhexrep(destination_hash)+" requested  ", end=" ")
+        sys.stdout.flush()
+
+    i = 0
+    syms = "⢄⢂⢁⡁⡈⡐⡠"
+    while not RNS.Transport.has_path(destination_hash):
+        time.sleep(0.1)
+        print(("\b\b"+syms[i]+" "), end="")
+        sys.stdout.flush()
+        i = (i+1)%len(syms)
+
+    print("\rPath found, destination "+RNS.prettyhexrep(destination_hash)+" is "+str(RNS.Transport.hops_to(destination_hash))+" hops away via "+RNS.prettyhexrep(RNS.Transport.next_hop(destination_hash))+" on "+str(RNS.Transport.next_hop_interface(destination_hash)))
+    
+
+def main():
+    try:
+        parser = argparse.ArgumentParser(description="Reticulum Path Discovery Utility")
+
+        parser.add_argument("--config",
+            action="store",
+            default=None,
+            help="path to alternative Reticulum config directory",
+            type=str
+        )
+
+        parser.add_argument(
+            "--version",
+            action="version",
+            version="rnpath {version}".format(version=__version__)
+        )
+
+        parser.add_argument(
+            "destination",
+            nargs="?",
+            default=None,
+            help="hexadecimal hash of the destination",
+            type=str
+        )
+        
+        args = parser.parse_args()
+
+        if args.config:
+            configarg = args.config
+        else:
+            configarg = None
+
+        if not args.destination:
+            print("")
+            parser.print_help()
+            print("")
+        else:
+            program_setup(configdir = configarg, destination_hexhash = args.destination)
+
+    except KeyboardInterrupt:
+        print("")
+        exit()
+
+if __name__ == "__main__":
+    main()
\ No newline at end of file