Merge pull request #1312 from siddharthsambharia-portkey/feat/regex-replace-guardrail

feat/regex-replace-guardrail

Author: VisargD

plugins/default/regexReplace.ts

@@ -0,0 +1,92 @@
+import {
+  HookEventType,
+  PluginContext,
+  PluginHandler,
+  PluginParameters,
+} from '../types';
+import { getCurrentContentPart, setCurrentContentPart } from '../utils';
+
+export const handler: PluginHandler = async (
+  context: PluginContext,
+  parameters: PluginParameters,
+  eventType: HookEventType
+) => {
+  let error = null;
+  let verdict = true;
+  let data: any = null;
+  const transformedData: Record<string, any> = {
+    request: {
+      json: null,
+    },
+    response: {
+      json: null,
+    },
+  };
+  let transformed = false;
+
+  try {
+    const regexPattern = parameters.rule;
+    const redactText = parameters.redactText || '[REDACTED]';
+    const failOnDetection = parameters.failOnDetection || false;
+
+    const { content, textArray } = getCurrentContentPart(context, eventType);
+
+    if (!regexPattern) {
+      throw new Error('Missing regex pattern');
+    }
+    if (!content) {
+      throw new Error('Missing text to match');
+    }
+
+    const regex = new RegExp(regexPattern, 'g');
+
+    // Process all text items in the array
+    let hasMatches = false;
+    const mappedTextArray: Array<string | null> = [];
+    textArray.forEach((text) => {
+      if (!text) {
+        mappedTextArray.push(null);
+        return;
+      }
+
+      // Reset regex for each text when using global flag
+      regex.lastIndex = 0;
+
+      const matches = text.match(regex);
+      if (matches && matches.length > 0) {
+        hasMatches = true;
+      }
+      const replacedText = text.replace(regex, redactText);
+      mappedTextArray.push(replacedText);
+    });
+
+    // Handle transformation
+    if (hasMatches) {
+      setCurrentContentPart(
+        context,
+        eventType,
+        transformedData,
+        mappedTextArray
+      );
+      transformed = true;
+    }
+    if (failOnDetection && hasMatches) {
+      verdict = false;
+    }
+    data = {
+      regexPattern,
+      verdict,
+      explanation: transformed
+        ? `Pattern '${regexPattern}' matched and was replaced with '${redactText}'`
+        : `The regex pattern '${regexPattern}' did not match any text.`,
+    };
+  } catch (e: any) {
+    error = e;
+    data = {
+      explanation: `An error occurred while processing the regex: ${e.message}`,
+      regexPattern: parameters.rule,
+    };
+  }
+
+  return { error, verdict, data, transformedData, transformed };
+};

plugins/index.ts

@@ -50,6 +50,7 @@ import { handler as panwPrismaAirsintercept } from './panw-prisma-airs/intercept
 import { handler as defaultjwt } from './default/jwt';
 import { handler as defaultrequiredMetadataKeys } from './default/requiredMetadataKeys';
 import { handler as walledaiguardrails } from './walledai/guardrails';
+import { handler as defaultregexReplace } from './default/regexReplace';
 
 export const plugins = {
   default: {
@@ -70,6 +71,7 @@ export const plugins = {
     modelWhitelist: defaultmodelWhitelist,
     jwt: defaultjwt,
     requiredMetadataKeys: defaultrequiredMetadataKeys,
+    regexReplace: defaultregexReplace,
   },
   portkey: {
     moderateContent: portkeymoderateContent,