@itentialopensource/adapter-utils 5.10.11 → 5.10.13

package/lib/connectorRest.js

@@ -111,6 +111,7 @@ let addCreds = true;
 let refTokenReq = null;
 let refTokenTimeout = -1;
 let runRefreshToken = false;
+let addSensitiveItems = [];
 
 // Other global variables
 let id = null;
@@ -383,12 +384,12 @@ function returnStub(request, entitySchema, callProperties) {
   if (authLogging) {
     // Can only mask values if header is an object - so can not log anything else
     if (request.header) {
-      log.debug(`FULL STUB REQUEST: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(request.header))}`);
+      log.debug(`FULL STUB REQUEST: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(request.header, addSensitiveItems))}`);
     }
 
     // Can only mask values if body is an object - so can not log anything else
     if (request.body) {
-      log.debug(`FULL STUB BODY: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(request.body))}`);
+      log.debug(`FULL STUB BODY: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(request.body, addSensitiveItems))}`);
     }
   }
 
@@ -776,8 +777,8 @@ function makeRequest(request, entitySchema, callProperties, startTrip, attempt,
 
     // these logs are very useful when debugging - however there is the potential for credentials to be exposed.
     if (authLogging) {
-      log.debug(`FULL REQUEST: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(request.header))}`);
-      log.debug(`FULL BODY: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(request.body))}`);
+      log.debug(`FULL REQUEST: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(request.header, addSensitiveItems))}`);
+      log.debug(`FULL BODY: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(request.body, addSensitiveItems))}`);
     }
 
     // make the call to System
@@ -926,7 +927,7 @@ function makeRequest(request, entitySchema, callProperties, startTrip, attempt,
           healthy = true;
           doneH2(true);
         }, (retH2) => {
-          log.debug(`${origin}: CALL RETURN ${JSON.stringify(propUtilInst.scrubSensitiveInfo(callResp))}`);
+          log.debug(`${origin}: CALL RETURN ${JSON.stringify(propUtilInst.scrubSensitiveInfo(callResp, addSensitiveItems))}`);
           useProt = undefined;
           callResp.reqHdr = request.header.headers;
           return callback(callResp);
@@ -1223,7 +1224,7 @@ async function getToken(reqPath, options, tokenSchema, bodyString, callPropertie
         if (!tokenSchema.responseDatatype || tokenSchema.responseDatatype === 'JSON') {
           tokenResp.response = JSON.parse(tokenResp.response);
         }
-        log.debug(`${origin}: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(tokenResp.response))}`);
+        log.debug(`${origin}: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(tokenResp.response, addSensitiveItems))}`);
 
         // return the token from the token schema
         let translated = null;
@@ -1262,7 +1263,7 @@ async function getToken(reqPath, options, tokenSchema, bodyString, callPropertie
         return resolve({ token: 'faketoken', tokenp2: 'faketoken' });
       }
 
-      log.debug(`${origin}: OPTIONS: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(options))}`);
+      log.debug(`${origin}: OPTIONS: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(options, addSensitiveItems))}`);
 
       // request the token
       return makeRequest(request, tokenSchema, callProperties, null, 0, (result, merror) => {
@@ -1582,9 +1583,9 @@ async function getToken(reqPath, options, tokenSchema, bodyString, callPropertie
         }
 
         // return the token from the token schema
-        log.debug(`About to Translate Token Response: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(tempResult))}`);
+        log.debug(`About to Translate Token Response: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(tempResult, addSensitiveItems))}`);
         let translated = transUtilInst.mapFromOutboundEntity(tempResult, tokenSchema.responseSchema);
-        log.debug(`Translated response ${JSON.stringify(propUtilInst.scrubSensitiveInfo(translated))}`);
+        log.debug(`Translated response ${JSON.stringify(propUtilInst.scrubSensitiveInfo(translated, addSensitiveItems))}`);
 
         // if what we got back is an array, just return the first element
         // should only have one token!!!
@@ -3243,7 +3244,7 @@ function requestAuthenticate(request, entitySchema, invalidToken, callProperties
           }
 
           // format the authentication string
-          log.debug(`${origin}: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(tres))} being used for user: ${useUser}`);
+          log.debug(`${origin}: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(tres, addSensitiveItems))} being used for user: ${useUser}`);
           const authStrs = [];
           if (callProperties && callProperties.authentication && callProperties.authentication.auth_field_format) {
             if (Array.isArray(callProperties.authentication.auth_field_format)) {
@@ -3305,7 +3306,7 @@ function requestAuthenticate(request, entitySchema, invalidToken, callProperties
           return callback(null, errorObj);
         }
 
-        log.debug(`${origin}: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(tokenObj))} being used for user: ${useUser}`);
+        log.debug(`${origin}: ${JSON.stringify(propUtilInst.scrubSensitiveInfo(tokenObj, addSensitiveItems))} being used for user: ${useUser}`);
         const authStrs = [];
         if (callProperties && callProperties.authentication && callProperties.authentication.auth_field_format) {
           if (Array.isArray(callProperties.authentication.auth_field_format)) {
@@ -4354,6 +4355,10 @@ class ConnectorRest {
       if (props.authentication.refresh_token_request && typeof props.authentication.refresh_token_request === 'object') {
         refTokenReq = props.authentication.refresh_token_request;
       }
+
+      if (props.authentication.sensitive) {
+        addSensitiveItems = props.authentication.sensitive;
+      }
     }
 
     // set the stub mode (optional - default is false)
@@ -4850,10 +4855,10 @@ class ConnectorRest {
         log.info(`${origin}: Connector SSL connections enabled`);
       }
 
-      log.debug(`${origin}: HEALTHCHECK OPTIONS: ${JSON.stringify(this.propUtil.scrubSensitiveInfo(options))}`);
+      log.debug(`${origin}: HEALTHCHECK OPTIONS: ${JSON.stringify(this.propUtil.scrubSensitiveInfo(options, addSensitiveItems))}`);
 
       if (payload !== undefined && payload !== null && payload !== '') {
-        log.debug(`${origin}: REQUEST: ${JSON.stringify(this.propUtil.scrubSensitiveInfo(payload))}`);
+        log.debug(`${origin}: REQUEST: ${JSON.stringify(this.propUtil.scrubSensitiveInfo(payload, addSensitiveItems))}`);
 
         // save it in memory
         cacheHPay = payload;
@@ -5047,10 +5052,10 @@ class ConnectorRest {
         log.info(`${origin}: Connector SSL connections enabled`);
       }
 
-      log.debug(`${origin}: OPTIONS: ${JSON.stringify(this.propUtil.scrubSensitiveInfo(options))}`);
+      log.debug(`${origin}: OPTIONS: ${JSON.stringify(this.propUtil.scrubSensitiveInfo(options, addSensitiveItems))}`);
 
       if (incoming.body !== undefined && incoming.body !== null && incoming.body !== '') {
-        log.debug(`${origin}:REQUEST: ${JSON.stringify(this.propUtil.scrubSensitiveInfo(incoming.body))}`);
+        log.debug(`${origin}:REQUEST: ${JSON.stringify(this.propUtil.scrubSensitiveInfo(incoming.body, addSensitiveItems))}`);
       }
 
       const request = {

package/lib/propertyUtil.js

@@ -1153,11 +1153,11 @@ class AdapterPropertyUtil {
     }
 
     // This is the array of sensitive keys
-    let sensList = ['authorization', 'x-auth-token', 'x-csrf-token', 'x-amz-security-token', 'x-aws-ec2-metadata-token', 'cookie', 'set-cookie', 'token', 'tokenp2', 'user', 'username', 'passwd', 'password', 'api-key', 'client-id', 'client-secret', 'client_id', 'client_secret', 'session', 'session-id', 'jsessionid', 'sessionToken', 'accessKeyId', 'secretAccessKey'];
+    let sensList = ['authorization', 'x-auth-token', 'x-csrf-token', 'x-amz-security-token', 'x-aws-ec2-metadata-token', 'cookie', 'set-cookie', 'token', 'tokenp2', 'user', 'username', 'passwd', 'password', 'api-key', 'client-id', 'client-secret', 'client_id', 'client_secret', 'session', 'session-id', 'jsessionid', 'sessionToken', 'accessKeyId', 'secretAccessKey', 'private-token', 'ca'];
 
     // add any additional items to scrub
     if (addItems && Array.isArray(addItems) && addItems.length > 0) {
-      sensList = sensList.concat(addItems);
+      sensList = sensList.concat(addItems.map((item) => item.toLowerCase()));
     }
 
     // going to use copy of data so we do not mess up input - if object will still need to assign it
@@ -1207,7 +1207,7 @@ class AdapterPropertyUtil {
 
           // go through sensitive word list - maybe can use find in
           for (let j = 0; j < sensList.length; j += 1) {
-            if (key.toUpperCase() === sensList[j].toUpperCase()) {
+            if (key.toLowerCase() === sensList[j].toLowerCase()) {
               // if sensitive, mask
               retData += `${key}=** masked **`;
               found = true;
@@ -1247,7 +1247,18 @@ class AdapterPropertyUtil {
       Object.keys(retData).forEach((key) => {
         // go deep through an object with recursive call
         if (typeof retData[key] === 'object') {
-          retData[key] = this.scrubSensitiveInfo(retData[key]);
+          if (Array.isArray(retData[key])) {
+            // Handle arrays that may contain sensitive info
+            for (let k = 0; k < retData[key].length; k += 1) {
+              if (sensList.includes(key.toLowerCase())) {
+                retData[key][k] = '** masked **';
+              } else {
+                retData[key][k] = this.scrubSensitiveInfo(retData[key][k]);
+              }
+            }
+          } else {
+            retData[key] = this.scrubSensitiveInfo(retData[key]);
+          }
         } else {
           // go through sensitive word list - maybe can use find in
           for (let j = 0; j < sensList.length; j += 1) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itentialopensource/adapter-utils",
-  "version": "5.10.11",
+  "version": "5.10.13",
   "description": "Itential Adapter Utility Libraries",
   "scripts": {
     "postinstall": "node utils/setup.js",