feat: basic sdks

server/README.md

@@ -0,0 +1,15 @@
+# janishutz/oidc-login-sdk-server
+This SDK is designed to run together with my browser sdk.
+It is a simple wrapper of `express-openid-connect`.
+
+It is highly recommended that you use a proper session store (such as the redis store from express-session) to store the sessions.
+
+## Usage
+Make sure that you have the following environment variables set
+```env
+OIDC_CLIENT_ID=<CLIENT ID>
+OIDC_CLIENT_SECRET=<CLIENT SECRET>
+SIGNING_SECRET=<LONG RANDOM STRING FOR COOKIE SIGNING>
+```
+
+**More details to come**

server/build.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+tsc --declaration
+cp ./package.json ./dist
+cp ./README.md ./dist
+
+echo "Done"

server/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@janishutz/oidc-login-server",
+  "name": "@janishutz/oidc-login-sdk-server",
   "version": "1.0.0",
   "description": "Small wrapper on top of express-openid-connect to work together with my browser sdk",
   "homepage": "https://github.com/janishutz/oidc-login-sdk-browser#readme",
@@ -24,5 +24,10 @@
     "eslint-plugin-vue": "^10.11.0",
     "globals": "^17.12.0",
     "typescript-eslint": "^8.70.0"
+  },
+  "dependencies": {
+    "@types/express": "^5.0.6",
+    "express": "^5.2.1",
+    "express-openid-connect": "^3.4.0"
   }
 }

server/src/index.ts

@@ -0,0 +1,59 @@
+import connect from 'express-openid-connect';
+import express from 'express';
+
+/**
+ * Set up the sdk. It is recommended that you use a custom SessionStore, such as RedisStore for express-session
+ * Furthermore, see README for required environment variables
+ * @param app - Express application
+ * @param issuer - OIDC Issuer URL
+ * @param appURL - URL of this application
+ * @param authForAllRoutes - Whether or not to require authorization on all routes
+ * @param scopes - Scopes to request
+ * @param enableBackchannelLogout - Whether or not to enable backchannel logout. If true, must provide sessionStore
+ * @param userValidation - Function to validate the user
+ * @param sessionStore - RECOMMENDED: Use any express-session SessionStore, like the RedisStore
+ * @param extraOpts - Extra configuration options, or overwrite some set here
+ */
+export const configure = (
+    app: express.Application,
+    issuer: URL,
+    appURL: URL,
+    authForAllRoutes: boolean,
+    scopes: ( 'profile' | 'email' )[],
+    enableBackchannelLogout: boolean,
+    userValidation: ( req: express.Request, res: express.Response, session: connect.Session ) => Promise<connect.Session>,
+    sessionStore?: connect.SessionStore,
+    extraOpts?: connect.ConfigParams
+) => {
+    app.use( connect.auth( {
+        'authRequired': authForAllRoutes,
+        'issuerBaseURL': issuer.href,
+        'baseURL': appURL.href,
+        'clientID': process.env.OIDC_CLIENT_ID,
+        'clientSecret': process.env.OIDC_CLIENT_SECRET,
+        'secret': process.env.SIGNING_SECRET,
+        'afterCallback': userValidation,
+        'authorizationParams': {
+            'scope': 'openid' + ( scopes.length > 0 ? ' ' + scopes.join( ' ' ) : '' ),
+            'response_type': 'code'
+        },
+        'backchannelLogout': enableBackchannelLogout,
+        'session': {
+            'store': sessionStore
+        },
+        'enableTelemetry': false,
+        'routes': {
+            'callback': '/auth/v2/verify',
+            'login': '/auth/v2/login',
+            'logout': '/auth/v2/logout',
+            'postLogoutRedirect': '/',
+            'backchannelLogout': '/auth/v2/logout'
+        },
+        ...extraOpts
+    } ) );
+
+    app.get( '/auth/v2/check', connect.requiresAuth(), ( _req, res ) => res.sendStatus( 200 ) );
+};
+
+/** Re-Export of express-openid-connect's requiresAuth function */
+export const requiresAuth = connect.requiresAuth;