@ikonintegration/ikapi 3.0.2 → 3.0.3

package/README.md

@@ -42,6 +42,13 @@ export const handler = async (event, context) => {
     validation: {
       additionalTypes: { TYPE: (val) => { return validate(val); } }
     },
+    //Logger
+    logger: {
+      //takes precende over process.env.LOG_LEVEL
+      level: 'DEBUG' | 'INFO' | 'WARN' | 'ERROR',
+      enableSensitiveFiltering: false, //defaults to false
+      sensitiveFilteringKeywords: [], //replaced default blacklist set
+    },
     //Queue
     publisher: { region: 'SNS-REGION' }
   };)).handleEvent(event, context));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ikonintegration/ikapi",
-  "version": "3.0.2",
+  "version": "3.0.3",
   "description": "",
   "main": "index.js",
   "module": "main.js",

package/src/BaseEvent/IKProcess.js

@@ -15,7 +15,7 @@ export default class IKProcess {
   constructor(config, interval) {
     this._config = config;
     this.interval = interval;
-    this.logger = new IKLogger({/*COFIG S3/SQS HERE*/}, Utils.logLevel());
+    this.logger = new IKLogger(config.logger, Utils.logLevel());
     this.publisher = new IKPublisher(config.publisher);
     this.validator = new IKValidation(config.validation);
     this.db = this._getDBDriver();

package/src/BaseEvent/IKTransaction.js

@@ -28,7 +28,7 @@ export default class IKTransaction {
     //When set, this will be called with the response context right before calling the context suceed/fail
     this.responseProxy = null;
     //
-    this.logger = new IKLogger({/*COFIG S3/SQS HERE*/}, Utils.logLevel(), (context.awsRequestId ? context.awsRequestId : (event.requestContext ? event.requestContext.requestId : 'unknown')));
+    this.logger = new IKLogger(config.logger, Utils.logLevel(), (context.awsRequestId ? context.awsRequestId : (event.requestContext ? event.requestContext.requestId : 'unknown')));
     this.request = new IKRequest(this._event, this._context, this);
     this.publisher = new IKPublisher(config.publisher);
     this.validator = new IKValidation(config.validation);

package/src/Logger/IKLogger.js

@@ -9,6 +9,8 @@ const LOG_STRINGS = ['DEBUG', 'INFO', 'WARN', 'ERROR'];
 const PURE_CONSOLE = (console.flushLogs ? console.origin : console);
 const DEFAULT_LOG_FUNCTION = PURE_CONSOLE.log.bind(PURE_CONSOLE);
 //
+const blacklist = ['password','phonenumber','code','resetCode','recaptchaToken','token','mfa','REFRESH_TOKEN','SECRET_HASH','SecretHash','AccessToken','UserCode','paymentMethodNonce'];
+//
 export default class IKLogger {
   constructor(_config, _LOG_LEVEL, transactionID) {
     abind(this);
@@ -20,10 +22,11 @@ export default class IKLogger {
     }
     //
     this.origin = PURE_CONSOLE;
-    this._LOG_LEVEL = _LOG_LEVEL;
-    this._s3Config = _config;
+    this._LOG_LEVEL = (_config || {}).level || _LOG_LEVEL;
+    this._config = _config || {};
     this._transactionID = transactionID;
-    this._logs = [];
+    this._filterBlacklist = this._config.sensitiveFilteringKeywords || blacklist;
+    //
     this._setupBindings();
     //
     this.log("Using logger with level: " + LOG_STRINGS[this._LOG_LEVEL]);
@@ -49,7 +52,7 @@ export default class IKLogger {
     this._pushLog(LOG_LEVELS.ERROR, this._formattedLog(LOG_LEVELS.ERROR, msg, this._callerName(3), isRaw));
   }
   //
-  cleanUp() { this._logs = []; }
+  cleanUp() { }
   async flushLogs() {}
 
 
@@ -67,7 +70,7 @@ export default class IKLogger {
   }
 
 
-  //Helpers
+  /* Formatters */
   _timestamp() {
     let d = new Date();
     return [Utils.toDoubleDigit(d.getMonth()+1), Utils.toDoubleDigit(d.getDate()), d.getFullYear()].join('/') +' ' +
@@ -92,6 +95,7 @@ export default class IKLogger {
       } return callerName + ":" + stackTrace.get()[safeIndex].getLineNumber();
     } return '';
   }
+  /* Helpers (core functionality) */
   _processLog(isRaw, level, args) {
     if (level < this._LOG_LEVEL) return;
     //get args
@@ -102,8 +106,30 @@ export default class IKLogger {
     this._pushLog(level, this._formattedLog(level, msg, this._callerName(3), isRaw));
   }
   _pushLog(level, fMsg) {
-    //push into logs stack
-    this._logs.push(fMsg);
-    DEFAULT_LOG_FUNCTION.apply(PURE_CONSOLE, [fMsg]);
+    // push into logs stack
+    // this._logs.push(fMsg);
+    DEFAULT_LOG_FUNCTION.apply(PURE_CONSOLE, [this._supressSensitiveInfo(fMsg)]);
   }
+  /* Sensitive information handling */
+  _supressSensitiveInfo(value) {
+    //realy false
+    if (this._config.enableSensitiveFiltering !== undefined && !this._config.enableSensitiveFiltering) return value;
+    if (typeof value == "string") {
+      //content based replacement
+      blacklist.forEach((f) => {
+        const match = blacklist.find((f) => value.toLowerCase().includes(f.toLowerCase()));
+        if (match) value = '**SUPRESSED_SENSITIVE_DATA**';
+      });
+      return value;
+    } else if (typeof value == 'object') {
+      //key based replacement
+      Object.keys(value).forEach(function (elt, i, array) {
+        const match = blacklist.find((f) => elt.toLowerCase().includes(f.toLowerCase()));
+        if (match) value[elt] = '**SUPRESSED_SENSITIVE_DATA**';
+        else value[elt] = supress(value[elt]);
+      });
+      return value;
+    } else if (Array.isArray(value)) return value.map(v=>supress(v));
+    return value;
+	}
 }