Skip to main content
Dotset CLI API Documentation / index / Redactor

Class: Redactor

Defined in: src/mantle/redaction/redactor.ts:150 Redactor class for detecting and handling secrets in output streams.

Constructors

Constructor

new Redactor(options): Redactor;
Defined in: src/mantle/redaction/redactor.ts:203

Parameters

options
RedactorOptions = {}

Returns

Redactor

Methods

addAllowlist()

addAllowlist(entries): void;
Defined in: src/mantle/redaction/redactor.ts:397 Add allowlist entries (supports glob, regex, and literal patterns)

Parameters

entries
AllowlistEntry[]

Returns

void

addBlockedStrings()

addBlockedStrings(strings): void;
Defined in: src/mantle/redaction/redactor.ts:386

Parameters

strings
string[]

Returns

void

addExcludeKeywords()

addExcludeKeywords(keywords): void;
Defined in: src/mantle/redaction/redactor.ts:426 Add keywords to exclude from contextual detection

Parameters

keywords
string[]

Returns

void

addPattern()

addPattern(
   name, 
   pattern, 
   flags, 
   severity): boolean;
Defined in: src/mantle/redaction/redactor.ts:336

Parameters

name
string
pattern
string
flags
string = 'gi'
severity
"low" | "medium" | "high" | "critical"

Returns

boolean

addSensitiveKeywords()

addSensitiveKeywords(keywords): void;
Defined in: src/mantle/redaction/redactor.ts:417 Add custom sensitive keywords

Parameters

keywords
string[]

Returns

void

clearPatterns()

clearPatterns(): void;
Defined in: src/mantle/redaction/redactor.ts:303

Returns

void

flush()

flush(): Buffer<ArrayBufferLike> | null;
Defined in: src/mantle/redaction/redactor.ts:949

Returns

Buffer<ArrayBufferLike> | null

getExcludeKeywords()

getExcludeKeywords(): string[];
Defined in: src/mantle/redaction/redactor.ts:1084 Get exclude keywords

Returns

string[]

getExposureCount()

getExposureCount(): number;
Defined in: src/mantle/redaction/redactor.ts:1034

Returns

number

getMinConfidence()

getMinConfidence(): number;
Defined in: src/mantle/redaction/redactor.ts:1063 Get the minimum confidence threshold

Returns

number

getMode()

getMode(): ProtectionMode;
Defined in: src/mantle/redaction/redactor.ts:307

Returns

getPatternCount()

getPatternCount(): number;
Defined in: src/mantle/redaction/redactor.ts:1038

Returns

number

getPatternErrors()

getPatternErrors(): readonly PatternCompilationError[];
Defined in: src/mantle/redaction/redactor.ts:378

Returns

readonly PatternCompilationError[]

getSensitiveKeywords()

getSensitiveKeywords(): string[];
Defined in: src/mantle/redaction/redactor.ts:1077 Get sensitive keywords

Returns

string[]

getTrackedSecretCount()

getTrackedSecretCount(): number;
Defined in: src/mantle/redaction/redactor.ts:1042

Returns

number

hasPatternErrors()

hasPatternErrors(): boolean;
Defined in: src/mantle/redaction/redactor.ts:382

Returns

boolean

isContextualEnabled()

isContextualEnabled(): boolean;
Defined in: src/mantle/redaction/redactor.ts:1056 Check if contextual detection is enabled

Returns

boolean

isEntropyEnabled()

isEntropyEnabled(): boolean;
Defined in: src/mantle/redaction/redactor.ts:1049 Check if entropy detection is enabled

Returns

boolean

scan()

scan(text): SecretMatch[];
Defined in: src/mantle/redaction/redactor.ts:548 Performs a comprehensive scan of the provided text

Parameters

text
string

Returns

SecretMatch[]

setMinConfidence()

setMinConfidence(threshold): void;
Defined in: src/mantle/redaction/redactor.ts:1070 Set minimum confidence threshold

Parameters

threshold
number

Returns

void

setMode()

setMode(mode): void;
Defined in: src/mantle/redaction/redactor.ts:311

Parameters

mode

Returns

void

trackSecret()

trackSecret(name, value): void;
Defined in: src/mantle/redaction/redactor.ts:315

Parameters

name
string
value
string

Returns

void

trackSecrets()

trackSecrets(secrets): void;
Defined in: src/mantle/redaction/redactor.ts:330

Parameters

secrets
Record<string, string>

Returns

void

transform()

transform(data): Buffer<ArrayBufferLike> | null;
Defined in: src/mantle/redaction/redactor.ts:930

Parameters

data
string | Buffer<ArrayBufferLike>

Returns

Buffer<ArrayBufferLike> | null