Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

mask

package module

Go to main page

Versions in this module

v0

v0.2.0

Aug 30, 2026

Changes in this version

type Pattern

+ func BuildkitePatterns() []Pattern

+ func BuildkiteToken() Pattern

+ func DynatracePatterns() []Pattern

+ func DynatraceToken() Pattern

+ func FlyIOAccessToken() Pattern

+ func FlyIOPatterns() []Pattern

+ func GroqAPIKey() Pattern

+ func GroqPatterns() []Pattern

+ func HCPTerraformAPIToken() Pattern

+ func NewRelicPatterns() []Pattern

+ func NewRelicUserKey() Pattern

+ func PaddleAPIKey() Pattern

+ func PaddlePatterns() []Pattern

+ func PostHogPatterns() []Pattern

+ func PostHogPersonalAPIKey() Pattern

+ func Regexp(name, expr string) (Pattern, error)

+ func ReplicateAPIToken() Pattern

+ func ReplicatePatterns() []Pattern

+ func ResendAPIKey() Pattern

+ func ResendPatterns() []Pattern

+ func SonarQubePatterns() []Pattern

+ func SonarQubeToken() Pattern

+ func XAIAPIKey() Pattern

+ func XAIPatterns() []Pattern

v0.1.0

Aug 29, 2026

Changes in this version

type Pattern

+ func AgePatterns() []Pattern

+ func AgeSecretKey() Pattern

+ func AirtablePatterns() []Pattern

+ func AirtablePersonalAccessToken() Pattern

+ func CircleCIAPIToken() Pattern

+ func CircleCIPatterns() []Pattern

+ func CratesIOPatterns() []Pattern

+ func CratesIOToken() Pattern

+ func DatabricksOAuthClientSecret() Pattern

+ func DatabricksPatterns() []Pattern

+ func DatabricksPersonalAccessToken() Pattern

+ func DigitalOceanPatterns() []Pattern

+ func DigitalOceanToken() Pattern

+ func DockerPatterns() []Pattern

+ func DockerPersonalAccessToken() Pattern

+ func DopplerAuthToken() Pattern

+ func DopplerPatterns() []Pattern

+ func HerokuAPIToken() Pattern

+ func HerokuPatterns() []Pattern

+ func HuggingFacePatterns() []Pattern

+ func HuggingFaceUserAccessToken() Pattern

+ func OnePasswordPatterns() []Pattern

+ func OnePasswordServiceAccountToken() Pattern

+ func PlanetScalePatterns() []Pattern

+ func PlanetScaleToken() Pattern

+ func PostmanAPIKey() Pattern

+ func PostmanPatterns() []Pattern

+ func PulumiAccessToken() Pattern

+ func PulumiPatterns() []Pattern

+ func ShopifyAccessToken() Pattern

+ func ShopifyAppSecretKey() Pattern

+ func ShopifyPatterns() []Pattern

+ func SourcegraphAccessToken() Pattern

+ func SourcegraphPatterns() []Pattern

+ func SupabasePublishableKey() Pattern

+ func SupabaseSecretKey() Pattern

v0.0.1

Aug 26, 2026

Changes in this version

+ const LookBehind

+ var ErrClosed = errors.New("mask: writer is closed")

+ type Masker struct

+ func New(opts ...Option) *Masker

+ func (m *Masker) Mask(src string) string

+ type Match struct

+ Pattern Pattern

+ Value string

+ type Option func(*options)

+ func WithPatterns(patterns ...Pattern) Option

+ func WithRedactor(r Redactor) Option

+ type Pattern interface

+ Find func(src string) (spans []Span, retain int)

+ Name func() string

+ func AWSAccessKeyID() Pattern

+ func AWSPatterns() []Pattern

+ func AWSSecretAccessKey() Pattern

+ func AllBuiltinPatterns() []Pattern

+ func AnthropicAPIKey() Pattern

+ func AnthropicPatterns() []Pattern

+ func CloudflareAPIKey() Pattern

+ func CloudflareAPIToken() Pattern

+ func CloudflarePatterns() []Pattern

+ func GitHubPatterns() []Pattern

+ func GitHubToken() Pattern

+ func GitLabPatterns() []Pattern

+ func GitLabToken() Pattern

+ func GoogleAPIKey() Pattern

+ func GooglePatterns() []Pattern

+ func GrafanaPatterns() []Pattern

+ func GrafanaServiceAccountToken() Pattern

+ func HashiCorpPatterns() []Pattern

+ func HashiCorpVaultToken() Pattern

+ func JWT() Pattern

+ func LinearAPIKey() Pattern

+ func LinearPatterns() []Pattern

+ func MustRegexp(name, expr string) Pattern

+ func NPMAccessToken() Pattern

+ func NPMPatterns() []Pattern

+ func NewPattern(name string, find func(src string) (spans []Span, retain int)) Pattern

+ func NotionAPIToken() Pattern

+ func NotionPatterns() []Pattern

+ func OpenAIAPIKey() Pattern

+ func OpenAIPatterns() []Pattern

+ func OpenRouterAPIKey() Pattern

+ func OpenRouterPatterns() []Pattern

+ func PrivateKey() Pattern

+ func PyPIAPIToken() Pattern

+ func PyPIPatterns() []Pattern

+ func RubyGemsAPIKey() Pattern

+ func RubyGemsPatterns() []Pattern

+ func SendGridAPIKey() Pattern

+ func SendGridPatterns() []Pattern

+ func SentryAuthToken() Pattern

+ func SentryPatterns() []Pattern

+ func SlackPatterns() []Pattern

+ func SlackToken() Pattern

+ func StripePatterns() []Pattern

+ func StripePublishableKey() Pattern

+ func StripeSecretKey() Pattern

+ func StripeWebhookSigningSecret() Pattern

+ func SupabaseAccessToken() Pattern

+ func SupabasePatterns() []Pattern

+ type Reader struct

+ func NewReader(src io.Reader, m *Masker, opts ...StreamOption) *Reader

+ func (r *Reader) Read(p []byte) (int, error)

+ type Redactor interface

+ Redact func(m Match) string

+ func Fill(r rune) Redactor

+ func Fixed(s string) Redactor

+ func NewRedactor(redact func(m Match) string) Redactor

+ type Span struct

+ End int

+ Start int

+ type StreamOption func(*streamOptions)

+ func WithMaxRetained(n int) StreamOption

+ type Writer struct

+ func NewWriter(dst io.Writer, m *Masker, opts ...StreamOption) *Writer

+ func (w *Writer) Close() error

+ func (w *Writer) Write(p []byte) (int, error)