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

settings

package module

Go to main page

Versions in this module

v0

v0.2.0

Oct 23, 2026

Changes in this version

+ const MaxLeftovers

+ const MaxRefIDLen

+ const MaxRefTypeLen

+ const MaxValueLen

+ var ErrConflict = errors.New("settings: conflict")

+ var ErrInvalid = errors.New("settings: invalid input")

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

+ var ErrReencryptIncomplete = errors.New("settings: re-encryption incomplete")

type AESGCM

+ func (a *AESGCM) KeyID(ciphertext []byte) (string, bool)

+ type CallerConnReporter interface

+ UsesCallerConn func(ctx context.Context) bool

type Client

+ func (c *Client) Reencrypt(ctx context.Context) (ReencryptResult, error)

type Key

+ func (k Key[T]) Format(f fmt.State, verb rune)

+ func (k Key[T]) LogValue() slog.Value

+ func (k Key[T]) MarshalJSON() ([]byte, error)

+ type KeyIdentifier interface

+ CurrentKeyID func() string

+ KeyID func(ciphertext []byte) (string, bool)

+ type Leftover struct

+ Err error

+ Key string

+ Scope Scope

type Options

+ ActorFrom func(ctx context.Context) (Ref, bool)

+ type ReencryptResult struct

+ Leftovers []Leftover

+ Remaining int

+ Rewritten int

+ Unchecked int

+ func (r ReencryptResult) Complete() bool

+ type Ref struct

+ ID string

+ Type string

+ func (r Ref) IsZero() bool

+ func (r Ref) String() string

type Resolved

+ func (r Resolved[T]) Format(f fmt.State, verb rune)

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

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

type Store

+ Scan func(ctx context.Context, afterKey string, afterScope Scope, limit int) ([]Record, error)

+ Swap func(ctx context.Context, key string, scope Scope, old, value json.RawMessage) (bool, error)

v0.1.0

Oct 23, 2026

Changes in this version

+ const DefaultCacheSize

+ const DefaultCacheTTL

+ const MaxKeyNameLen

+ const MaxScopeIDLen

+ const MaxScopeTypeLen

+ const Redacted

+ const ScopeGlobal

+ const ScopeTenant

+ const ScopeUser

+ var ErrDecrypt = errors.New("settings: decrypt failed")

+ var ErrDuplicateKey = errors.New("settings: duplicate key")

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

+ var ErrInvalidRecord = errors.New("settings: invalid record")

+ var ErrInvalidScope = errors.New("settings: invalid scope")

+ var ErrInvalidValue = errors.New("settings: invalid value")

+ var ErrNoEncrypter = errors.New("settings: secret key requires an encrypter")

+ var ErrTypeMismatch = errors.New("settings: type mismatch")

+ var ErrUnknownKey = errors.New("settings: unknown key")

+ func ActorFrom(ctx context.Context) (string, bool)

+ func DefaultOrder() []string

+ func Get[T any](ctx context.Context, c *Client, k Key[T], scopes ...Scope) (T, error)

+ func Set[T any](ctx context.Context, c *Client, k Key[T], scope Scope, v T) error

+ func ValidateKeyName(name string) error

+ func WithActor(ctx context.Context, actor string) context.Context

+ type AESGCM struct

+ func NewAESGCM(currentKeyID string, keys map[string][]byte) (*AESGCM, error)

+ func (a *AESGCM) CurrentKeyID() string

+ func (a *AESGCM) Decrypt(_ context.Context, ciphertext, associatedData []byte) ([]byte, error)

+ func (a *AESGCM) Encrypt(_ context.Context, plaintext, associatedData []byte) ([]byte, error)

+ type AllOption func(*allOptions)

+ func RevealSecrets() AllOption

+ type AnyKey interface

+ type Change struct

+ Actor string

+ At time.Time

+ Key string

+ New json.RawMessage

+ Old json.RawMessage

+ Scope Scope

+ Secret bool

+ type Client struct

+ func New(store Store, registry *Registry, opts Options) (*Client, error)

+ func (c *Client) All(ctx context.Context, scope Scope, opts ...AllOption) ([]Entry, error)

+ func (c *Client) Close()

+ func (c *Client) SetJSON(ctx context.Context, name string, scope Scope, value json.RawMessage) error

+ func (c *Client) Unset(ctx context.Context, name string, scope Scope) error

+ type Encrypter interface

+ Decrypt func(ctx context.Context, ciphertext, associatedData []byte) ([]byte, error)

+ Encrypt func(ctx context.Context, plaintext, associatedData []byte) ([]byte, error)

+ type Entry struct

+ Overridden bool

+ UpdatedAt time.Time

+ UpdatedBy string

+ Value json.RawMessage

+ type Invalidation struct

+ All bool

+ Key string

+ Scope Scope

+ type InvalidationSource interface

+ Subscribe func(fn func(Invalidation)) (unsubscribe func())

+ type Key struct

+ Default T

+ Description string

+ Name string

+ Secret bool

+ Validate func(T) error

+ type KeyInfo struct

+ Default json.RawMessage

+ Description string

+ Name string

+ Secret bool

+ Type string

+ type Options struct

+ CacheSize int

+ CacheTTL time.Duration

+ Encrypter Encrypter

+ Invalidations InvalidationSource

+ Now func() time.Time

+ OnChange func(ctx context.Context, c Change) error

+ Order []string

+ type Record struct

+ Key string

+ Scope Scope

+ UpdatedAt time.Time

+ UpdatedBy string

+ Value json.RawMessage

+ func (r Record) Validate() error

+ type Registry struct

+ func NewRegistry(keys ...AnyKey) (*Registry, error)

+ func (r *Registry) Keys() []KeyInfo

+ func (r *Registry) Lookup(name string) (KeyInfo, bool)

+ func (r *Registry) MustRegister(keys ...AnyKey)

+ func (r *Registry) Register(keys ...AnyKey) error

+ type Resolved struct

+ Default bool

+ Scope Scope

+ UpdatedAt time.Time

+ UpdatedBy string

+ Value T

+ func Resolve[T any](ctx context.Context, c *Client, k Key[T], scopes ...Scope) (Resolved[T], error)

+ type Scope struct

+ ID string

+ Type string

+ func Global() Scope

+ func Tenant(id string) Scope

+ func User(id string) Scope

+ func (s Scope) IsGlobal() bool

+ func (s Scope) String() string

+ func (s Scope) Validate() error

+ type Store interface

+ Delete func(ctx context.Context, key string, scope Scope) (*Record, error)

+ Get func(ctx context.Context, key string, scopes []Scope) ([]Record, error)

+ List func(ctx context.Context, scope Scope) ([]Record, error)

+ Put func(ctx context.Context, rec Record) (*Record, error)