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

secret

package

Go to main page

Versions in this module

v2

v2.2.1

Apr 24, 2026

v2.2.0

Apr 23, 2026

v2.1.2

Apr 23, 2026

v2.1.1

Apr 21, 2026

v2.1.0

Apr 20, 2026

v2.0.0

Apr 20, 2026

Changes in this version

+ var ErrAlreadyStarted = errors.New("rotating provider already started")

+ var ErrInvalidKey = errors.New("invalid secret key")

+ var ErrNotFound = errors.New("secret not found")

+ type Client struct

+ func New() *Client

+ func NewWithConfig(cfg *Config) *Client

+ func (c *Client) Get(ctx context.Context, key string) (Secret, error)

+ type Config struct

+ Provider Provider

+ type EnvProvider struct

+ func NewEnvProvider() *EnvProvider

+ func (e *EnvProvider) Get(_ context.Context, key string) (Secret, error)

+ type FileProvider struct

+ func NewFileProvider(dir string) *FileProvider

+ func (f *FileProvider) Get(ctx context.Context, key string) (Secret, error)

+ type Provider interface

+ Get func(ctx context.Context, key string) (Secret, error)

+ type RotatingFileProvider struct

+ func NewRotatingFileProvider(dir, key string, interval time.Duration) *RotatingFileProvider

+ func (p *RotatingFileProvider) Get(ctx context.Context, key string) (Secret, error)

+ func (p *RotatingFileProvider) OnRotate() <-chan RotationEvent

+ func (p *RotatingFileProvider) Shutdown(ctx context.Context) error

+ func (p *RotatingFileProvider) Start(ctx context.Context) error

+ type RotatingProvider interface

+ OnRotate func() <-chan RotationEvent

+ Shutdown func(ctx context.Context) error

+ Start func(ctx context.Context) error

+ type RotationEvent struct

+ Err error

+ Key string

+ NewValue Secret

+ type Secret struct

+ func NewSecret(value string) Secret

+ func (s Secret) GoString() string

+ func (s Secret) LogValue() slog.Value

+ func (s Secret) MarshalJSON() ([]byte, error)

+ func (s Secret) MarshalText() ([]byte, error)

+ func (s Secret) String() string

+ func (s Secret) Value() string