@gearbox-protocol/cli-utils 6.14.0 → 6.15.0

package/dist/createPinoCensor.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Gathers known secrets from a config and returns a function that replaces each raw secret with its masked representation.
+ * Intended for pino's `hooks.streamWrite`
+ */
+export declare function createPinoCensor(config: unknown): (s: string) => string;

package/dist/createPinoCensor.js

@@ -0,0 +1,53 @@
+import { CensoredString } from "./CensoredString.js";
+import { CensoredURL } from "./CensoredURL.js";
+/**
+ * Raw values shorter than this are not censored, to avoid masking unrelated
+ * substrings throughout the log output.
+ */
+const MIN_SECRET_LENGTH = 4;
+function escapeRegExp(value) {
+    return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+function collectSecrets(value, out) {
+    if (value == null) {
+        return;
+    }
+    if (value instanceof CensoredString || value instanceof CensoredURL) {
+        const raw = value.value;
+        if (raw.length >= MIN_SECRET_LENGTH) {
+            out.set(raw, value.toString());
+        }
+        return;
+    }
+    if (typeof value !== "object") {
+        return;
+    }
+    if (Array.isArray(value)) {
+        for (const item of value) {
+            collectSecrets(item, out);
+        }
+        return;
+    }
+    for (const item of Object.values(value)) {
+        collectSecrets(item, out);
+    }
+}
+/**
+ * Gathers known secrets from a config and returns a function that replaces each raw secret with its masked representation.
+ * Intended for pino's `hooks.streamWrite`
+ */
+export function createPinoCensor(config) {
+    const map = new Map();
+    collectSecrets(config, map);
+    if (map.size === 0) {
+        return s => s;
+    }
+    // Longer secrets first so a secret that is a substring of another does not
+    // shadow the longer match.
+    const pattern = [...map.keys()]
+        .sort((a, b) => b.length - a.length)
+        .map(escapeRegExp)
+        .join("|");
+    const re = new RegExp(pattern, "g");
+    return s => s.replace(re, m => map.get(m) ?? m);
+}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./CensoredString.js";
 export * from "./CensoredURL.js";
 export * from "./compressedConfig.js";
+export * from "./createPinoCensor.js";
 export * from "./fetchRetry.js";
 export * from "./getFirstHttpTransportOptions.js";
 export * from "./getProviders.js";

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from "./CensoredString.js";
 export * from "./CensoredURL.js";
 export * from "./compressedConfig.js";
+export * from "./createPinoCensor.js";
 export * from "./fetchRetry.js";
 export * from "./getFirstHttpTransportOptions.js";
 export * from "./getProviders.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gearbox-protocol/cli-utils",
   "description": "Utils for creating cli apps",
-  "version": "6.14.0",
+  "version": "6.15.0",
   "homepage": "https://gearbox.fi",
   "keywords": [
     "gearbox"