mask

Documentation

Overview

Package mask hides sensitive values, for logs and other output.

Index

• func Full[S ~string](S) S
• func Hash[S ~string](s S) S
• func LogValue(v any) slog.Value
• func Map[T interface{ ... }](m map[string]T) map[string]T
• func Partial[S ~string](s S, prefix, suffix int) S
• func Regex[S ~string](s S, re *regexp.Regexp) S
• func Slice[T interface{ ... }](s []T) []T
• func Zero[T any](T) T

Functions

func Full

func Full[S ~string](S) S

Full replaces s with a mask of fixed length.

func Hash

func Hash[S ~string](s S) S

Hash replaces s with the start of its SHA-256 in hex, so equal values stay equal in logs.

func LogValue

func LogValue(v any) slog.Value

LogValue gives slog the JSON of v: an object is a group with its keys in order, an array a list, anything else its value. A value without JSON gives the error text.

func Map

func Map[T interface{ Masked() T }](m map[string]T) map[string]T

Map returns a copy of m with each value masked.

func Partial

func Partial[S ~string](s S, prefix, suffix int) S

Partial keeps prefix characters at the start of s and suffix at the end, and masks the rest. A value too short to hide anything is masked in full.

func Regex

func Regex[S ~string](s S, re *regexp.Regexp) S

Regex replaces each character of the parts of s that re matches with *.

func Slice

func Slice[T interface{ Masked() T }](s []T) []T

Slice returns a copy of s with each item masked.

func Zero

func Zero[T any](T) T

Zero returns the zero value of the type of v, for a sensitive value that is no string.