Some refactor and address comments

Author: npalaska

lib/pbench/server/api/auth.py

@@ -39,7 +39,7 @@ def get_secret_key(self):
 
     def verify_user(self, username):
         """
-        Check if the provided username belong to the current user by
+        Check if the provided username belongs to the current user by
         querying the Usermodel with the current user
         :param username:
         :param logger
@@ -60,13 +60,13 @@ def get_auth_token(self, logger):
             logger.warning("Missing expected Authorization header")
             abort(
                 403,
-                message="Please add 'Authorization' token as Authorization: Bearer <JWT_Auth_token>",
+                message="Please add 'Authorization' token as Authorization: Bearer <session_token>",
             )
 
         try:
             auth_schema, auth_token = auth_header.split()
         except ValueError:
-            logger.warning("Malformed Auth header during logout")
+            logger.warning("Malformed Auth header")
             abort(
                 401,
                 message="Malformed Authorization header, please add request header as Authorization: Bearer <session_token>",
@@ -79,51 +79,46 @@ def get_auth_token(self, logger):
                 )
                 abort(
                     401,
-                    message="Malformed Authorization header, please add request header as Authorization: Bearer <session_token>",
+                    message="Malformed Authorization header, request auth needs bearer token: Bearer <session_token>",
                 )
             return auth_token
 
-    def verify_auth(self):
-        @Auth.token_auth.verify_token
-        def verify_token(auth_token):
-            """
-            Validates the auth token
-            :param auth_token:
-            :param app:
-            :return: integer|string
-            """
+    @staticmethod
+    @token_auth.verify_token
+    def verify_auth(auth_token):
+        """
+        Validates the auth token
+        :param auth_token:
+        :return: integer|string
+        """
+        try:
+            payload = jwt.decode(
+                auth_token, os.getenv("SECRET_KEY", "my_precious"), algorithms="HS256",
+            )
+            user_id = payload["sub"]
+            if ActiveTokens.valid(auth_token):
+                user = User.query(id=user_id)
+                return user
+            return None
+        except jwt.ExpiredSignatureError:
             try:
-                payload = jwt.decode(
-                    auth_token,
-                    os.getenv("SECRET_KEY", "my_precious"),
-                    algorithms="HS256",
-                )
-                user_id = payload["sub"]
-                if ActiveTokens.valid(auth_token):
-                    user = User.query(id=user_id)
-                    return user
-                return False
-            except jwt.ExpiredSignatureError:
-                try:
-                    ActiveTokens.delete(auth_token)
-                except Exception:
-                    Auth.logger.error(
-                        "User attempted Pbench expired token but we could not delete the expired auth token from the database. token: '{}'",
-                        auth_token,
-                    )
-                    return False
-                Auth.logger.warning(
-                    "User attempted Pbench expired token '{}', Token deleted from the database and no longer tracked",
-                    auth_token,
-                )
-                return False
-            except jwt.InvalidTokenError:
-                Auth.logger.warning(
-                    "User attempted invalid Pbench token '{}'", auth_token
-                )
-                return False
+                ActiveTokens.delete(auth_token)
             except Exception:
-                Auth.logger.exception(
-                    "Exception occurred while verifying the auth token '{}'", auth_token
+                Auth.logger.error(
+                    "User attempted Pbench expired token but we could not delete the expired auth token from the database. token: '{}'",
+                    auth_token,
                 )
-                return False
+                return None
+            Auth.logger.warning(
+                "User attempted Pbench expired token '{}', Token deleted from the database and no longer tracked",
+                auth_token,
+            )
+            return None
+        except jwt.InvalidTokenError:
+            Auth.logger.warning("User attempted invalid Pbench token '{}'", auth_token)
+            return None
+        except Exception:
+            Auth.logger.exception(
+                "Exception occurred while verifying the auth token '{}'", auth_token
+            )
+            return None