p3lib 1.1.91__py3-none-any.whl → 1.1.93__py3-none-any.whl

p3lib/helper.py

@@ -8,7 +8,8 @@ import os
 import platform
 import json
 import traceback
-import  socket
+import socket
+import platform
 
 def initArgs(parser, lastCmdLineArg=None, checkHostArg=True):
     """This method is responsible for
@@ -270,7 +271,11 @@ def getIntListUserResponse(uio, prompt, minValue=None, maxValue=None, allowQuit=
 
 def getHomePath():
     """Get the user home path as this will be used to store config files"""
-    if "HOME" in os.environ:
+    if platform.system() == 'Linux' and os.geteuid() == 0:
+        # Fix for os.environ["HOME"] returning /home/root sometimes.
+        return '/root/'
+    
+    elif "HOME" in os.environ:
         return os.environ["HOME"]
 
     elif "HOMEDRIVE" in os.environ and "HOMEPATH" in os.environ:

p3lib/ssh.py

@@ -310,6 +310,14 @@ class SSH(object):
         if self._uio:
             self._uio.debug(text)
 
+    def isConnected(self):
+        """@brief Check if a connection is active.
+           @return True if connected."""
+        connected = False
+        if self._ssh and self._ssh.get_transport() is not None:
+            connected = self._ssh.get_transport().is_active()
+        return connected
+
     def _connect(self, connectSFTPSession=False, timeout=DEFAULT_SSH_CONNECTION_TIMEOUT):
         """@brief Connect the ssh connection
            @param connectSFTPSession If True then just after the ssh connection
@@ -675,7 +683,7 @@ class SSHTunnelManager(object):
         if self._uio:
             self._uio.error(text)
 
-    def startFwdSSHTunnel(self, serverPort, destHost, destPort):
+    def startFwdSSHTunnel(self, serverPort, destHost, destPort, serverBindAddress=''):
         """@brief Start an ssh port forwarding tunnel. This is a non blocking method.
                   A separate thread will be started to handle data transfer over the
                   ssh forwarding connection.
@@ -685,7 +693,8 @@ class SSHTunnelManager(object):
            @param destHost   The host address of the tunnel destination at the remote
                              end of the ssh connection.
            @param destPort   The host TCP port of the tunnel destination at the remote
-                             end of the ssh connection."""
+                             end of the ssh connection.
+           @param serverBindAddress The server address to bind to."""
         self._info("Forwarding local TCP server port (%d) to %s:%d on the remote end of the ssh connection." % (
         serverPort, destHost, destPort))
         transport = self._ssh.getTransport()
@@ -697,12 +706,26 @@ class SSHTunnelManager(object):
             ssh_transport.use_compression(self._useCompression)
             uo = self._uio
 
-        forwardingServer = ForwardingServer(('', serverPort), SubHander)
+        forwardingServer = ForwardingServer((serverBindAddress, serverPort), SubHander)
         self._forwardingServerList.append(forwardingServer)
         newThread = threading.Thread(target=forwardingServer.serve_forever)
         newThread.daemon = True
         newThread.start()
 
+    def startFwdTunnel(self, serverBindAddress, serverPort, destHost, destPort):
+        """@brief Another method to start a forward SSH tunnel. startFwdSSHTunnel() was the original method.
+           We needed to keep this interface. However I wanted an interface to force the user to enter a bind
+           address on the server.
+           @param serverBindAddress The server address to bind to.
+           @param serverPort The TCP server port. On a port forwarding connection
+                             the TCP server runs on the src end of the ssh connection.
+                             This is the machine that this python code is executing on.
+           @param destHost   The host address of the tunnel destination at the remote
+                             end of the ssh connection.
+           @param destPort   The host TCP port of the tunnel destination at the remote
+                             end of the ssh connection."""
+        self.startFwdSSHTunnel(serverPort, destHost, destPort, serverBindAddress=serverBindAddress)
+
     def stopFwdSSHTunnel(self, serverPort):
         """@brief stop a previously started ssh port forwarding server
            @param serverPort The TCP server port which is currently accepting
@@ -721,7 +744,7 @@ class SSHTunnelManager(object):
             forwardingServer.server_close()
             self._info("Shutdown ssh port forwarding on %s." % (str(forwardingServer.server_address)))
 
-    def startRevSSHTunnel(self, serverPort, destHost, destPort):
+    def startRevSSHTunnel(self, serverPort, destHost, destPort, serverBindAddress=''):
         """@brief Start an ssh reverse port forwarding tunnel
            @param serverPort The TCP server port. On a reverse port forwarding connection
                              the TCP server runs on the dest end of the ssh connection.
@@ -729,7 +752,8 @@ class SSHTunnelManager(object):
            @param destHost   The host address of the tunnel destination at the local
                              end of the ssh connection.
            @param destPort   The host TCP port of the tunnel destination at the local
-                             end of the ssh connection."""
+                             end of the ssh connection.
+           @param serverBindAddress The server address to bind to."""
         self._info("Forwarding (reverse) Remote TCP server port (%d) to %s:%d on this end of the ssh connection." % (
         serverPort, destHost, destPort))
         # We add the None refs as the placeholders will be used later
@@ -738,7 +762,22 @@ class SSHTunnelManager(object):
         self._reverseSShDict[serverPort] = (destHost, destPort, chan, sock)
 
         self._ssh.getTransport().use_compression(self._useCompression)
-        self._ssh.getTransport().request_port_forward('', serverPort, handler=self._startReverseForwardingHandler)
+        self._ssh.getTransport().request_port_forward(serverBindAddress, serverPort, handler=self._startReverseForwardingHandler)
+
+    def startRevTunnel(self, serverBindAddress, serverPort, destHost, destPort):
+        """@brief Another method to start a reverse SSH tunnerl. startRevSSHTunnel() was the original method.
+           We needed to keep this interface. However I wanted an interface to force the user to enter a bind
+           address on the server.
+           @param serverBindAddress The server address to bind to.
+           @param serverPort The TCP server port. On a reverse port forwarding connection
+                             the TCP server runs on the dest end of the ssh connection.
+                             This is the machine at the remote end of the ssh connection.
+           @param destHost   The host address of the tunnel destination at the local
+                             end of the ssh connection.
+           @param destPort   The host TCP port of the tunnel destination at the local
+                             end of the ssh connection."""
+        
+        self.startRevSSHTunnel(serverPort, destHost, destPort, serverBindAddress=serverBindAddress)
 
     def stopRevSSHTunnel(self, serverPort):
         """@brief stop a previously started reverse ssh port forwarding server

{p3lib-1.1.91.dist-info → p3lib-1.1.93.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.91
+Version: 1.1.93
 Summary: A group of python modules for networking, plotting data, config storage, automating boot scripts, ssh access and user input output.
 Home-page: https://github.com/pjaos/p3lib
 Author: Paul Austen

{p3lib-1.1.91.dist-info → p3lib-1.1.93.dist-info}/RECORD

@@ -5,18 +5,18 @@ p3lib/bokeh_gui.py,sha256=55sajP_x9O1lE0uP3w3-T5f2oMzk7jSolLqxlEdLeLg,40245
 p3lib/boot_manager.py,sha256=h5In_QoRDH8oHivcu4gyTzGXWg3joKBiVCz2B8Ttn8E,16941
 p3lib/conduit.py,sha256=jPkjdtyCx2I6SFqcEo8y2g7rgnZ-jNY7oCuYIETzT5Q,6046
 p3lib/database_if.py,sha256=XKu1w3zftGbj4Rh54wrWJnoCtqHkhCzJUPN2S70XIKg,11915
-p3lib/helper.py,sha256=-B63_ncfchMwXrvyVcnj9sxwGnMJ3ASmLmpoYa4tBmM,11862
+p3lib/helper.py,sha256=LVLz-CxXyolX6Ys3coxQyU77SFFEtd5jHb9CDGrd8u0,12036
 p3lib/json_networking.py,sha256=6u4s1SmypjTYPnSxHP712OgQ3ZJaxOqIkgHQ1J7Qews,9738
 p3lib/mqtt_rpc.py,sha256=6LmFA1kR4HSJs9eWbOJORRHNY01L_lHWjvtE2fmY8P8,10511
 p3lib/netif.py,sha256=3QV5OGdHhELIf4MBj6mx5MNCtVeZ7JXoNEkeu4KzCaE,9796
 p3lib/netplotly.py,sha256=PMDx-w1jtRVW6Od5u_kuKbBxNpTS_Y88mMF60puMxLM,9363
 p3lib/ngt.py,sha256=rXA-6zQkfeOupZ-3Q-k3-1DvbKYIi2TCtLKgUb0waWY,37726
 p3lib/pconfig.py,sha256=82rX7zvJVbSFtYYHvhj9I6GTdpjf9v73fNs9WQE-5ik,35388
-p3lib/ssh.py,sha256=klqQ9YuqU8GwPVPHrAJeEs5PI5hgoYiXflq2kIGG3as,39509
+p3lib/ssh.py,sha256=OyoAQ_h1L2RfkjTAChDrvLFfl4Fe_gBNdX5rvK-wKiw,42125
 p3lib/table_plot.py,sha256=RPncwVlGUkkx5Fw0dHQedXo0TSPlTi__VrJBDzaMsuI,32116
 p3lib/uio.py,sha256=Aaxc99XiE3d2f9vLjaN-bZsckoNxay5t0ujdK6PXGrw,23265
-p3lib-1.1.91.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
-p3lib-1.1.91.dist-info/METADATA,sha256=msFw6HMFMApsHMvUAaMyjEonPec26U0s95j4atSRllk,918
-p3lib-1.1.91.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-p3lib-1.1.91.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
-p3lib-1.1.91.dist-info/RECORD,,
+p3lib-1.1.93.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
+p3lib-1.1.93.dist-info/METADATA,sha256=sq5tqdxsRZRkq3JnEn-9d9lplPd9GJUZsdoVlGD0llU,918
+p3lib-1.1.93.dist-info/WHEEL,sha256=OVMc5UfuAQiSplgO0_WdW7vXVGAt9Hdd6qtN4HotdyA,91
+p3lib-1.1.93.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
+p3lib-1.1.93.dist-info/RECORD,,

{p3lib-1.1.91.dist-info → p3lib-1.1.93.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.2.0)
 Root-Is-Purelib: true
 Tag: py3-none-any