scimgateway 5.0.2 → 5.0.4

package/README.md

@@ -569,8 +569,9 @@ docker-compose**
 
 		mkdir /opt/my-scimgateway  
 		cd /opt/my-scimgateway  
-		npm init -y  
-		npm install scimgateway  
+		bun init -y  
+		bun install scimgateway  
+		bun pm trust scimgateway  
 		cp ./config/docker/* .  
 
 	**docker-compose.yml**   <== Here is where you would set the exposed port and environment  
@@ -819,15 +820,29 @@ If using proxy, set proxy.host to `"http://<FQDN-ProxyHost>:<port>"` e.g `"http:
 	"endpoint": {
 	  "entity": {
 	    "undefined": {
-	      "tenantIdGUID": "DomainName or DirectoryID (GUID)",
-	      "clientId": "Application ID",
-	      "clientSecret": "Generated application key value",
-          "proxy": {
-            "host": null,
-            "username": null,
-            "password": null
-          }
+		  "connection": {
+		    "baseUrls": [
+			  "not in use for Entra ID when tenantIdGUID is defined"
+		    ],
+		    "auth": {
+			  "type": "oauth",
+			  "options": {
+			    "tokenUrl": "oauth token_url - not in use when tenantIdGUID is defined",
+			    "tenantIdGUID": "Entra ID Tenant ID (GUID) or Primary domain name - only used by plugin-entra-id",
+			    "clientId": "oauth client_id - Entra ID: Application ID",
+			    "clientSecret": "oauth client_secret - Entra ID: generated application secret value"
+			  }
+		    },
+		    "proxy": {
+			  "host": null,
+			  "username": null,
+			  "password": null
+		    }
+		  }
 	    }
+	  },
+	  "map": {
+	    ...
 	  }
 	}
 
@@ -946,7 +961,7 @@ Preparation:
 
 * Copy "best matching" example plugin e.g. `lib\plugin-mssql.ts` and `config\plugin-mssql.json` and rename both copies to your plugin name prefix e.g. plugin-mine.ts and plugin-mine.json (for SOAP Webservice endpoint we might use plugin-soap as a template) 
 * Edit plugin-mine.json and define a unique port number for the gateway setting  
-* Edit index.ts and add a new line for starting your plugin e.g. `let mine = require('./lib/plugin-mine');`  
+* Edit index.ts and include your plugin in the startup e.g. `const plugins = ['mine']');`  
 * Start SCIM Gateway and verify. If using CA Provisioning you could setup a SCIM endpoint using the port number you defined  
 
 Now we are ready for custom coding by editing plugin-mine.ts
@@ -1071,6 +1086,23 @@ MIT © [Jarle Elshaug](https://www.elshaug.xyz)
 
 ## Change log  
 
+### v5.0.4  
+
+[Improved] 
+
+- minor type definition cosmetics
+
+### v5.0.3  
+
+[Fixed]
+
+- unauthorized connection when using configuration bearerJwtAzure 
+
+[Improved] 
+
+- minor type definition cosmetics
+
+
 ### v5.0.2  
 
 [Improved] 

package/index.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env bun
 
 //
-// for nodejs (version >= 22.6.0) use shebang: #!/usr/bin/env -S node --experimental-strip-types
+// for Node.js (version >= 22.6.0) use shebang: #!/usr/bin/env -S node --experimental-strip-types
 //
 // SCIM Gateway plugin startup
 // One or more plugin can be started having unique port listener (configuration scimgateway.port)
@@ -9,10 +9,10 @@
 // example starting all default plugins:
 // const plugins = ['loki', 'scim', 'entra-id', 'ldap', 'mssql', 'api', 'mongodb', 'saphana', 'soap']
 // 
-// some plugins may require modules to be installed e.g.,:
-// soap    - bun/npm install soap
-// mssql   - bun/npm install tedious
-// saphana - bun/npm install hdb
+// some plugin requires module to be installed e.g.,:
+// plugin-soap: bun install soap
+// plugin-mssql: bun install tedious
+// plugin-saphana - bun install hdb
 //
 
 const plugins = ['loki']

package/lib/helper-rest.ts

@@ -11,7 +11,7 @@ import type ScimGateway from 'scimgateway'
  */
 export class HelperRest {
   private lock = new utils.Lock()
-  private _serviceClient = {}
+  private _serviceClient: Record<string, any> = {}
   private config_entity: any
   private scimgateway: ScimGateway
   private graphUrl = 'https://graph.microsoft.com/beta' // beta instead of 'v1.0' gives all user attributes when no $select
@@ -47,8 +47,8 @@ export class HelperRest {
   * @param ctx having format { autorization: "<type>:xxxxx" }
   * @returns user_secret
   **/
-  private getClientIdentifier(ctx): string | undefined {
-    if (!ctx?.headers?.authorization) return undefined
+  private getClientIdentifier(ctx: Record<string, any> | undefined): string {
+    if (!ctx?.headers?.authorization) return 'undefined'
     const [user, secret] = this.getCtxAuth(ctx)
     return `${encodeURIComponent(user)}_${encodeURIComponent(secret)}` // user_password or undefined_password
   }
@@ -58,7 +58,7 @@ export class HelperRest {
   * @param ctx includes Auth PassThrough having format {headers:{autorization:"<type>:xxxxx"}}
   * @returns [username, secret]
   **/
-  private getCtxAuth(ctx): any[] {
+  private getCtxAuth(ctx: Record<string, any> | undefined): any[] {
     if (!ctx?.headers?.authorization) return []
     const [authType, authToken] = (ctx.headers.authorization || '').split(' ') // [0] = 'Basic' or 'Bearer'
     let username, password
@@ -73,7 +73,7 @@ export class HelperRest {
    * @param ctx 
    * @returns oauth accesstoken
    */
-  private async getAccessToken(baseEntity: string, ctx: string | undefined) {
+  private async getAccessToken(baseEntity: string, ctx: Record<string, any> | undefined) {
     await this.lock.acquire()
     const clientIdentifier = this.getClientIdentifier(ctx)
     const d = Math.floor(Date.now() / 1000) // seconds (unix time)
@@ -381,7 +381,7 @@ export class HelperRest {
    * @param clientIdentifier 
    * @param obj 
    */
-  private updateServiceClient(baseEntity: string, clientIdentifier: string | undefined, obj: any) {
+  private updateServiceClient(baseEntity: string, clientIdentifier: string, obj: any) {
     if (this._serviceClient[baseEntity] && this._serviceClient[baseEntity][clientIdentifier]) this._serviceClient[baseEntity][clientIdentifier] = utils.extendObj(this._serviceClient[baseEntity][clientIdentifier], obj)
   }
 
@@ -396,7 +396,7 @@ export class HelperRest {
   * @param opt web-standard fetch client options, e.g., options not defined as general options in configuration file
   * @param retryCount internal use only - internal counter for retry and failover logic to other baseUrls defined
   **/
-  private async doRequestHandler(baseEntity: string, method: string, path: string, body?: any, ctx?: any, opt?: any, retryCount?: number) {
+  private async doRequestHandler(baseEntity: string, method: string, path: string, body?: any, ctx?: any, opt?: any, retryCount?: number): Promise<any> {
     let retryAfter = 0
     try {
       const cli = await this.getServiceClient(baseEntity, method, path, opt, ctx)

package/lib/plugin-ldap.ts

@@ -82,6 +82,7 @@
 'use strict'
 
 import ldap from 'ldapjs'
+// @ts-expect-error missing type definitions
 import { BerReader } from '@ldapjs/asn1'
 
 // for supporting nodejs running scimgateway package directly, using dynamic import instead of: import { ScimGateway } from 'scimgateway'
@@ -219,7 +220,7 @@ scimgateway.getUsers = async (baseEntity, getObj, attributes, ctx) => {
   try {
     const users: any = await doRequest(baseEntity, method, base, ldapOptions, ctx) // ignoring SCIM paging startIndex/count - get all
     result.totalResults = users.length
-    result.Resources = await Promise.all(users.map(async (user) => { // Promise.all because of async map
+    result.Resources = await Promise.all(users.map(async (user: any) => { // Promise.all because of async map
       // endpoint spesific attribute handling
       // "active" must be handled separate
       if (user.userAccountControl !== undefined) { // SCIM "active" - Active Directory
@@ -368,7 +369,7 @@ scimgateway.modifyUser = async (baseEntity, id, attrObj, ctx) => {
     delete attrObj.groups // make sure to be removed from attrObj
 
     const [groupsAttr] = scimgateway.endpointMapper('outbound', 'groups.value', config.map.user)
-    const grp = { add: {}, remove: {} }
+    const grp: any = { add: {}, remove: {} }
     grp.add[groupsAttr] = []
     grp.remove[groupsAttr] = []
 
@@ -484,7 +485,7 @@ scimgateway.modifyUser = async (baseEntity, id, attrObj, ctx) => {
       // clean up zoombie group members and use the new user DN incase not handled by ldap server
       const [memberAttr] = scimgateway.endpointMapper('outbound', 'members.value', config.map.group)
       if (memberAttr) {
-        const grp = { add: {}, remove: {} }
+        const grp: any = { add: {}, remove: {} }
         grp.add[memberAttr] = []
         grp.remove[memberAttr] = []
         let r
@@ -644,7 +645,7 @@ scimgateway.getGroups = async (baseEntity, getObj, attributes, ctx) => {
     if (ldapOptions === 'getMemberOfGroups') result.Resources = await getMemberOfGroups(baseEntity, getObj.value, ctx)
     else {
       const groups: any = await doRequest(baseEntity, method, base, ldapOptions, ctx)
-      result.Resources = await Promise.all(groups.map(async (group) => { // Promise.all because of async map
+      result.Resources = await Promise.all(groups.map(async (group: any) => { // Promise.all because of async map
         if (config.useSID_id || config.useGUID_id) {
           if (group.member) {
             const arr: string[] = []
@@ -756,7 +757,7 @@ scimgateway.modifyGroup = async (baseEntity, id, attrObj, ctx) => {
   const [memberAttr] = scimgateway.endpointMapper('outbound', 'members.value', config.map.group)
   if (!memberAttr && attrObj.members) throw new Error(`${action} error: missing attribute mapping configuration for group members`)
 
-  const grp = { add: {}, remove: {} }
+  const grp: any = { add: {}, remove: {} }
   grp.add[memberAttr] = []
   grp.remove[memberAttr] = []
 
@@ -821,14 +822,14 @@ scimgateway.modifyGroup = async (baseEntity, id, attrObj, ctx) => {
 // helpers
 // =================================================
 
-const _serviceClient = {}
+const _serviceClient: Record<string, any> = {}
 
 //
 // createAndFilter creates AndFilter object to be used as filter instead of standard string filter
 // Using AndFilter object for eliminating internal ldapjs escaping problems related to values with some
 // combinations of parentheses e.g. ab(c)d
 //
-const createAndFilter = (baseEntity, type, arrObj) => {
+const createAndFilter = (baseEntity: string, type: string, arrObj: any) => {
   const objFilters: ldap.PresenceFilter[] | ldap.SubstringFilter[] = []
 
   // add arrObj
@@ -906,7 +907,7 @@ const createAndFilter = (baseEntity, type, arrObj) => {
 //
 // dnToSidGuid is used for Active Directory to return objectGUID based on dn
 //
-const dnToSidGuid = async (baseEntity, dn, ctx): Promise<string> => {
+const dnToSidGuid = async (baseEntity: string, dn: any, ctx: any): Promise<string> => {
   const method = 'search'
   const ldapOptions: any = {}
   if (config.useSID_id) ldapOptions.attributes = ['objectSid']
@@ -928,7 +929,7 @@ const dnToSidGuid = async (baseEntity, dn, ctx): Promise<string> => {
 //
 // guidToDn is used for Active Directory to return dn based on objectGUID
 //
-const sidGuidToDn = async (baseEntity, id, ctx): Promise<string> => {
+const sidGuidToDn = async (baseEntity: string, id: string, ctx: any): Promise<string> => {
   const method = 'search'
   const ldapOptions = {
     attributes: ['dn'],
@@ -959,8 +960,8 @@ const sidGuidToDn = async (baseEntity, id, ctx): Promise<string> => {
 // output: S-1-5-21-2657077294-4200173015-2627628055-1146
 // ref: https://gist.github.com/Krizzzn/0ae47f280cca9749c67759a9adedc015
 //
-const pad = function (s) { if (s.length < 2) { return `0${s}` } else { return s } }
-const convertSidToString = (buf) => {
+const pad = function (s: any) { if (s.length < 2) { return `0${s}` } else { return s } }
+const convertSidToString = (buf: any) => {
   let asc: any, end: any
   let i: number
   if (buf == null) { return null }
@@ -997,7 +998,7 @@ const convertSidToString = (buf) => {
 // output: 010500000000000515000000a065cf7e784b9b5fe77c8770091c0100
 // ref: https://devblogs.microsoft.com/oldnewthing/20040315-00/?p=40253
 //
-const convertStringToSid = (sidStr) => {
+const convertStringToSid = (sidStr: string) => {
   const arr = sidStr.split('-')
   if (arr.length !== 8) return null
   try {
@@ -1025,7 +1026,7 @@ const convertStringToSid = (sidStr) => {
 // getMemberOfGroups returns all groups the user is member of
 // [{ id: <id-group>> , displayName: <displayName-group>, members [{value: <id-user>}] }]
 //
-const getMemberOfGroups = async (baseEntity, id, ctx) => {
+const getMemberOfGroups = async (baseEntity: string, id: string, ctx: any) => {
   const action = 'getMemberOfGroups'
   if (!config.map.group) throw new Error('missing configuration endpoint.map.group') // not using groups
 
@@ -1075,7 +1076,7 @@ const getMemberOfGroups = async (baseEntity, id, ctx) => {
 
   try {
     const groups: any = await doRequest(baseEntity, method, base, ldapOptions, ctx)
-    return groups.map((grp) => {
+    return groups.map((grp: any) => {
       return { // { id: <id-group>> , displayName: <displayName-group>, members [{value: <id-user>}] }
         id: encodeURIComponent(grp[attrs[0]]), // not mandatory, but included anyhow
         displayName: grp[attrs[1]], // displayName is mandatory
@@ -1093,7 +1094,7 @@ const getMemberOfGroups = async (baseEntity, id, ctx) => {
 // using OpenLDAP, DN must be escaped - national characters and special ldap characters
 // using Active Directory (none OpenLDAP), DN should not be escaped, but DN retrieved from AD is character escaped
 //
-const ldapEscDn = (isOpenLdap, str) => {
+const ldapEscDn = (isOpenLdap: any, str: string) => {
   if (typeof str !== 'string' || str.length < 1) return str
 
   if (!isOpenLdap && str.indexOf('\\') > 0) {
@@ -1150,13 +1151,13 @@ const ldapEscDn = (isOpenLdap, str) => {
       if (i === 0) {
         const ua = new Uint8Array(Buffer.from(a[1], 'utf-8'))
         const buf = Buffer.from(new Uint8Array([4, ua.length, ...ua]))
-        const rdn = {}
+        const rdn: any = {}
         rdn[a[0]] = new BerReader(buf)
         dn.push(new ldap.RDN(rdn))
         // new BerReader(Buffer.from([0x04, 0x05, 0x4B, 0xc3, 0xbc, 0x72, 0x74])) // Kürt
         // the leading 04 is the tag for "octet string" and the following 05 is the length in bytes of the string.
       } else {
-        const rdn = {}
+        const rdn: any = {}
         rdn[a[0]] = a[1]
         dn.push(new ldap.RDN(rdn))
       }
@@ -1172,7 +1173,7 @@ const ldapEscDn = (isOpenLdap, str) => {
 // Hex encoded escaping (extended and unicode ascii) is not included because
 // automatically handled by ldapjs when not using BER encoded DN
 //
-const ldapEsc = (str) => {
+const ldapEsc = (str: any) => {
   if (!str) return str
   let newStr = ''
   for (let i = 0; i < str.length; i++) {
@@ -1228,7 +1229,7 @@ const ldapEsc = (str) => {
 // only using BER on first part of dn
 // Having BER decoding for Active Directory, but not for OpenLDAP
 //
-const berDecodeDn = (dn) => {
+const berDecodeDn = (dn: any) => {
   if (Object.prototype.toString.call(dn) !== '[object LdapDn]') return dn // OpenLDAP
   const str = dn.toString()
   if (str.indexOf('#') < 1) return str
@@ -1262,7 +1263,7 @@ const berDecodeDn = (dn) => {
   return str
 }
 
-const getNamingAttribute = (baseEntity, type) => {
+const getNamingAttribute = (baseEntity: string, type: string) => {
   let arr
   switch (type) {
     case 'user':
@@ -1278,7 +1279,7 @@ const getNamingAttribute = (baseEntity, type) => {
   return [arr[0].attribute, arr[0].mapTo]
 }
 
-const checkIfNewDN = (baseEntity, base, type, obj, endpointObj) => {
+const checkIfNewDN = (baseEntity: string, base: any, type: string, obj: any, endpointObj: any) => {
   if (typeof obj !== 'object' || Object.keys(obj).length < 1) return ''
   if (typeof endpointObj !== 'object' || Object.keys(endpointObj).length < 1) return ''
 
@@ -1326,7 +1327,7 @@ const checkIfNewDN = (baseEntity, base, type, obj, endpointObj) => {
 //
 // getCtxAuth returns username/secret from ctx header when using Auth PassThrough
 //
-const getCtxAuth = (ctx) => {
+const getCtxAuth = (ctx: any) => {
   if (!ctx?.request?.header?.authorization) return []
   const [authType, authToken] = (ctx.request.header.authorization || '').split(' ') // [0] = 'Basic' or 'Bearer'
   let username, password
@@ -1338,7 +1339,7 @@ const getCtxAuth = (ctx) => {
 //
 // getServiceClient returns LDAP client used by doRequest
 //
-const getServiceClient = async (baseEntity, ctx) => {
+const getServiceClient = async (baseEntity: string, ctx: any) => {
   const action = 'getServiceClient'
   // TODO if (!config.entity[baseEntity].passwordDecrypted) config.entity[baseEntity].passwordDecrypted = scimgateway.getPassword(`endpoint.entity.${baseEntity}.password`, configFile)
   if (!config.entity[baseEntity].baseUrl) config.entity[baseEntity].baseUrl = config.entity[baseEntity].baseUrls[0] // failover logic also updates baseUrl
@@ -1390,7 +1391,7 @@ const getServiceClient = async (baseEntity, ctx) => {
 //         "attributes": ["sAMAccountName","displayName","mail"]
 //       }
 //
-const doRequest = async (baseEntity, method, base, options, ctx) => {
+const doRequest = async (baseEntity: string, method: string, base: any, options: any, ctx: any) => {
   if (!config.entity[baseEntity]) throw new Error(`unsupported baseEntity: ${baseEntity}`)
   let result: any = null
   let client: any = null
@@ -1413,15 +1414,15 @@ const doRequest = async (baseEntity, method, base, options, ctx) => {
         result = await new Promise((resolve, reject) => {
           const results: any = []
 
-          client.search(base, options, (err, search) => {
+          client.search(base, options, (err: any, search: any) => {
             if (err) {
               return reject(err)
             }
 
-            search.on('searchEntry', (entry) => {
+            search.on('searchEntry', (entry: any) => {
               if (!entry.pojo || !entry.pojo.attributes) return
               const obj: any = { dn: entry.pojo.objectName }
-              entry.pojo.attributes.map((el) => {
+              entry.pojo.attributes.map((el: any) => {
                 if (el.values.length > 1) obj[el.type] = el.values
                 else obj[el.type] = el.values[0]
                 return null
@@ -1449,7 +1450,7 @@ const doRequest = async (baseEntity, method, base, options, ctx) => {
                 // for OpenLDAP ensure dn is not hex escaped e.g.: cn=K\c3\bcrt => cn=Kürt
                 // because dn may be be used as value in standard attributes like group memberOf
                 obj.dn = obj.dn.replace(/\\\\/g, '__') // temp
-                let conv = obj.dn.replace(/\\([0-9A-Fa-f]{2})/g, (_, hex) => {
+                let conv = obj.dn.replace(/\\([0-9A-Fa-f]{2})/g, (_: any, hex: any) => {
                   const intAscii = parseInt(hex, 16)
                   if (intAscii > 128) { // extended ascii - will be unescaped by decodeURIComponent
                     return '%' + hex
@@ -1470,12 +1471,12 @@ const doRequest = async (baseEntity, method, base, options, ctx) => {
             })
             */
 
-            search.on('error', (err) => {
+            search.on('error', (err: any) => {
               if (err.message.includes('LdapErr: DSID-0C0909F2') || err.message.includes('NO_OBJECT')) return resolve([]) // object not found when using base <SID=...> or <GUID=...> ref. objectSid/objectGUID
               reject(err)
             })
 
-            search.on('end', (_) => { resolve(results) })
+            search.on('end', (_: any) => { resolve(results) })
           })
         })
         break
@@ -1506,7 +1507,7 @@ const doRequest = async (baseEntity, method, base, options, ctx) => {
             })
             changes.push(change)
           }
-          client.modify(dn, changes, (err) => {
+          client.modify(dn, changes, (err: any) => {
             if (err) {
               if (options.operation && options.operation === 'add') {
                 const msg = err.message.toLowerCase()
@@ -1526,7 +1527,7 @@ const doRequest = async (baseEntity, method, base, options, ctx) => {
           let newDN = options?.modification?.newDN
           if (!newDN) return reject(new Error('modifyDN() missing newDN'))
           if (Object.prototype.toString.call(newDN) === '[object LdapDn]') newDN = newDN.toString()
-          client.modifyDN(dn, newDN, (err) => {
+          client.modifyDN(dn, newDN, (err: any) => {
             if (err) {
               return reject(err)
             }
@@ -1537,7 +1538,7 @@ const doRequest = async (baseEntity, method, base, options, ctx) => {
 
       case 'add':
         result = await new Promise((resolve: any, reject: any) => {
-          client.add(base, options, (err) => {
+          client.add(base, options, (err: any) => {
             if (err) {
               return reject(err)
             }
@@ -1548,7 +1549,7 @@ const doRequest = async (baseEntity, method, base, options, ctx) => {
 
       case 'del':
         result = await new Promise((resolve: any, reject: any) => {
-          client.del(base, (err) => {
+          client.del(base, (err: any) => {
             if (err) {
               return reject(err)
             }