scimgateway 4.1.4 → 4.1.6

package/README.md

@@ -1,6 +1,6 @@
 # SCIM Gateway  
 
-[![Build Status](https://app.travis-ci.com/jelhub/scimgateway.svg?branch=master)](https://app.travis-ci.com/github/jelhub/scimgateway) [![npm Version](https://img.shields.io/npm/v/scimgateway.svg?style=flat-square&label=latest)](https://www.npmjs.com/package/scimgateway)[![npm Downloads](https://img.shields.io/npm/dt/scimgateway.svg?style=flat-square)](https://www.npmjs.com/package/scimgateway) [![chat disqus](https://jelhub.github.io/images/chat.svg)](https://elshaug.xyz/docs/scimgateway#disqus_thread) [![GitHub forks](https://img.shields.io/github/forks/jelhub/scimgateway.svg?style=social&label=Fork)](https://github.com/jelhub/scimgateway)  
+[![Build Status](https://app.travis-ci.com/jelhub/scimgateway.svg?branch=master)](https://app.travis-ci.com/github/jelhub/scimgateway) [![npm Version](https://img.shields.io/npm/v/scimgateway.svg?style=flat-square&label=latest)](https://www.npmjs.com/package/scimgateway)[![npm Downloads](https://img.shields.io/npm/dm/scimgateway.svg?style=flat-square)](https://www.npmjs.com/package/scimgateway) [![chat disqus](https://jelhub.github.io/images/chat.svg)](https://elshaug.xyz/docs/scimgateway#disqus_thread) [![GitHub forks](https://img.shields.io/github/forks/jelhub/scimgateway.svg?style=social&label=Fork)](https://github.com/jelhub/scimgateway)  
 
 ---  
 Author: Jarle Elshaug  
@@ -16,8 +16,9 @@ Validated through IdP's:
   
 Latest news:  
 
+- **BREAKING**: [SCIM Stream](https://elshaug.xyz/docs/scim-stream) is the modern way of user provisioning letting clients subscribe to messages instead of traditional IGA top-down provisioning. SCIM Stream includes **SCIM Stream Gateway**, the next generation SCIM Gateway that supports message subscription and automated provisioning
 - Supporting OAuth Client Credentials authentication
-- Major version v4.0.0. getUsers() and getGroups() replacing some deprecated methods. No limitations on filtering/sorting. Admin user access can be limited to specific baseEntities. New MongoDB plugin  
+- Major version v4.0.0. getUsers() and getGroups() replacing some deprecated methods. No limitations on filtering/sorting. Admin user access can be linked to specific baseEntities. New MongoDB plugin  
 - ipAllowList for restricting access to allowlisted IP addresses or subnets e.g. Azure AD IP-range  
 - General LDAP plugin configured for Active Directory  
 - [PlugSSO](https://elshaug.xyz/docs/plugsso) using SCIM Gateway
@@ -39,7 +40,7 @@ Using Identity Manager, we could setup one or more endpoints of type SCIM pointi
 
 ![](https://jelhub.github.io/images/ScimGateway.svg)
 
-SCIM Gateway is based on the popular asynchronous event driven framework [Node.js](https://nodejs.dev/) using JavaScript. It is firewall friendly using REST webservices. Runs on almost all operating systems, and may load balance between hosts (horizontal) and cpu's (vertical). Could even be uploaded and run as a cloud application.
+SCIM Gateway is based on the popular asynchronous event driven framework [Node.js](https://nodejs.dev/) using JavaScript. It is cloud and firewall friendly using REST webservices. Runs on almost all operating systems, and may load balance between hosts (horizontal) and cpu's (vertical).
 
 **Following example plugins are included:**
 
@@ -52,18 +53,18 @@ Setting `{"persistence": true}` gives persistence file store (no test users)
 Example of a fully functional SCIM Gateway plugin  
 
 * **MongoDB** (NoSQL Document-Oriented Database)  
-Same as plugin "Loki" but using MongoDB  
+Same as plugin "Loki", but using external MongoDB  
 Shows how to implement a highly configurable multi tenant or multi endpoint solution through `baseEntity` in URL
 
 * **SCIM** (REST Webservice)  
-Demonstrates user provisioning towards a SCIM endpoint using REST   
+Demonstrates user provisioning towards REST-Based endpoint (type SCIM) 
 Using plugin "Loki" as SCIM endpoint  
 Can be used as SCIM version-gateway e.g. 1.1=>2.0 or 2.0=>1.1  
 Can be used to chain several SCIM Gateway's  
 
 
 * **Forwardinc** (SOAP Webservice)  
-Demonstrates provisioning towards SOAP-Based endpoint   
+Demonstrates user provisioning towards SOAP-Based endpoint   
 Using endpoint Forwardinc that comes with Broadcom/CA IM SDK (SDKWS) - [wiki.ca.com](https://docops.ca.com/ca-identity-manager/12-6-8/EN/programming/connector-programming-reference/sdk-sample-connectors/sdkws-sdk-web-services-connector/sdkws-sample-connector-build-requirements "wiki.ca.com")    
 Shows how to implement a highly configurable multi tenant or multi endpoint solution through `baseEntity` in URL  
 
@@ -103,7 +104,7 @@ Node.js is a prerequisite and have to be installed on the server.
 #### Install SCIM Gateway  
 
 Open a command window (run as administrator)  
-Create your own package directory e.g. C:\my-scimgateway and install SCIM Gateway within this package.
+Create your own package directory e.g. c:\my-scimgateway and install SCIM Gateway within this package.
 
 	mkdir c:\my-scimgateway
 	cd c:\my-scimgateway
@@ -127,22 +128,22 @@ If internet connection is blocked, we could install on another machine and copy
 	=> Health check with a "hello" response
 
 	http://localhost:8880/Users  
-	http://localhost:8880/Groups
-	or 
-	http://localhost:8880/Users?attributes=userName
-	http://localhost:8880/Groups?attributes=displayName  
+	http://localhost:8880/Groups 
 	=> Logon using gwadmin/password and two users and groups should be listed  
 
 	http://localhost:8880/Users/bjensen
 	http://localhost:8880/Groups/Admins
+	or
+	http://localhost:8880/Users?filter=userName eq "bjensen"
+	http://localhost:8880/Groups?filter=displayName eq "Admins"
 	=> Lists all attributes for specified user/group
 
     http://localhost:8880/Groups?filter=displayName eq "Admins"&excludedAttributes=members
+    http://localhost:8880/Groups?filter=members.value eq "bjensen"&attributes=id,displayName,members.value
     http://localhost:8880/Users?filter=userName eq "bjensen"&attributes=userName,id,name.givenName
     http://localhost:8880/Users?filter=meta.created ge "2010-01-01T00:00:00Z"&attributes=userName,name.familyName,meta.created
     http://localhost:8880/Users?filter=emails.value co "@example.com"&attributes=userName,name.familyName,emails&sortBy=name.familyName&sortOrder=descending
-    => Filtering examples
-
+    => Filtering and attribute examples
 
 	"Ctrl + c" to stop the SCIM Gateway
 
@@ -171,7 +172,7 @@ Upgrade to latest minor version:
 	cd c:\my-scimgateway
 	npm install scimgateway
 
-Note, always backup/copy C:\\my-scimgateway before upgrading. Custom plugins and corresponding configuration files will not be affected.  
+Note, always backup/copy c:\\my-scimgateway before upgrading. Custom plugins and corresponding configuration files will not be affected.  
 
 To force a major upgrade (version x.\*.\* => y.\*.\*) that will brake compability with any existing custom plugins, we have to include the `@latest` suffix in the install command: `npm install scimgateway@latest`
 
@@ -1142,6 +1143,18 @@ MIT © [Jarle Elshaug](https://www.elshaug.xyz)
 
 ## Change log  
 
+### v4.1.6  
+[Added]
+- Dependencies bump  
+
+### v4.1.5  
+[Added]  
+
+Announcing some SCIM Gateway related news:  
+
+- [SCIM Stream](https://elshaug.xyz/docs/scim-stream) is the modern way of user provisioning letting clients subscribe to messages instead of traditional IGA top-down provisioning. SCIM Stream includes **SCIM Stream Gateway**, the next generation SCIM Gateway that supports message subscription and automated provisioning
+
+
 ### v4.1.4  
 [Fixed] 
 

package/lib/scimgateway.js

@@ -1307,6 +1307,7 @@ const ScimGateway = function () {
         delete newObj.externalId
         delete newObj.groups // do not support "group member of users"
         delete newObj.schemas
+        delete newObj.meta
         if (handle.getMethod === handler.groups.getMethod) delete newObj.displayName
 
         let [scimdata, err] = ScimGateway.prototype.convertedScim(newObj)

package/lib/utils.js

@@ -190,7 +190,7 @@ module.exports.copyObj = (o) => { // deep copy/clone faster than JSON.parse(JSON
   return output
 }
 
-module.exports.extendObj = (obj, src) => { // copy src content into obj
+const extendObj = (obj, src) => {
   Object.keys(src).forEach((key) => {
     if (typeof src[key] === 'object' && src[key] != null) {
       if (typeof obj[key] === 'undefined') obj[key] = src[key]
@@ -222,6 +222,11 @@ module.exports.extendObj = (obj, src) => { // copy src content into obj
   return obj
 }
 
+module.exports.extendObj = (obj, src) => { // copy src content into obj
+  if (typeof src !== 'object' || Array.isArray(src)) return obj
+  return extendObj(obj, src)
+}
+
 module.exports.stripObj = (obj, attributes, excludedAttributes) => { // strip and return a new object according to attributes or excludedAttributes - comma separated dot object list
   if (!attributes && !excludedAttributes) return obj
   if (!obj || typeof obj !== 'object') return obj

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scimgateway",
-  "version": "4.1.4",
+  "version": "4.1.6",
   "description": "Using SCIM protocol as a gateway for user provisioning to other endpoints",
   "author": "Jarle Elshaug <jarle.elshaug@gmail.com> (https://elshaug.xyz)",
   "homepage": "https://elshaug.xyz",
@@ -34,22 +34,22 @@
   "dependencies": {
     "callsite": "^1.0.0",
     "dot-object": "^2.1.4",
-    "https-proxy-agent": "^5.0.0",
+    "https-proxy-agent": "^5.0.1",
     "is-in-subnet": "^4.0.1",
     "jsonwebtoken": "^8.5.1",
     "koa": "^2.13.4",
     "koa-bodyparser": "^4.3.0",
-    "koa-router": "^10.1.1",
-    "ldapjs": "^2.3.1",
+    "koa-router": "^12.0.0",
+    "ldapjs": "^2.3.3",
     "lokijs": "^1.5.12",
-    "mongodb": "^4.2.0",
+    "mongodb": "^4.10.0",
     "node-machine-id": "1.1.9",
-    "nodemailer": "^6.7.1",
-    "passport": "^0.5.2",
-    "passport-azure-ad": "^4.3.1",
-    "soap": "^0.43.0",
-    "tedious": "^14.0.0",
-    "winston": "^3.4.0"
+    "nodemailer": "^6.7.8",
+    "passport": "^0.6.0",
+    "passport-azure-ad": "^4.3.4",
+    "soap": "^0.45.0",
+    "tedious": "^15.1.0",
+    "winston": "^3.8.2"
   },
   "devDependencies": {
     "chai": "^4.2.0",