Help us shape the future of Go! Take the 2026 Go Developer Survey

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

secrets

package

Go to main page

Versions in this module

v1

v1.6.5

Oct 8, 2026

Changes in this version

+ var CredentialKeys = []string

+ func ContainsRef(s string) bool

+ func HasRef(v any) bool

+ func IsRef(s string) bool

+ func Kinds() []string

+ func Register(kind string, f Factory, aliases ...string)

+ type Config map[string]ProviderConfig

+ func ParseConfig(raw map[string]map[string]any) (Config, error)

+ func (c Config) Merge(other Config) Config

+ type Factory func(cfg ProviderConfig) (Provider, error)

+ type Options struct

+ BaseDir string

+ CacheTTL time.Duration

+ Config Config

+ IsSecret func(path []string) bool

+ KeyAliases map[string]string

+ OnValue func(v string)

+ Timeout time.Duration

+ type Provider interface

+ Get func(ctx context.Context, ref Ref) ([]byte, error)

+ type ProviderConfig struct

+ Kind string

+ Name string

+ Props map[string]any

+ func (c ProviderConfig) BaseDir() string

+ func (c ProviderConfig) Bool(key string, envKeys ...string) bool

+ func (c ProviderConfig) Decode(out any) error

+ func (c ProviderConfig) Get(key string, envKeys ...string) string

+ func (c ProviderConfig) Redact(s string) string

+ type Ref struct

+ Kind string

+ Params url.Values

+ Path string

+ Pointer string

+ Provider string

+ Raw string

+ Trim bool

+ func ParseRef(s string) (Ref, error)

+ func Refs(v any) (refs []Ref)

+ func (r Ref) Key() string

+ func (r Ref) Select(raw []byte) (any, error)

+ func (r Ref) String() string

+ type ResolveError struct

+ Err error

+ Kind string

+ Provider string

+ Ref string

+ func (e *ResolveError) Error() string

+ func (e *ResolveError) Unwrap() error

+ type Resolver struct

+ func NewResolver(opts Options) *Resolver

+ func (r *Resolver) Close() error

+ func (r *Resolver) Redact(s string) string

+ func (r *Resolver) Resolve(ctx context.Context, s string) (any, error)

+ func (r *Resolver) ResolveEntry(ctx context.Context, props map[string]any) (map[string]any, error)

+ func (r *Resolver) ResolveValue(ctx context.Context, v any) (any, error)