feat: basic sdks

browser/build.sh

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

browser/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "@janishutz/oidc-login-browser",
+  "name": "@janishutz/oidc-login-sdk-browser",
   "version": "1.0.0",
   "description": "SDK to communicate with and log into a backend running express-openid-connect",
   "homepage": "https://github.com/janishutz/oidc-login-sdk-browser#readme",

browser/src/auth.ts

@@ -1,8 +1,41 @@
+import request, {
+    AuthError
+} from './request.js';
+import config from './config.js';
+
 export const login = () => {
     sessionStorage.setItem( 'redirect', location.pathname );
-    location.href = '/login';
+    location.href = config.get().loginEndpoint ?? '/auth/v2/login';
 };
 
-export const check = () => {};
+export const check = async () => {
+    let status: boolean;
 
-export const logout = () => {};
+    try {
+        status = ( await request.get( config.get().authCheckEndpoint ?? '/auth/v2/check' ) ).ok;
+    } catch ( e ) {
+        if ( e instanceof AuthError ) {
+            status = false;
+        } else {
+            throw e;
+        }
+    }
+
+    if ( !status && config.get().checkAutoRedirect ) {
+        location.href = getRedirect();
+    }
+
+    return status;
+};
+
+export const getRedirect = (): string | null => {
+    const item = sessionStorage.getItem( 'redirect' );
+
+    sessionStorage.removeItem( 'redirect' );
+
+    return item;
+};
+
+export const logout = async () => {
+    location.href = config.get().logoutEndpoint ?? '/auth/v2/logout';
+};

browser/src/dtype.d.ts

@@ -5,8 +5,9 @@ export interface Config {
     'defaultAuthErrorResolution': AuthErrorResolution;
     'authErrorEvent'?: string;
     'authCheckEndpoint'?: string;
-    'loginEndpoing'?: string;
+    'loginEndpoint'?: string;
     'logoutEndpoint'?: string;
+    'checkAutoRedirect'?: boolean;
 }
 
 declare global {

browser/src/request.ts

@@ -1,3 +1,6 @@
+import {
+    AuthErrorResolution
+} from './dtype.js';
 import config from './config.js';
 import {
     login
@@ -8,13 +11,13 @@ export class AuthError extends Error {}
 export class UnownedError extends Error {}
 
 
-const get = async ( url: string ): Promise<Response> => {
+const get = async ( url: string, authErrorResolution?: AuthErrorResolution ): Promise<Response> => {
     return await wrapper( url, {
         'credentials': 'include'
-    } );
+    }, authErrorResolution );
 };
 
-const post = async ( url: string, payload: string, mime: string = 'application/json' ): Promise<Response> => {
+const post = async ( url: string, payload: string, mime: string = 'application/json', authErrorResolution?: AuthErrorResolution ): Promise<Response> => {
     return await wrapper( url, {
         'credentials': 'include',
         'body': payload,
@@ -22,10 +25,10 @@ const post = async ( url: string, payload: string, mime: string = 'application/j
         'headers': {
             'Content-Type': mime ?? 'application/json'
         }
-    } );
+    }, authErrorResolution );
 };
 
-const wrapper = async ( url: string, opts: RequestInit ): Promise<Response> => {
+const wrapper = async ( url: string, opts: RequestInit, authErrorResolution?: AuthErrorResolution ): Promise<Response> => {
     const res = await fetch( config.get().backendURL + url, {
         'redirect': 'manual',
         ...opts
@@ -36,7 +39,7 @@ const wrapper = async ( url: string, opts: RequestInit ): Promise<Response> => {
             document.dispatchEvent( new CustomEvent( 'autherror' ) );
         }
 
-        if ( config.get().defaultAuthErrorResolution === 'resolve' ) {
+        if ( ( authErrorResolution && authErrorResolution === 'resolve' ) || ( !authErrorResolution && config.get().defaultAuthErrorResolution === 'resolve' ) ) {
             login();
         } else {
             throw new AuthError( 'ERR_USER_UNAUTHORIZED' );

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;