p3lib 1.1.65__py3-none-any.whl → 1.1.67__py3-none-any.whl

p3lib/bokeh_auth.py

@@ -3,7 +3,7 @@
 This file is a modified version of the Bokeh authorisation example code.
 Many thanks to bokeh for this.
 
-!!! This contains a mix of pep8 and camel case method names !!!
+This contains a mix of pep8 and camel case method names ...
 
 '''
 import os
@@ -13,33 +13,41 @@ import tornado
 from   tornado.web import RequestHandler
 from   argon2 import PasswordHasher
 from   argon2.exceptions import VerificationError
+from   datetime import datetime
+
+# could also define get_login_url function (but must give up LoginHandler)
+login_url = "/login"
 
 CRED_FILE_KEY = "CRED_FILE"
 LOGIN_HTML_FILE_KEY = "LOGIN_HTML_FILE"
+ACCESS_LOG_FILE = "ACCESS_LOG_FILE"
 
 # could define get_user_async instead
 def get_user(request_handler):
+    # Record the get request
+    LoginHandler.RecordGet(request_handler.request.remote_ip)
     user = request_handler.get_cookie("user")
+    # Record the user making the request
+    LoginHandler.SaveInfoAccessLogMessage(f"USER={user}")
     return user
 
-# could also define get_login_url function (but must give up LoginHandler)
-login_url = "/login"
-
 def GetAuthAttrFile():
     """@brief Get the file that is used to pass parameters (credentials file and login.html file) to the tornado server.
               There must be a better way of passing the credentials file to the tornado login handler than this..."""
     jsonFile = os.path.join( tempfile.gettempdir(), f"bokeh_auth_attr_{os.getpid()}.json")
     return jsonFile
 
-def SetBokehAuthAttrs(credentialsJsonFile, loginHTMLFile):
+def SetBokehAuthAttrs(credentialsJsonFile, loginHTMLFile, accessLogFile=None):
     """@brief Set the attributes used to login to the bokeh server. By default
               no login is required to the bokeh server.
        @param credentialsJsonFile The file that stores the username and hashed passwords for the server.
-       @param loginHTMLFile The HTML file for the page presented to the user when logging into the bokeh server."""
+       @param loginHTMLFile The HTML file for the page presented to the user when logging into the bokeh server.
+       @param accessLogFile The log file to record access to. If left as None then no logging occurs."""
     jsonFile = GetAuthAttrFile()
     with open(jsonFile, 'w') as fd:
         cfgDict={CRED_FILE_KEY: credentialsJsonFile}
         cfgDict[LOGIN_HTML_FILE_KEY]=loginHTMLFile
+        cfgDict[ACCESS_LOG_FILE]=accessLogFile
         json.dump(cfgDict, fd, ensure_ascii=False, indent=4)
 
 def _getCredDict():
@@ -60,10 +68,73 @@ def GetLoginHTMLFile():
     """@return The html file for the login page."""
     credDict = _getCredDict()
     return credDict[LOGIN_HTML_FILE_KEY]
-    
+
+def GetAccessLogFile():
+    """@return Get the access log file.."""
+    credDict = _getCredDict()
+    return credDict[ACCESS_LOG_FILE]
+
 # optional login page for login_url
 class LoginHandler(RequestHandler):
 
+    @staticmethod
+    def RecordGet(remoteIP):
+        """@brief Record an HHTP get on the login page.
+           @param remoteIP The IP address of the client."""
+        msg = f"HTTP GET from {remoteIP}"
+        LoginHandler.SaveInfoAccessLogMessage(msg)
+        try:
+            # We import here so that the p3lib module will import even if ip2geotools
+            # is not available as pip install ip2geotools adds in ~ 70 python modules !!!
+            from   ip2geotools.databases.noncommercial import DbIpCity
+            response = DbIpCity.get(remoteIP, api_key='free')
+            LoginHandler.SaveInfoAccessLogMessage(f"HTTP GET country   = {response.country}")
+            LoginHandler.SaveInfoAccessLogMessage(f"HTTP GET region    = {response.region}")
+            LoginHandler.SaveInfoAccessLogMessage(f"HTTP GET city      = {response.city}")
+            LoginHandler.SaveInfoAccessLogMessage(f"HTTP GET latitude  = {response.latitude}")
+            LoginHandler.SaveInfoAccessLogMessage(f"HTTP GET longitude = {response.longitude}")
+        except:
+            pass
+
+    def _recordLoginAttempt(self, username, password):
+        """@brief Record an attempt to login to the server.
+           @param username The username entered.
+           @param password The password entered."""
+        pw = "*"*len(password)
+        LoginHandler.SaveInfoAccessLogMessage(f"Login attempt from {self.request.remote_ip}: username = {username}, password={pw}")
+
+    def _recordLoginSuccess(self, username, password):
+        """@brief Record a successful login to the server.
+           @param username The username entered.
+           @param password The password entered."""
+        pw = "*"*len(password)
+        LoginHandler.SaveInfoAccessLogMessage(f"Login success from {self.request.remote_ip}: username = {username}, password={pw}")
+
+    @staticmethod
+    def SaveInfoAccessLogMessage(msg):
+        """@brief Save an info level access log message.
+           @param msg The message to save to the access log."""
+        LoginHandler.SaveAccessLogMessage("INFO:  "+str(msg))
+
+    @staticmethod
+    def SaveAccessLogMessage(msg):
+        """@brief Save an access log message.
+           @param msg The message to save to the access log."""
+        now = datetime.now()
+        accessLogFile = GetAccessLogFile()
+        if accessLogFile and len(accessLogFile) > 0:
+            try:
+                if not os.path.isfile(accessLogFile):
+                    with open(accessLogFile, 'w'):
+                        pass
+
+                with open(accessLogFile, 'a') as fd:
+                    line = now.isoformat() + ": " + str(msg)+"\n"
+                    fd.write(line)
+
+            except:
+                pass
+
     def get(self):
         try:
             errormessage = self.get_argument("error")
@@ -75,11 +146,13 @@ class LoginHandler(RequestHandler):
     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."""
+        self._recordLoginAttempt(username, password)
         valid = False
         credentialsJsonFile = GetCredentialsFile()
         ch = CredentialsHasher(credentialsJsonFile)
         if ch.verify(username, password):
             valid = True
+            self._recordLoginSuccess(username, password)
         return valid
 
     def post(self):
@@ -96,8 +169,10 @@ class LoginHandler(RequestHandler):
     def set_current_user(self, user):
         if user:
             self.set_cookie("user", tornado.escape.json_encode(user))
+            LoginHandler.SaveInfoAccessLogMessage(f"Set user cookie: user={user}")
         else:
             self.clear_cookie("user")
+            LoginHandler.SaveInfoAccessLogMessage("Cleared user cookie")
 
 # optional logout_url, available as curdoc().session_context.logout_url
 logout_url = "/logout"
@@ -115,32 +190,32 @@ class CredentialsHasherExeption(Exception):
 
 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 
+              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. 
+        """@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. 
+           @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 
+            # 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.
@@ -149,12 +224,12 @@ class CredentialsHasher(object):
         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.
@@ -163,22 +238,22 @@ class CredentialsHasher(object):
             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        
+        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.
@@ -190,25 +265,25 @@ class CredentialsHasher(object):
             try:
                 self._passwordHasher.verify(storedHash, password)
                 validCredential = True
-                
+
             except VerificationError:
-                pass        
-        
+                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())    
-    
+        return len(self._credDict.keys())
+
     def getUsernameList(self):
         """@brief Get a list of usernames.
            @return A list of usernames."""
-        return list(self._credDict.keys())    
+        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.
@@ -216,7 +291,7 @@ class CredentialsManager(object):
         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')
@@ -226,7 +301,7 @@ class CredentialsManager(object):
             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')
@@ -236,10 +311,10 @@ class CredentialsManager(object):
                 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')
@@ -249,14 +324,14 @@ class CredentialsManager(object):
             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:
@@ -280,9 +355,3 @@ class CredentialsManager(object):
                 return
             else:
                 self._uio.error(f"{response} is an invalid response.")
-        
-        
-        
-        
-        
-    

p3lib/bokeh_gui.py

@@ -760,12 +760,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="*:*", credentialsJsonFile=None, loginHTMLFile="login.html"):
+    def __init__(self,
+                 address="0.0.0.0",
+                 bokehPort=0,
+                 wsOrigin="*:*",
+                 credentialsJsonFile=None,
+                 loginHTMLFile="login.html",
+                 accessLogFile=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.
+           @param accessLogFile The log file to record access to. If left as None then no logging occurs.
            """
         if bokehPort == 0:
             bokehPort = MultiAppServer.GetNextUnusedPort()
@@ -774,6 +781,7 @@ class MultiAppServer(object):
         os.environ[MultiAppServer.BOKEH_ALLOW_WS_ORIGIN]=wsOrigin
         self._credentialsJsonFile = credentialsJsonFile
         self._loginHTMLFile = loginHTMLFile
+        self._accessLogFile = accessLogFile
 
     def getServerPort(self):
         """@return The bokeh server port."""
@@ -803,19 +811,21 @@ class MultiAppServer(object):
         evtLoop = asyncio.new_event_loop()
         asyncio.set_event_loop(evtLoop)
         if self._credentialsJsonFile:
-            SetBokehAuthAttrs(self._credentialsJsonFile, self._loginHTMLFile)
+            SetBokehAuthAttrs(self._credentialsJsonFile,
+                              self._loginHTMLFile,
+                              accessLogFile=self._accessLogFile)
             # 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, 
+            self._server = Server(appDict,
                                   address=self._address,
                                   port=self._bokehPort,
                                   auth_provider=authModule)
 
         else:
-            self._server = Server(appDict, 
+            self._server = Server(appDict,
                                   address=self._address,
                                   port=self._bokehPort)
 

{p3lib-1.1.65.dist-info → p3lib-1.1.67.dist-info}/METADATA

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

@@ -1,7 +1,7 @@
 p3lib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 p3lib/ate.py,sha256=_BiqMUYNAlp4O8MkP_PAUe62Bzd8dzV4Ipv62OFS6Ok,4759
-p3lib/bokeh_auth.py,sha256=auo-OPYQYKhwQW_-_9flJX1wBFsXRn3FoN0TOV6w1s4,11496
-p3lib/bokeh_gui.py,sha256=A9I7jLts6BeeaRw45vRq5_xGv6rPMMZHzFBJzpZTXm0,40028
+p3lib/bokeh_auth.py,sha256=XqdCLOalHL3dkyrMPqQoVQBSziVnqlfjB9YAWhZUd_U,14769
+p3lib/bokeh_gui.py,sha256=MNapLctSncZ9YyKGzNcUICMwpI5_h7a7bH3QdMd2UxI,40393
 p3lib/boot_manager.py,sha256=-kbfYbFpO-ktKv_heUgYdvvIQrntfCQ7pBcPWqS3C0s,12551
 p3lib/conduit.py,sha256=jPkjdtyCx2I6SFqcEo8y2g7rgnZ-jNY7oCuYIETzT5Q,6046
 p3lib/database_if.py,sha256=mgTdSeCTQs1V10E7KuyK3xRkdaU3RXrqYpMQvosrA_M,11897
@@ -13,8 +13,8 @@ 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.65.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
-p3lib-1.1.65.dist-info/METADATA,sha256=UJoqf3nq2nMnc4ARO3HFoKWP3mf9Flv8P39PWXeVQb0,920
-p3lib-1.1.65.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-p3lib-1.1.65.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
-p3lib-1.1.65.dist-info/RECORD,,
+p3lib-1.1.67.dist-info/LICENSE,sha256=igqTy5u0kVWM1n-NUZMvAlinY6lVjAXKoag0okkS8V8,1067
+p3lib-1.1.67.dist-info/METADATA,sha256=3SZVksgoZrtT2NwfrYK0Q2VOq6Yh_j31A9pYB7042y8,920
+p3lib-1.1.67.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+p3lib-1.1.67.dist-info/top_level.txt,sha256=SDCpXYh-19yCFp4Z8ZK4B-3J4NvTCJElZ42NPgcR6-U,6
+p3lib-1.1.67.dist-info/RECORD,,