Merge pull request #63 from Onboardbase/post-sdk-updates

feat: shared utils

Author: iamnasirudeen

package.json

@@ -1,6 +1,6 @@
 {
   "name": "securelog-scan",
-  "version": "3.0.13",
+  "version": "3.0.14",
   "description": "A CLI tool to scan codebases for potential secrets.",
   "main": "dist/index.js",
   "author": {

src/fileScanner.ts

@@ -78,22 +78,6 @@ export const processPossibleSecretsInString = async (
   if (!core) return modifiedValue;
 };
 
-export const scanStringAndReturnJson = async (options: ScanStringOptions) => {
-  const core = new AhoCorasickCore();
-  const detectors = core.findMatchingDetectors(options.rawValue as string);
-  const response = await Promise.all(
-    detectors.map(async (detector) => {
-      const { scan } = detector;
-      const scanResponse = await scan(false, options.rawValue as string);
-      if (scanResponse) {
-        return scanResponse;
-      }
-    })
-  );
-
-  return response;
-};
-
 /**
  * Processes possible secrets and checks for matches.
  */

src/shared/index.ts

@@ -0,0 +1,50 @@
+/**
+ * All methods here are supposed to be used on the SDK
+ * and other securelog libraries
+ */
+
+import { AhoCorasickCore } from "../ahocorasick";
+import { ScanStringOptions } from "../types";
+import { maskString } from "../util";
+
+export const redactSensitiveData = async (options: ScanStringOptions) => {
+  const core = new AhoCorasickCore();
+  const detectors = core.findMatchingDetectors(options.rawValue as string);
+  let modifiedValue = options.rawValue;
+
+  const secrets = await Promise.all(
+    detectors.map(async (detector) => {
+      const { scan } = detector;
+      const scanResponse = await scan(false, options.rawValue as string);
+      if (scanResponse) {
+        modifiedValue = modifiedValue?.replaceAll(
+          scanResponse.rawValue as string,
+          maskString(scanResponse.rawValue as string, {
+            maskValue: options.maskedValue,
+            visibleChars: options.visibleChars,
+          })
+        );
+
+        return scanResponse;
+      }
+    })
+  );
+
+  return { rawValue: modifiedValue, secrets };
+};
+
+export const scanStringAndReturnJson = async (options: ScanStringOptions) => {
+  const core = new AhoCorasickCore();
+  const detectors = core.findMatchingDetectors(options.rawValue as string);
+  const response = await Promise.all(
+    detectors.map(async (detector) => {
+      const { scan } = detector;
+      const scanResponse = await scan(false, options.rawValue as string);
+      if (scanResponse) {
+        return scanResponse;
+      }
+    })
+  );
+
+  return response;
+};