redact

Documentation

Overview

Package redact provides product-neutral helpers for removing secret-like values from strings and JSON/YAML-like documents.

Index

• Constants
• func Any(value any, opts ...Options) any
• func Document(value any, opts ...Options) (any, bool)
• func Map(in map[string]any, opts ...Options) map[string]any
• func SensitiveKey(key string, opts ...Options) bool
• func String(value string, opts ...Options) string
• type Options

Constants

const (
	// Value is the default marker used in place of redacted content.
	Value = "${redacted}"
)

Functions

func Any

func Any(value any, opts ...Options) any

Any redacts secret-like values from common JSON/YAML-like values.

func Document

func Document(value any, opts ...Options) (any, bool)

Document redacts value and reports whether any replacement was made.

func Map

func Map(in map[string]any, opts ...Options) map[string]any

Map redacts a map[string]any document.

func SensitiveKey

func SensitiveKey(key string, opts ...Options) bool

SensitiveKey reports whether a key name usually carries a secret value.

func String

func String(value string, opts ...Options) string

String redacts secret-like values from value.

Types

type Options

type Options struct {
	Marker             string
	ExtraSensitiveKeys []string
	// ExactSensitiveKeys adds case-insensitive whole-key matches. Common key
	// separators are normalized, so raw-capture and raw_capture are equivalent.
	// Use this for domain-specific keys whose names are unsafe only as complete
	// fields; ExtraSensitiveKeys intentionally retains substring matching.
	ExactSensitiveKeys []string
	ExtraPatterns      []*regexp.Regexp
}

Options configures redaction behavior for one call.