/** Core types for the Shroud OpenClaw plugin. */
import type { RedactionLevel } from "./redaction.js";
/** Categories of sensitive information. */
export declare enum Category {
    PERSON_NAME = "person_name",
    EMAIL = "email",
    PHONE = "phone",
    IP_ADDRESS = "ip_address",
    API_KEY = "api_key",
    URL = "url",
    ORG_NAME = "org_name",
    LOCATION = "location",
    FILE_PATH = "file_path",
    CREDIT_CARD = "credit_card",
    SSN = "ssn",
    MAC_ADDRESS = "mac_address",
    HOSTNAME = "hostname",
    SNMP_COMMUNITY = "snmp_community",
    BGP_ASN = "bgp_asn",
    NETWORK_CREDENTIAL = "network_credential",
    VLAN_ID = "vlan_id",
    INTERFACE_DESC = "interface_desc",
    ROUTE_MAP = "route_map",
    OSPF_ID = "ospf_id",
    ACL_NAME = "acl_name",
    IBAN = "iban",
    NATIONAL_ID = "national_id",
    JWT = "jwt",
    ICS_IDENTIFIER = "ics_identifier",
    GPS_COORDINATE = "gps_coordinate",
    CERTIFICATE = "certificate",
    DATE_OF_BIRTH = "date_of_birth",
    MEDICAL_RECORD_NUMBER = "medical_record_number",
    BANK_ACCOUNT_NUMBER = "bank_account_number",
    TAX_ID = "tax_id",
    PASSPORT_NUMBER = "passport_number",
    DRIVERS_LICENSE = "drivers_license",
    CASE_NUMBER = "case_number",
    CRYPTOCURRENCY_ADDRESS = "cryptocurrency_address",
    AWS_ARN = "aws_arn",
    CUSTOM = "custom"
}
/** A detected sensitive entity in text. */
export interface DetectedEntity {
    value: string;
    start: number;
    end: number;
    category: Category;
    confidence: number;
    detector: string;
}
/** Result of obfuscating text. */
export interface ObfuscationResult {
    original: string;
    obfuscated: string;
    entities: DetectedEntity[];
    mappingsUsed: Record<string, string>;
    /** Filtering stats — how many entities were skipped and why. */
    filterStats?: FilterStats;
}
/** Breakdown of skipped/filtered entities during obfuscation. */
export interface FilterStats {
    /** Total entities detected before filtering. */
    totalDetected: number;
    /** Entities that passed filtering and were replaced (or would be in dryRun). */
    replaced: number;
    /** Entities skipped because confidence < minConfidence. */
    belowThreshold: number;
    /** Entities skipped by allowlist. */
    allowlisted: number;
    /** Entities skipped because they are doc/example values. */
    docExamples: number;
    /** Entities skipped because they are already-known fakes. */
    alreadyObfuscated: number;
    /** Entities skipped because their category is exempt (per-agent contract). */
    exempted: number;
}
/** Per-tool field rule: which fields to scan for obfuscation. */
export interface ToolFieldRule {
    scanFields: string[];
}
/** Configuration for per-tool and per-agent obfuscation scoping. */
export interface FieldScopingConfig {
    /** Per-tool field rules. Keys are tool name patterns (supports * and ? wildcards). */
    toolFields: Record<string, ToolFieldRule>;
    /** Fields that are NEVER scanned regardless of tool. */
    neverScanFields: string[];
    /** Default fields to scan for tools not matching any pattern. Empty = scan everything. */
    defaultScanFields: string[];
    /** When true, use agent contract allowedDataClasses to exempt categories from obfuscation. */
    useContractExemptions: boolean;
}
/** Result of resolving field scope for a tool. */
export interface ScopeDecision {
    /** "all" = scan every field; "selected" = only scan scanFields. */
    mode: "all" | "selected";
    /** Fields to scan (when mode is "selected"). */
    scanFields: Set<string>;
    /** Fields to never scan (always applied). */
    neverScanFields: Set<string>;
}
/** Configuration for the Shroud plugin. */
export interface ShroudConfig {
    secretKey: string;
    persistentSalt: string;
    minConfidence: number;
    allowlist: string[];
    denylist: string[];
    canaryEnabled: boolean;
    canaryPrefix: string;
    auditEnabled: boolean;
    logMappings: boolean;
    customPatterns: Array<{
        name: string;
        pattern: string;
        category?: string;
    }>;
    verboseLogging: boolean;
    auditLogFormat: "human" | "json";
    auditIncludeProofHashes: boolean;
    auditHashSalt: string;
    auditHashTruncate: number;
    auditMaxFakesSample: number;
    detectorOverrides: Record<string, {
        enabled?: boolean;
        confidence?: number;
    }>;
    /**
     * Detection rules as code. Each key is a rule name.
     * - Override built-in rules: change pattern, confidence, or category
     * - Disable rules: { "enabled": false }
     * - Add new rules: { "pattern": "regex string", "category": "email", "confidence": 0.9 }
     * Built-in rules from BUILTIN_PATTERNS are the defaults; this merges on top.
     */
    rules: Record<string, {
        enabled?: boolean;
        pattern?: string;
        category?: string;
        confidence?: number;
    }>;
    /** Tool chain depth awareness — max depth before warning. */
    maxToolDepth: number;
    /** Redaction levels — 'full' | 'masked' | 'stats'. */
    redactionLevel: RedactionLevel;
    /** Dry-run mode: detect entities but don't replace them. */
    dryRun: boolean;
    /** Max mapping store size; oldest entries evicted when exceeded. 0 = unlimited. */
    maxStoreMappings: number;
    /** Per-tool and per-agent obfuscation scoping. Undefined = scan everything (backward compatible). */
    fieldScoping?: FieldScopingConfig;
}