pluginserver 0.5.6__tar.gz → 0.6.0__tar.gz

{pluginserver-0.5.6/pluginserver.egg-info → pluginserver-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pluginserver
-Version: 0.5.6
+Version: 0.6.0
 Summary: Plugin-driven API server
 Home-page: https://github.com/nicciniamh/pluginserver
 Author: Nicole Stevens

pluginserver-0.6.0/README.md

@@ -0,0 +1,8 @@
+# Plugin Server
+
+Plugin Server is a python script and library to manage a REST-like API server utilizing a plugin system to handle requests to API routes. It is built upon Python async and aiohttp.
+
+# Installing Plugin Server
+Please see the [Installation Instructions](https://pluginserver.readthedocs.io/en/latest/Install.html) for details. 
+
+Please see the [Project Documentation](https://pluginserver.readthedocs.io/) for information on usage, configuration and more.

{pluginserver-0.5.6 → pluginserver-0.6.0}/plugincore/baseplugin.py

@@ -1,4 +1,5 @@
 from aiohttp import web
+import base64
 
 class BasePlugin:
     """
@@ -27,9 +28,35 @@ class BasePlugin:
         self.args = dict(kwargs)
 
     def _check_auth(self,data):
-        #print(f"_check_auth: {self._auth_type} apikey {self._apikey}, args {data}")
+        toktype = 'Undefined'
+        def get_token(data):
+            nonlocal toktype
+            headers = data.get('request_headers', {})
+            auth_header = headers.get('Authorization')
+            if auth_header and auth_header.startswith('Bearer '):
+                toktype = 'token'
+                return auth_header.split(' ', 1)[1].strip()
+            return None
+
+        def get_custom_header_token(data):
+            nonlocal toktype
+            headers = data.get('request_headers', {})
+            custom_header = headers.get('X-Custom-Auth')
+            toktype = 'custom'
+            if custom_header:
+                return custom_header.strip()
+            return None
+
+        def get_user_token(data):
+            nonlocal toktype
+            token = data.get('apikey')
+            if token:
+                toktype='userdata'
+            return token
+        user_key = get_token(data) or get_custom_header_token(data) or get_user_token(data)
+        print(f"_check_auth: type: {toktype} {self._auth_type} apikey {self._apikey}, args {data}")
+
         if self._auth_type:
-            user_key = data.get('apikey')
             #print(f"Checking {user_key}")
             if not user_key:
                 #print("Returning false")

{pluginserver-0.5.6 → pluginserver-0.6.0}/plugincore/pserv.py

@@ -90,12 +90,43 @@ def main():
 
 # --- Auth Helper ---
 def check_auth(data, config):
+    toktype = 'Undefined'
+    def get_token(data):
+        nonlocal toktype
+        headers = data.get('request_headers', {})
+        auth_header = headers.get('Authorization')
+        if auth_header and auth_header.startswith('Bearer '):
+            toktype = 'token'
+            return auth_header.split(' ', 1)[1].strip()
+        return None
+
+    def get_custom_header_token(data):
+        nonlocal toktype
+        headers = data.get('request_headers', {})
+        custom_header = headers.get('X-Custom-Auth')
+        toktype = 'custom'
+        if custom_header:
+            return custom_header.strip()
+        return None
+
+    def get_user_token(data):
+        nonlocal toktype
+        token = data.get('apikey')
+        if token:
+            toktype='userdata'
+        return token
     try:
         expected = config.auth.apikey
     except AttributeError:
-        expected = None
-    provided = data.get('apikey')
-    return expected and provided and expected == provided
+        return True
+    provided = get_token(data) or get_custom_header_token(data) or get_user_token(data)
+    #print(f"pserv:check_auth: provided/expected: {provided}/{expected}")
+    if not provided:
+        print("Returning false")
+        return False
+    auth_ok = expected == provided
+    #print("Returning {auth_ok}")
+    return auth_ok
 
 # --- Plugin Request Handler ---
 def register_plugin_route(plugin_id, instance, config):
@@ -125,16 +156,31 @@ def register_plugin_route(plugin_id, instance, config):
 
 # --- Control Routes ---
 def register_control_routes(config):
-    @routes.get('/plugins')
+    print("Registering Control Routes")
+    @routes.route('*','/plugins')
     async def plugin_list(request):
-        data = dict(request.query)
+        data = {}
+        if request.method == 'POST' and request.can_read_body:
+            try:
+                data.update(await request.json())
+            except Exception:
+                pass
+        data.update(request.query)
+        data['request_headers'] = dict(request.headers)
         if not check_auth(data, config):
             return web.json_response({'error': 'unauthorized'}, status=403)
         return corsobj.apply_headers(web.json_response({'loaded_plugins': list(manager.plugins.keys())}),request)
 
-    @routes.get('/reload/{plugin_id}')
+    @routes.route('*','/reload/{plugin_id}')
     async def reload_plugin(request):
-        data = dict(request.query)
+        data = {}
+        if request.method == 'POST' and request.can_read_body:
+            try:
+                data.update(await request.json())
+            except Exception:
+                pass
+        data.update(request.query)
+        data['request_headers'] = dict(request.headers)
         if not check_auth(data, config):
             return corsobj.apply_headers(web.json_response({'error': 'unauthorized'}, status=403),request)
 
@@ -144,9 +190,16 @@ def register_control_routes(config):
             return corsobj.apply_headers(web.json_response({'reloaded': pid, 'success': success}),request)
         return corsobj.apply_headers(web.json_response({'error': f'Plugin "{pid}" not found'}, status=404),request)
 
-    @routes.get('/reload/all')
+    @routes.route('*', '/reload/all')
     async def reload_all(request):
-        data = dict(request.query)
+        data = {}
+        if request.method == 'POST' and request.can_read_body:
+            try:
+                data.update(await request.json())
+            except Exception:
+                pass
+        data.update(request.query)
+        data['request_headers'] = dict(request.headers)
         if not check_auth(data, config):
             return corsobj.apply_headers(web.json_response({'error': 'unauthorized'}, status=403),request)
         manager.load_plugins()

{pluginserver-0.5.6 → pluginserver-0.6.0/pluginserver.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pluginserver
-Version: 0.5.6
+Version: 0.6.0
 Summary: Plugin-driven API server
 Home-page: https://github.com/nicciniamh/pluginserver
 Author: Nicole Stevens

{pluginserver-0.5.6 → pluginserver-0.6.0}/setup.py

@@ -4,7 +4,7 @@ from setuptools import setup
 
 setup(
     name='pluginserver',
-    version='0.5.6',
+    version='0.6.0',
     packages=['plugincore'],
     include_package_data=True,
     description='Plugin-driven API server',

pluginserver-0.5.6/README.md

@@ -1,11 +0,0 @@
-# Plugin Server
-
-This server implements an API server using rest-like API routes. The server is implemented
-in Python using aiohttp.
-
-This relatively simplistic RESTapi servers use routes to determine the request handler when a request
-is made. A route is simply the ‘tail’ of the web address being requested.
-Think of a web address like `https://server.domain.tld/tail`. The tail portion is the route.
-
-Please see the documentation at [https://pluginserver.readthedocs.io](https://pluginserver.readthedocs.io/en/latest/). 
-