redact

Documentation

Index

• func Bytes(b []byte) ([]byte, error)
• func ForceInitError(forcedErr error) (cleanup func())
• func SanitizeURL(rawURL string) string
• func String(s string) (string, error)

Functions

func Bytes

func Bytes(b []byte) ([]byte, error)

Bytes is a convenience wrapper over String. It returns the original slice on the no-op path.

func ForceInitError

func ForceInitError(forcedErr error) (cleanup func())

ForceInitError makes subsequent String and Bytes calls fail until the returned cleanup function restores the default detector factory.

func SanitizeURL

func SanitizeURL(rawURL string) string

SanitizeURL strips embedded credentials (userinfo), query strings, and fragments from a URL while preserving the scheme, host, and path for identity matching. Non-URL strings and SSH-style URLs pass through unchanged.

func String

func String(s string) (string, error)

String redacts detected secrets in s and returns the original string when no findings are present.