p3lib 1.1.62__py3-none-any.whl → 1.1.64__py3-none-any.whl

p3lib/bokeh_auth.py

@@ -0,0 +1,249 @@
+'''
+
+This file is a modified version of the Bokeh authorisation example code.
+Many thanks to bokeh for this.
+
+'''
+import os
+import json
+import tornado
+from   tornado.web import RequestHandler
+from   argon2 import PasswordHasher
+from   argon2.exceptions import VerificationError
+
+# could define get_user_async instead
+def get_user(request_handler):
+    user = request_handler.get_cookie("user")
+    return user
+
+# could also define get_login_url function (but must give up LoginHandler)
+login_url = "/login"
+
+# optional login page for login_url
+class LoginHandler(RequestHandler):
+
+    def get(self):
+        try:
+            errormessage = self.get_argument("error")
+        except Exception:
+            errormessage = ""
+        self.render("login.html", errormessage=errormessage)
+        
+    def set_credentials(self, credHasher):
+        """@brief Set the object that has details of the valid usernames and passwords."""
+        self._credHasher = credHasher
+
+    def check_permission(self, username, password):
+        """@brief Check if we the username and password are valid
+           @return True if the username and password are valid."""
+        valid = False
+        # If we have details of the valid usernames and passwords.
+        if hasattr(self, '_credHasher'):
+            if self._credHasher.valid(username, password):
+                valid = True
+        return valid
+
+    def post(self):
+        username = self.get_argument("username", "")
+        password = self.get_argument("password", "")
+        auth = self.check_permission(username, password)
+        if auth:
+            self.set_current_user(username)
+            self.redirect("/")
+        else:
+            error_msg = "?error=" + tornado.escape.url_escape("Login incorrect")
+            self.redirect(login_url + error_msg)
+
+    def set_current_user(self, user):
+        if user:
+            self.set_cookie("user", tornado.escape.json_encode(user))
+        else:
+            self.clear_cookie("user")
+
+# optional logout_url, available as curdoc().session_context.logout_url
+logout_url = "/logout"
+
+# optional logout handler for logout_url
+class LogoutHandler(RequestHandler):
+
+    def get(self):
+        self.clear_cookie("user")
+        self.redirect("/")
+
+class CredentialsHasherExeption(Exception):
+    pass
+
+
+class CredentialsHasher(object):
+    """@brief Responsible for storing hashed credentials to a local file.
+              There are issues storing hashed credentials and so this is not 
+              recommended for high security systems but is aimed at providing 
+              a simple credentials storage solution for Bokeh servers."""
+              
+    def __init__(self, credentialsJsonFile):
+        """@brief Construct an object that can be used to generate a credentials has file and check 
+                  credentials entered by a user. 
+           @param credentialsJsonFile A file that contains the hashed (via argon2) login credentials."""
+        self._credentialsJsonFile = credentialsJsonFile
+        self._passwordHasher = PasswordHasher()
+        self._credDict = self._getCredDict()
+        
+    def _getCredDict(self):
+        """@brief Get a dictionary containing the current credentials.
+           @return A dict containing the credentials. 
+                   value = username
+                   key = hashed password."""
+        credDict = {}
+        # If the hash file exists
+        if os.path.isfile(self._credentialsJsonFile):
+            # Add the hash a a line in the file 
+            with open(self._credentialsJsonFile, 'r') as fd:
+                contents = fd.read()
+            credDict = json.loads(contents)
+        return credDict
+                
+    def isUsernameAvailable(self, username):
+        """@brief Determine if the username is not already used.
+           @param username The login username.
+           @return True if the username is not already used."""
+        usernameAvailable = True
+        if username in self._credDict:
+            usernameAvailable = False
+        return usernameAvailable
+        
+    def _saveCredentials(self):
+        """@brief Save the cr3edentials to the file."""
+        with open(self._credentialsJsonFile, 'w', encoding='utf-8') as f:
+            json.dump(self._credDict, f, ensure_ascii=False, indent=4)
+                
+    def add(self, username, password):
+        """@brief Add credential to the stored hashes.
+           @param username The login username.
+           @param password The login password."""
+        if self.isUsernameAvailable(username):
+            hash = self._passwordHasher.hash(password)
+            self._credDict[username] = hash
+            self._saveCredentials()
+            
+        else:
+            raise CredentialsHasherExeption(f"{username} username is already in use.")
+        
+    def remove(self, username):
+        """@brief Remove a user from the stored hashes.
+                  If the username is not present then this method will return without an error.
+           @param username The login username.
+           @return True if the username/password was removed"""
+        removed = False        
+        if username in self._credDict:
+            del self._credDict[username]
+            self._saveCredentials()
+            removed = True
+        return removed
+        
+    def verify(self, username, password):
+        """@brief Check the credentials are valid and stored in the hash file.
+           @param username The login username.
+           @param password The login password.
+           @return True if the username and password are authorised."""
+        validCredential = False
+        if username in self._credDict:
+            storedHash = self._credDict[username]
+            try:
+                self._passwordHasher.verify(storedHash, password)
+                validCredential = True
+                
+            except VerificationError:
+                pass        
+        
+        return validCredential
+                
+    def getCredentialCount(self):
+        """@brief Get the number of credentials that are stored.
+           @return The number of credentials stored."""
+        return len(self._credDict.keys())    
+    
+    def getUsernameList(self):
+        """@brief Get a list of usernames.
+           @return A list of usernames."""
+        return list(self._credDict.keys())    
+
+class CredentialsManager(object):
+    """@brief Responsible for allowing the user to add and remove credentials to a a local file."""
+    
+    def __init__(self, uio, credentialsJsonFile):
+        """@brief Constructor.
+           @param uio A UIO instance that allows user input output.
+           @param credentialsJsonFile A file that contains the hashed (via argon2) login credentials."""
+        self._uio = uio
+        self._credentialsJsonFile = credentialsJsonFile
+        self.credentialsHasher = CredentialsHasher(self._credentialsJsonFile)
+        
+    def _add(self):
+        """@brief Add a username/password to the list of credentials."""
+        self._uio.info('Add a username/password')
+        username = self._uio.getInput('Enter the username: ')
+        if self.credentialsHasher.isUsernameAvailable(username):
+            password = self._uio.getInput('Enter the password: ')
+            self.credentialsHasher.add(username, password)
+        else:
+            self._uio.error(f"{username} is already in use.")
+    
+    def _delete(self):
+        """@brief Delete a username/password from the list of credentials."""
+        self._uio.info('Delete a username/password')
+        username = self._uio.getInput('Enter the username: ')
+        if not self.credentialsHasher.isUsernameAvailable(username):
+            if self.credentialsHasher.remove(username):
+                self._uio.info(f"Removed {username}")
+            else:
+                self._uio.error(f"Failed to remove {username}.")
+            
+        else:
+            self._uio.error(f"{username} not found.")
+        
+    def _check(self):
+        """@brief Check a username/password from the list of credentials."""
+        self._uio.info('Check a username/password')
+        username = self._uio.getInput('Enter the username: ')
+        password = self._uio.getInput('Enter the password: ')
+        if self.credentialsHasher.verify(username, password):
+            self._uio.info(f"The username and password match.")
+        else:
+            self._uio.error(f"The username and password do not match.")
+        
+    def _showUsernames(self):
+        """@brief Show the user a list of the usernames stored."""
+        table = [["USERNAME"]]
+        for username in self.credentialsHasher.getUsernameList():
+            table.append([username])
+        self._uio.showTable(table)
+        
+    def manage(self):
+        """@brief Allow the user to add and remove user credentials from a local file."""
+        while True:
+            self._uio.info("")
+            self._showUsernames()
+            self._uio.info(f"{self.credentialsHasher.getCredentialCount()} credentials stored in {self._credentialsJsonFile}")
+            self._uio.info("")
+            self._uio.info("A - Add a username/password.")
+            self._uio.info("D - Delete a username/password.")
+            self._uio.info("C - Check a username/password is stored.")
+            self._uio.info("Q - Quit.")
+            response = self._uio.getInput('Enter one of the above options: ')
+            response = response.upper()
+            if response == 'A':
+                self._add()
+            elif response == 'D':
+                self._delete()
+            elif response == 'C':
+                self._check()
+            elif response == 'Q':
+                return
+            else:
+                self._uio.error(f"{response} is an invalid response.")
+        
+        
+        
+        
+        
+    

p3lib/bokeh_gui.py

@@ -22,6 +22,7 @@ from bokeh.models import Range
 from bokeh.palettes import Category20_20 as palette
 from bokeh.resources import Resources
 from bokeh.embed import file_html
+from bokeh.server.auth_provider import AuthModule
 
 from bokeh.plotting import save, output_file
 from bokeh.layouts import gridplot, column, row
@@ -96,14 +97,14 @@ class TabbedGUI(object):
                          x_axis_type="datetime",
                          x_axis_location="below",
                          y_range=yrange,
-                         plot_width=width,
-                         plot_height=height)
+                         width=width,
+                         height=height)
         else:
             fig = figure(title=title,
                          x_axis_type="datetime",
                          x_axis_location="below",
-                         plot_width=width,
-                         plot_height=height)
+                         width=width,
+                         height=height)
 
         fig.yaxis.axis_label = yAxisName
         return fig
@@ -758,17 +759,19 @@ class MultiAppServer(object):
            @return The TCP port or -1 if no port is available."""
         return SingleAppServer.GetNextUnusedPort(basePort=basePort, maxPort=maxPort, bindAddress=bindAddress)
 
-    def __init__(self, address="0.0.0.0", bokehPort=0, wsOrigin="*:*"):
+    def __init__(self, address="0.0.0.0", bokehPort=0, wsOrigin="*:*", credentialsJsonFile=None):
         """@Constructor
            @param address The address of the bokeh server.
            @param bokehPort The TCP port to run the server on. If left at the default
                   of 0 then a spare TCP port will be used.
+           @param credentialsJsonFile A file that contains the json formatted hashed (via argon2) login credentials.
            """
         if bokehPort == 0:
             bokehPort = MultiAppServer.GetNextUnusedPort()
         self._bokehPort=bokehPort
         self._address=address
         os.environ[MultiAppServer.BOKEH_ALLOW_WS_ORIGIN]=wsOrigin
+        self._credentialsJsonFile = credentialsJsonFile
 
     def getServerPort(self):
         """@return The bokeh server port."""
@@ -797,7 +800,21 @@ class MultiAppServer(object):
         #As this gets run in a thread we need to start an event loop
         evtLoop = asyncio.new_event_loop()
         asyncio.set_event_loop(evtLoop)
-        self._server = Server(appDict, address=self._address, port=self._bokehPort)
+        if self._credentialsJsonFile is None:
+            self._server = Server(appDict, 
+                                  address=self._address,
+                                  port=self._bokehPort)
+
+        else:
+            # We don't check the credentials hash file exists as this should have been
+            # done at a higher level. We assume that web server authoristion is required.
+            selfPath = os.path.dirname(os.path.abspath(__file__))
+            authFile = os.path.join(selfPath, "bokeh_auth.py")
+            authModule = AuthModule(authFile)
+            self._server = Server(appDict, 
+                                  address=self._address,
+                                  port=self._bokehPort,
+                                  auth_provider=authModule)
         self._server.start()
         if openBrowser:
             #Show the server in a web browser window

p3lib/boot_manager.py

@@ -286,9 +286,7 @@ class LinuxBootManager(object):
     def getStatusLines(self):
         """@brief Get a status report.
            @return Lines of text indicating the status of a previously started process."""
-        statusLines = []
         appName, _ = self._getApp()
-        cmd = "{} status {}".format(LinuxBootManager.SYSTEM_CTL, appName)
         p = Popen([LinuxBootManager.SYSTEM_CTL, 'status', appName], stdin=PIPE, stdout=PIPE, stderr=PIPE)
         output, err = p.communicate(b"input data that is passed to subprocess' stdin")
         response = output.decode() + "\n" + err.decode()

p3lib/netif.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3.8
 
 import  platform
-from    subprocess import call, check_output
+from    subprocess import check_output
 import  socket
 import  struct
 
@@ -112,7 +112,6 @@ class NetIF(object):
                        key   = name of interface
                        value = A list of <IP ADDRESS>/<NET MASK BIT COUNT>"""
         netIFDict = {}
-        ifName = None
         
         cmdOutput = check_output(['/sbin/ip','a'] ).decode()
         netIFDict = self._getLinuxIFDict(cmdOutput, includeNoIPIF=includeNoIPIF)
@@ -127,7 +126,6 @@ class NetIF(object):
                        value = A list of <IP ADDRESS>/<NET MASK BIT COUNT>"""
         netIFDict = {}
         lines = cmdOutput.lower().split('\n')
-        interfaceID = 1
         ifName = None
         ifAddressList = []
         for line in lines:

{p3lib-1.1.62.dist-info → p3lib-1.1.64.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: p3lib
-Version: 1.1.62
+Version: 1.1.64
 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.62.dist-info → p3lib-1.1.64.dist-info}/RECORD

@@ -1,19 +1,20 @@
 p3lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 p3lib/ate.py,sha256=_BiqMUYNAlp4O8MkP_PAUe62Bzd8dzV4Ipv62OFS6Ok,4759
-p3lib/bokeh_gui.py,sha256=8KhIGv6GrbbzOLm97hXSSKymDaR0ambg0-1ZSFgD0G4,38903
-p3lib/boot_manager.py,sha256=Gx7A8gdRHnpvk1sh5k4lixJQSCxA4TKCe-qGmJYWtyI,12650
+p3lib/bokeh_auth.py,sha256=u8lrdRRtnkBntwXU47ISM85myC_dhQXvv5SGYgeprdM,9816
+p3lib/bokeh_gui.py,sha256=Kx8mKcKrxsaf7md6Jk252nBC8yilUFRx3nMCfVc8S4Q,39835
+p3lib/boot_manager.py,sha256=-kbfYbFpO-ktKv_heUgYdvvIQrntfCQ7pBcPWqS3C0s,12551
 p3lib/conduit.py,sha256=jPkjdtyCx2I6SFqcEo8y2g7rgnZ-jNY7oCuYIETzT5Q,6046
 p3lib/database_if.py,sha256=mgTdSeCTQs1V10E7KuyK3xRkdaU3RXrqYpMQvosrA_M,11897
 p3lib/helper.py,sha256=-B63_ncfchMwXrvyVcnj9sxwGnMJ3ASmLmpoYa4tBmM,11862
 p3lib/json_networking.py,sha256=6u4s1SmypjTYPnSxHP712OgQ3ZJaxOqIkgHQ1J7Qews,9738
 p3lib/mqtt_rpc.py,sha256=6LmFA1kR4HSJs9eWbOJORRHNY01L_lHWjvtE2fmY8P8,10511
-p3lib/netif.py,sha256=XwtvokORmlNaeA1JPCChrgGAxKkcqU-MitJAXeHpUvI,9848
+p3lib/netif.py,sha256=3QV5OGdHhELIf4MBj6mx5MNCtVeZ7JXoNEkeu4KzCaE,9796
 p3lib/netplotly.py,sha256=PMDx-w1jtRVW6Od5u_kuKbBxNpTS_Y88mMF60puMxLM,9363
 p3lib/pconfig.py,sha256=_ri9w3aauHXZp8u2YLYHBVroFR_iCqaTCwj_MRa3rHo,30153
 p3lib/ssh.py,sha256=YE1ddgiEt9EeBM8evuxCV8Gnj4jz1Sv52vEKidvjrJA,38369
 p3lib/uio.py,sha256=hMarPnYXnqVF23HUIeDfzREo7TMdBjrupXMY_ffuCbI,23133
-p3lib-1.1.62.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
-p3lib-1.1.62.dist-info/METADATA,sha256=iYYCOwh4W8N_YMlW2UTRN7T7s9SVfHl4a6ZfazhpgHU,920
-p3lib-1.1.62.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-p3lib-1.1.62.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
-p3lib-1.1.62.dist-info/RECORD,,
+p3lib-1.1.64.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
+p3lib-1.1.64.dist-info/METADATA,sha256=C6TYAMUOgbrxycGFILpXgCLDcyRbxNgJKjGQBG8ytpE,920
+p3lib-1.1.64.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+p3lib-1.1.64.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
+p3lib-1.1.64.dist-info/RECORD,,