MCP Server Framework - v1.0.0
    Preparing search index...

    Class SecretScrubber

    Secret Scrubber class for detecting and redacting sensitive information.

    Usage:

    • Create a scrubber: const scrubber = new SecretScrubber();
    • Scrub a string: scrubber.scrub('token=secret123') returns 'token=**********'
    • Scrub an object: scrubber.scrubObject({ password: 'secret' }) returns { password: '**********' }
    Index

    Constructors

    Methods

    • Check if a key is sensitive.

      Delegates to the shared utility for base sensitive keys (including blocklist logic). Additional keys provided at construction are checked separately — they bypass the blocklist since they are explicitly declared as sensitive by the consumer.

      Parameters

      • key: string

        The key to check

      Returns boolean

      true if the key matches a sensitive pattern

    • Scrub secrets from a text string.

      Handles:

      • JWTs (eyJ...)
      • Bearer tokens
      • Key-value pairs with sensitive keys

      Parameters

      • text: string

        The text to scrub

      Returns string

      The scrubbed text

    • Recursively scrub sensitive keys from an object.

      Also scrubs string values that may contain embedded secrets (e.g., "password=secret123" patterns).

      Parameters

      • obj: unknown

        The object to scrub

      Returns unknown

      A new object with sensitive values redacted