Merge pull request #61 from Onboardbase/post-git-rewrite

feat: 3.0.13

package.json

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

src/fileScanner.ts

@@ -3,7 +3,7 @@ import path from "path";
 import { isBinaryFile, maskString, getLineNumber } from "./util";
 import { AhoCorasickCore } from "./ahocorasick";
 import { MAX_FILE_SIZE } from "./constants";
-import { ScanDirectoryOptions, ScanOptions, ScanStringOptions } from "./types";
+import { ScanDirectoryOptions, ScanStringOptions } from "./types";
 import { EventManager } from "./events";
 import { Detector, EScannerTypes } from "./types/detector";
 
@@ -31,7 +31,8 @@ export const processPossibleSecretsInString = async (
   options: ScanStringOptions,
   core?: AhoCorasickCore
 ) => {
-  const { rawValue, file, updateFile, outputFile } = options;
+  const { rawValue, file, updateFile, outputFile, maskedValue, visibleChars } =
+    options;
 
   if (!rawValue || (rawValue === "" && !file)) {
     console.error("A rawValue or file has to be passed");
@@ -56,7 +57,10 @@ export const processPossibleSecretsInString = async (
       if (scanResponse) {
         modifiedValue = modifiedValue.replaceAll(
           scanResponse.rawValue as string,
-          maskString(scanResponse.rawValue as string)
+          maskString(scanResponse.rawValue as string, {
+            maskValue: maskedValue,
+            visibleChars,
+          })
         );
       }
     })

src/types/index.ts

@@ -19,6 +19,8 @@ export interface ScanStringOptions {
   updateFile?: boolean;
   config?: string;
   outputFile?: string;
+  maskedValue?: string;
+  visibleChars?: number;
 }
 
 export interface Config {

src/util.ts

@@ -76,7 +76,12 @@ export const formatBytes = (bytes: number, decimals: number = 2): string => {
   return `${parseFloat((bytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
 };
 
-export const maskString = (str: string, visibleChars: number = 5): string => {
+export const maskString = (
+  str: string,
+  options?: { maskValue?: string; visibleChars?: number }
+): string => {
+  const visibleChars = options?.visibleChars ?? 5;
+
   if (typeof str !== "string" || str.length === 0) {
     throw new Error("Invalid input: Input must be a non-empty string.");
   }
@@ -90,9 +95,9 @@ export const maskString = (str: string, visibleChars: number = 5): string => {
   }
 
   // make the masked chars only 10 characters
-  const maskedPart = "*".repeat(
-    str.length < 10 ? str.length : 10 - visibleChars
-  );
+  const maskedPart =
+    options?.maskValue ??
+    "*".repeat(str.length < 10 ? str.length : 10 - visibleChars);
   const visiblePart = str.slice(0, visibleChars);
   return visiblePart + maskedPart;
 };