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
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

sensitive

package module

Go to main page

Versions in this module

v0

v0.6.0

Feb 18, 2025

Changes in this version

+ var ErrFailedToMaskCopy = errors.New("failed to mask copy")

+ type Masked struct

+ func MaskedCopy[T any](v T, opts ...func(*MaskedCopyConfig)) *Masked[T]

+ func NewMaskedCopy[T any](v T, opts ...func(*MaskedCopyConfig)) (*Masked[T], error)

+ func (r Masked[T]) LogValue() slog.Value

+ func (r Masked[T]) MarshalJSON() ([]byte, error)

+ func (r Masked[T]) Reveal() T

+ func (r Masked[T]) String() string

+ func (r Masked[T]) Value() T

+ type MaskedCopyConfig struct

+ DeepCopy bool

type TagPayload

+ func (p TagPayload) String() string

v0.5.0

Oct 2, 2024

Changes in this version

+ var ErrInvalidTagConfiguration = errors.New("invalid 'sensitive' tag configuration")

+ var ErrMultipleNestedSubjectID = errors.New("potential multiple nested subject IDs")

+ var ErrRedactFuncNotFound = errors.New("redact function not found")

+ var ErrSubjectIDNotFound = errors.New("subject ID is not found")

+ var ErrUnsupportedFieldType = errors.New("'sensitive' field type must be convertible to string")

+ var ErrUnsupportedType = errors.New("unsupported 'sensitive' type")

+ func Check(v any) (found bool, err error)

+ func Mask(structPtr any, opts ...func(*RedactConfig)) error

+ func Redact(structPtr any, opts ...func(*RedactConfig)) error

+ func RedactDefaultFunc(_ FieldReplace, val string) (string, error)

+ func WithRegisteredMasks(rc *RedactConfig)

+ type FieldReplace struct

+ Kind string

+ Name string

+ Options TagOptions

+ RType reflect.Type

+ SubjectID string

+ type RedactConfig struct

+ RedactFunc ReplaceFunc

+ RequireSubjectID bool

+ type ReplaceFunc func(fr FieldReplace, val string) (string, error)

+ type Struct interface

+ HasSensitive func() bool

+ Replace func(fn ReplaceFunc) error

+ SubjectID func() string

+ func Scan(v any, requireSubject bool) (accessor Struct, err error)

+ type TagOptions map[string]string

+ func (m TagOptions) Get(name string) string

+ type TagPayload struct

+ ID string

+ Name string

+ Options TagOptions

+ func FieldTag(v any, field string) (*TagPayload, error)

+ func MustFieldTag(v any, field string) TagPayload

+ func ParseTag(rt reflect.StructTag) *TagPayload

+ func (p TagPayload) Marshal() string