[incubator-ponymail-foal] branch master updated: Test endpoint fo local auth testing

[se...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sebb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-ponymail-foal.git


The following commit(s) were added to refs/heads/master by this push:
     new 3069de5  Test endpoint fo local auth testing
3069de5 is described below

commit 3069de5fd9b5eede03aaa34bff187df7a13d774b
Author: Sebb <se...@apache.org>
AuthorDate: Wed Dec 15 17:32:35 2021 +0000

    Test endpoint fo local auth testing
---
 test/testauth.py   | 83 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 test/testauth.yaml | 18 ++++++++++++
 2 files changed, 101 insertions(+)

diff --git a/test/testauth.py b/test/testauth.py
new file mode 100644
index 0000000..0d2752f
--- /dev/null
+++ b/test/testauth.py
@@ -0,0 +1,83 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License.  You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+    Simple endpoint that does a local login
+
+To enable:
+- copy the files test/testauth.[py|.yaml] to the server/endpoints directory
+  They can be renamed if necessary, so long as they have the same basename
+
+- then add the following to config.js under pm_config.oauth:
+        test: {
+            name: "Test Auth",
+            oauth_portal: "http://localhost/api/testauth",
+            oauth_url: "http://localhost/api/testauth"
+        },
+(This assumes that the test installation is at http://localhost/. Adjust as necessary.)
+
+This will add an extra option to the login screen.
+Clicking on the "Logon with Test Auth" link will automatically login (without prompting)
+
+The data returned by the login can be changed without restarting: just edit the testauth.yaml file.
+If there is a problem reading the file, the inbuilt data will be used.
+"""
+
+import aiohttp
+import plugins.server
+import uuid
+import yaml
+
+# default data if file is not readable
+DATA = {
+  'uid': 'test',
+  'email': 'test@apache.org',
+  'fullname': "Test Name",
+  'isMember': True,
+  'isChair': True,
+  'projects': ['a', 'b', 'b'],
+  'pmcs': ['a', 'b', 'b'],
+  'state': None
+}
+
+async def process(server: plugins.server.BaseServer, session: dict, indata: dict) -> dict:
+    print('INDATA', indata)
+    redirect_uri = indata.get('redirect_uri')
+    code = indata.get('code')
+    if redirect_uri:
+        token = str(uuid.uuid4())
+        headers = {"Location": f"{redirect_uri}&code={token}"}
+        return aiohttp.web.Response(headers=headers, status=302, text="Try here")
+    elif code:
+        # Try to read companion file
+        datafile = __file__.replace('.py', '.yaml')
+        print('file', datafile)
+        try:
+            data =  yaml.safe_load(open(datafile))['oauth_data']
+            print(f'using data from {datafile}')
+        except:
+            print('Using built-in data')
+            data = DATA
+        if 'state' in data:
+            data['state'] = indata.get('state') # fix up
+        print(data)
+        return data
+    else:
+        return {"okay": False, "message": "Invalid invocation!"}
+
+def register(server: plugins.server.BaseServer):
+    return plugins.server.Endpoint(process)
diff --git a/test/testauth.yaml b/test/testauth.yaml
new file mode 100644
index 0000000..03db5d7
--- /dev/null
+++ b/test/testauth.yaml
@@ -0,0 +1,18 @@
+# test oauth response data
+# This is read by the corresponding endpoint script
+
+oauth_data:
+  uid: test
+  email: test@apache.org
+  fullname: Test Name
+  isMember: True
+  isChair: True
+  projects:
+    - a
+    - b
+    - c
+  pmcs:
+    - d
+    - e
+    - f
+  state: TBA # will be replaced at runtime
\ No newline at end of file