scimgateway 5.2.2 → 5.2.4

package/README.md

@@ -18,7 +18,7 @@ Latest news:
  
 - Remote real-time log subscription for monitoring and centralized logging  
 using browser and url: https://host/logger  
-curl -N https://host/logger -u gwread:password  
+curl -N https://host/logger -u user:password  
 custom client API, see configuration notes  
 - By configuring the chainingBaseUrl, it is now possible to chain multiple gateways in sequence, such as `gateway1->gateway2->gateway3->endpoint`. In this setup, gateway beave much like a reverse proxy, validating authorization at each step unless PassThrough mode is enabled. Chaining is also supported in stream subscriber mode
 - Email, onError and sendMail() supports more secure RESTful OAuth for Microsoft Exchange Online (ExO) and Google Workspace Gmail, alongside traditional SMTP Auth for all mail systems. HelperRest supports a wide range of common authentication methods, including basicAuth, bearerAuth, tokenAuth, oauth, oauthSamlBearer, oauthJwtBearer and Auth PassTrough 
@@ -395,6 +395,8 @@ Definitions in `endpoint` object are customized according to our plugin code. Pl
 
 - **log.loglevel.push** - off, debug, info, warn or error. Default info. Push to stream that can be used by client subscriber
 
+- **log.logDirectory** - custom defined log directory e.g. `/var/log/scimgateway` that will override default `<scimgateway path>/logs`. If not exist it will be created.
+
 - **log.customMasking** - array of attributes to be masked e.g. `"customMasking": ["SSN", "weight"]`. By default SCIM Gateway includes masking of some standard attributes like password.
 
 - **log.colorize** - default true, gives colorized and minimized console output, if redirected to stdout/stderr standard JSON formatted output and no colors. Set to false give standard JSON 
@@ -695,7 +697,7 @@ Example Entra ID (plugin-entra-id) using clientId/clientSecret:
 	    "type": "oauth",
 	    "options": {
 	      "tenantIdGUID": "<tenantId>",
-	      "clientId": "<clientId",
+	      "clientId": "<clientId>",
 	      "clientSecret": "<clientSecret>"
 	    }
 	  }
@@ -709,7 +711,7 @@ Example Entra ID (plugin-entra-id) using certificate secret:
 	    "type": "oauth",
 	    "options": {
 	      "tenantIdGUID": "<tenantId>",
-	      "clientId": "<clientId",
+	      "clientId": "<clientId>",
 	      "tls": {
 	        "key": "key.pem",
 	        "cert": "cert.pem"
@@ -726,7 +728,7 @@ Example using general OAuth:
 	    "type": "oauth",
 	    "options": {
 	      "tokenUrl": "<tokenUrl>"
-	      "clientId": "<clientId",
+	      "clientId": "<clientId>",
 	      "clientSecret": "<clientSecret>"
 	    }
 	  }
@@ -819,7 +821,7 @@ Example code implementing subscriber for real-time log messages collection
 	    console.error('error', e)
 	
 	  } catch (err: any) {
-	    if (['ConnectionClosed', 'ConnectionRefused'].includes(err.code)) {
+	    if (['ConnectionClosed', 'ConnectionRefused', 'ECONNRESET'].includes(err.code)) {
 	      console.log('Connection closed or service unavailable')
 	      ignoreCatch = true
 	      await Bun.sleep(10 * 1000)
@@ -1401,6 +1403,20 @@ MIT © [Jarle Elshaug](https://www.elshaug.xyz)
 
 ## Change log  
 
+### v5.2.4
+
+[Improved]  
+
+- New configuration `log.logDirectory` for custom defined log directory e.g. `/var/log/scimgateway` that will override default `<scimgateway path>/logs`.  
+  **Thanks to [@Gerrit Lansing](https://github.com/gerritlansing)**
+- Base URL like `/scim/v1` and `/scim/v2` is now supported, also with baseEntity e.g. `/scim/v2/client1/Users`
+
+### v5.2.3
+
+[Fixed]
+
+- GET /ResourceTypes was missing in v5
+
 ### v5.2.2
 
 [Fixed]

package/lib/scimgateway.ts

@@ -334,7 +334,6 @@ export class ScimGateway {
     const configFile = path.join(`${configDir}`, `${pluginName}.json`) // config name prefix same as pluging name prefix
     const gwName = path.basename(fileURLToPath(import.meta.url)).split('.')[0] // prefix of current file - using fileURLToPath because using "__filename" is not supported by nodejs typescript
     const gwPath = path.dirname(fileURLToPath(import.meta.url))
-    const logDir = path.join(pluginDir, '..', 'logs')
 
     this.config = {}
     // exposed outside class
@@ -356,6 +355,7 @@ export class ScimGateway {
       found = this.processConfig()
     } catch (err) { configErr = err }
 
+    const logDir = this.config?.scimgateway?.log?.logDirectory || path.join(pluginDir, '..', 'logs')
     const logger = new Logger(
       pluginName,
       {
@@ -483,7 +483,7 @@ export class ScimGateway {
       getMethod: 'getAppRoles',
     }
     /** handlers supported url paths */
-    const handlers = ['users', 'groups', 'serviceplans', 'approles', 'api', 'schemas', 'serviceproviderconfig', 'serviceproviderconfigs', 'logger']
+    const handlers = ['users', 'groups', 'serviceplans', 'approles', 'api', 'schemas', 'resourcetypes', 'serviceproviderconfig', 'serviceproviderconfigs', 'logger']
 
     try {
       if (!fs.existsSync(configDir + '/wsdls')) fs.mkdirSync(configDir + '/wsdls')
@@ -832,6 +832,21 @@ export class ScimGateway {
     }
     funcHandler.getHandlerSchemas = getHandlerSchemas
 
+    // scimv2 GET /ResourceTypes, scimv1 not used
+    const getHandlerResourceTypes = async (ctx: Context) => {
+      const tx = this.scimDef.ResourceType
+      if (!this.config.scimgateway.scim.skipMetaLocation) {
+        const location = ctx.origin + ctx.path
+        if (tx.meta) tx.meta.location = location
+        else {
+          tx.meta = {}
+          tx.meta.location = location
+        }
+      }
+      ctx.response.body = JSON.stringify(tx)
+    }
+    funcHandler.getHandlerResourceTypes = getHandlerResourceTypes
+
     // scimv1 = GET /ServiceProviderConfigs, scimv2 GET /ServiceProviderConfig
     const getHandlerServiceProviderConfig = async (ctx: Context) => {
       const tx = this.scimDef.ServiceProviderConfigs
@@ -2159,7 +2174,13 @@ export class ScimGateway {
       const method = request.method
       const url = new URL(request.url)
 
-      let [, baseEntity, handle, id, rest]: string[] = url.pathname.split('/')
+      let pathname = url.pathname
+      const match = pathname.match(/.*\/scim\/v(1|2)(\/.*)/)
+      if (match) {
+        pathname = match[2] // the part after /scim/vX
+      }
+
+      let [, baseEntity, handle, id, rest]: string[] = pathname.split('/')
       if (baseEntity && handlers.includes(baseEntity.toLowerCase())) {
         rest = id
         id = handle
@@ -2414,6 +2435,9 @@ export class ScimGateway {
           case 'GET schemas':
             await getHandlerSchemas(ctx)
             return await onAfterHandle(ctx)
+          case 'GET resourcetypes':
+            await getHandlerResourceTypes(ctx)
+            return await onAfterHandle(ctx)
           case 'GET serviceproviderconfig':
           case 'GET serviceproviderconfigs':
             await getHandlerServiceProviderConfig(ctx)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scimgateway",
-  "version": "5.2.2",
+  "version": "5.2.4",
   "type": "module",
   "description": "Using SCIM protocol as a gateway for user provisioning to other endpoints",
   "author": "Jarle Elshaug <jarle.elshaug@gmail.com> (https://elshaug.xyz)",

package/test/lib/plugin-loki_test.ts

@@ -32,8 +32,8 @@ async function fetchSCIM(method: string, endpoint: string, body?: any, headers?:
 }
 
 describe('plugin-loki', async () => {
-  test('ServiceProviderConfigs test', async () => {
-    const response: any = await fetchSCIM('GET', '/ServiceProviderConfigs', undefined, options.std.headers)
+  test('ServiceProviderConfig test', async () => {
+    const response: any = await fetchSCIM('GET', '/ServiceProviderConfig', undefined, options.std.headers)
     expect(response.status).toBe(200)
     expect(response.body.schemas).toContain('urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig')
   })
@@ -48,6 +48,16 @@ describe('plugin-loki', async () => {
     })
   })
 
+  test('ResourceTypes test', async () => {
+    const response: any = await fetchSCIM('GET', '/ResourceTypes', undefined, options.std.headers)
+    expect(response.status).toBe(200)
+    expect(Array.isArray(response.body.Resources)).toBe(true)
+    expect(response.body.Resources.length).toEqual(2)
+    expect(response.body.Resources[0].schemas).toContain('urn:ietf:params:scim:schemas:core:2.0:ResourceType')
+    expect(response.body.Resources[0].id).toBe('urn:ietf:params:scim:schemas:core:2.0:User')
+    expect(response.body.Resources[1].id).toBe('urn:ietf:params:scim:schemas:core:2.0:Group')
+  })
+
   test('getUsers all test (1)', async () => {
     const response: any = await fetchSCIM('GET', '/Users?startIndex=1&count=100', undefined, options.std.headers)
     const users = response?.body