scimgateway 5.5.2 → 5.5.3

package/README.md

@@ -42,7 +42,7 @@ Latest news:
 
 ## Overview  
 
-SCIM Gateway facilitates user management using the standardized REST-based SCIM 1.1 or 2.0 protocol, offering easier, more powerful, and consistent provisioning while avoiding vendor lock-in. Acting as a translator for incoming SCIM requests, the gateway seamlessly enables CRUD functionality (create, read, update, and delete) for users and groups. By implementing endpoint-specific protocols, it ensures provisioning across diverse destinations. With the gateway, your destinations effectively become SCIM endpoints, streamlining integration and simplifying user management.  
+SCIM Gateway facilitates user management using the standardized REST-based SCIM 1.1 or 2.0 protocol, offering easier, more powerful, and consistent provisioning while avoiding vendor lock-in. Acting as a translator for incoming SCIM requests, the gateway seamlessly enables CRUD functionality (create, read, update, and delete) for users and groups. By implementing endpoint-specific protocols, it ensures provisioning across diverse destinations. With the gateway, your destinations become SCIM-compatible interfaces, streamlining integration and simplifying user management.  
 
 
 ![](https://jelhub.github.io/images/ScimGateway.svg)
@@ -972,8 +972,6 @@ On Linux systems we may also run SCIM Gateway as a Docker image (using docker-co
 **docker-ce  
 docker-compose**
 
-
-
 - Install SCIM Gateway within your own package and copy provided docker files:
 
 		mkdir /opt/my-scimgateway  
@@ -988,6 +986,7 @@ docker-compose**
 	**DataDockerfile**   <== Handles volume mapping   
 	**docker-compose-debug.yml** <== Debugging  
 	**docker-compose-mssql.yml** <== Example including MSSQL docker image
+	**.dockerignore** <== Files to exclude from the build context
 
 - Create a scimgateway user on your Linux VM.   
 
@@ -1491,6 +1490,15 @@ MIT © [Jarle Elshaug](https://www.elshaug.xyz)
 
 ## Change log
 
+### v5.5.3
+
+[Fixed]
+- Docker - fixed `docker build` error introduced in v5.5.0 (using bun.lock instead of binary bun.lockb)
+
+[Improved]
+- plugin-mssql - attribute externalId included
+- .dockerignore - new docker configuration file, contains files to be excluded from the build context
+
 ### v5.5.2
 
 [Improved]

package/config/docker/.dockerignore

@@ -0,0 +1,27 @@
+.DS_Store
+dist/
+client_deploy/
+typings/
+/typings.json
+/jsconfig.json
+/npm-debug.log
+/uml.txt
+/.dockerignore
+/docker-compose*.yml
+/Dockerfile
+/DataDockerfile
+/sqlserver_data/
+/node_modules/
+/.vscode/
+/dbinit/
+/logs/
+/config/docker
+/config/approles
+/config/resources
+/eslint.config.js
+/.travis.yml
+/.gitignore
+/.gitattributes
+/.git/
+/.github/
+/test/

package/config/docker/DataDockerfile

@@ -2,7 +2,7 @@
 # To run: docker run -d --name scimgateway-data -t scimgateway-data:latest
 
 FROM busybox:latest
-LABEL maintainer="Jeffrey Gilbert"
+LABEL maintainer="https://elshaug.xyz"
 
 RUN mkdir -p /home/scimgateway/config
 VOLUME /home/scimgateway/config

package/config/docker/Dockerfile

@@ -1,3 +1,5 @@
+# Thanks to Charles Watson <cwatsonx@costco.com> and Jeffrey Gilbert for the base of Docker implementation and inspiration.
+#
 # Depending on your system you  may need to prefix the commands below with sudo.
 #
 # To build:  docker build --force-rm=true -t <projectName>:1.0.0 .
@@ -14,7 +16,7 @@
 FROM oven/bun:slim AS base
 
 # Declare who maintains this Dockerfile
-LABEL maintainer="Charles Watson <cwatsonx@costco.com>"
+LABEL maintainer="https://elshaug.xyz"
 
 # Add a Process ID 1 Safety Net.  Specific to debian.
 ADD https://github.com/Yelp/dumb-init/releases/download/v1.2.0/dumb-init_1.2.0_amd64 /usr/local/bin/dumb-init
@@ -25,7 +27,7 @@ WORKDIR /home/scimgateway
 ENV NODE_HOME=/home/scimgateway
 
 # Add your project info
-ADD ./package.json ./bun.lockb $NODE_HOME
+ADD ./package.json ./bun.lock $NODE_HOME
 
 # Install dependencies (exclude test stuff for dependencies)
 RUN . ~/.bashrc && cd $NODE_HOME && bun install --production --frozen-lockfile

package/lib/plugin-mssql.ts

@@ -121,6 +121,7 @@ scimgateway.getUsers = async (baseEntity, getObj, attributes, ctx) => {
       for (const user of users) {
         const scimUser = {
           id: user.UserID.value ? user.UserID.value : undefined,
+          externalId: user.UserID.value ? user.UserID.value : undefined,
           userName: user.UserID.value ? user.UserID.value : undefined,
           active: user.Enabled.value === 'true' || false,
           name: {
@@ -292,6 +293,7 @@ scimgateway.getGroups = async (baseEntity, getObj, attributes, ctx) => {
       for (const group of groups) {
         const scimGroup: Record<string, any> = {
           id: group.GroupID.value ? group.GroupID.value : undefined,
+          externalId: group.GroupID.value ? group.GroupID.value : undefined,
           displayName: group.GroupID.value ? group.GroupID.value : undefined,
           active: group.Enabled.value === 'true' || false,
           members: [],

package/lib/scimgateway.ts

@@ -333,15 +333,17 @@ export class ScimGateway {
       pluginDir = '.' // only support running binary in current directory (path to binary can't be found)
       configDir = './config'
     }
-    const configFile = path.join(`${configDir}`, `${pluginName}.json`) // config name prefix same as pluging name prefix
+    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))
 
     this.config = {}
     // exposed outside class
+    this.gwName = gwName
     this.pluginName = pluginName
     this.configDir = configDir
     this.configFile = configFile
+    this.authPassThroughAllowed = false // set to true by plugin if using Auth PassThrough
     this.countries = (() => {
       try {
         return JSON.parse(fs.readFileSync(path.join(gwPath, 'countries.json')).toString())
@@ -382,14 +384,7 @@ export class ScimGateway {
       logger.error(`${gwName}[${pluginName}] stopping...`)
       throw (new Error('Using exception to stop further asynchronous code execution (ensure synchronous logger flush to logfile and exit program), please ignore this one...'))
     }
-
     this.logger = logger
-    // exposed to plugin
-    this.gwName = gwName
-    this.pluginName = pluginName
-    this.configDir = configDir
-    this.configFile = configFile
-    this.authPassThroughAllowed = false // set to true by plugin if using Auth PassThrough
 
     const oAuthTokenExpire = 3600 // seconds
     let pwErrCount = 0
@@ -3084,8 +3079,8 @@ export class ScimGateway {
             let request = new Request(new URL(req.url ?? '', `${protocol}://${req.headers.host}`), {
               method: req.method,
               headers: new Headers(req.headers as any),
+              // @ts-expect-error ignore incompatible types
               body: body,
-              // @ts-expect-error duplex not defined in RequestInit interface
               duplex: body ? 'half' : undefined,
             }) as Request & { raw: IncomingMessage }
             request.raw = req

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scimgateway",
-  "version": "5.5.2",
+  "version": "5.5.3",
   "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)",