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

mamori

package module

Go to main page

Versions in this module

v1

v1.3.0

Jul 27, 2026

v1.2.4

Jul 26, 2026

v1.2.3

Jul 26, 2026

v1.2.0

Jul 26, 2026

Changes in this version

+ var ErrForbidden = errors.New("mamori: forbidden")

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

+ var ErrNoSuchSnapshot = errors.New("mamori: no such snapshot version")

+ var ErrPermissionDenied = errors.New("mamori: permission denied")

+ var ErrRateLimited = errors.New("mamori: rate limited")

+ var ErrUnauthenticated = errors.New("mamori: unauthenticated")

+ var ErrUnavailable = errors.New("mamori: unavailable")

+ func ContextWithPeerCred(ctx context.Context, cred Ucred) context.Context

+ func Handler[T any](w *Watcher[T], opts ...HandlerOption) http.Handler

+ func SentinelFor(k Kind) error

+ func WatchRef(ctx context.Context, p Provider, ref Ref, opts ...Option) <-chan Update

+ type AuthFunc func(r *http.Request) (Identity, error)

+ func (f AuthFunc) Authenticate(r *http.Request) (Identity, error)

+ type Authenticator interface

+ Authenticate func(r *http.Request) (Identity, error)

+ func APIKey(header string, key secret.String) Authenticator

+ func APIKeyFunc(header string, fn func() secret.String) Authenticator

+ func AllOf(as ...Authenticator) Authenticator

+ func AnyOf(as ...Authenticator) Authenticator

+ func BasicAuth(user string, pass secret.String) Authenticator

+ func BasicAuthFunc(fn func() (string, secret.String)) Authenticator

+ func BearerToken(token secret.String) Authenticator

+ func BearerTokenFunc(fn func() secret.String) Authenticator

+ func MTLS(opts MTLSOptions) Authenticator

+ func PeerCred(opts PeerCredOptions) Authenticator

+ type Challenger interface

+ Challenge func() string

+ type FieldStatus struct

+ Age time.Duration

+ LastError string

+ LastKind Kind

+ LastOK time.Time

+ Path string

+ Ref string

+ Scheme string

+ Sensitive bool

+ Stale bool

+ Version string

+ type HandlerOption func(*handlerOptions)

+ func HandlerMiddleware(mw func(http.Handler) http.Handler) HandlerOption

+ func HandlerPrefix(prefix string) HandlerOption

+ func WithAuth(a Authenticator) HandlerOption

+ type HealthError struct

+ Fields []FieldStatus

+ func (e *HealthError) Error() string

+ type Identity struct

+ Attrs map[string][]string

+ Subject string

+ type Kind string

+ const KindInvalid

+ const KindNotFound

+ const KindPermissionDenied

+ const KindRateLimited

+ const KindUnauthenticated

+ const KindUnavailable

+ const KindUnknown

+ func ErrorKind(err error) Kind

+ type MTLSOptions struct

+ AllowedCNs []string

+ AllowedDNSNames []string

type Option

+ func WithAdminHTTP(addr string, opts ...HandlerOption) Option

+ func WithAdminTLS(cfg *tls.Config) Option

+ func WithHistory(n int) Option

+ type PeerCredOptions struct

+ GIDs []int

+ UIDs []int

type Ref

+ func ParseRefs(tag string) ([]Ref, error)

+ type Report struct

+ Fields []FieldStatus

+ GeneratedAt time.Time

+ Healthy bool

+ Live uint64

+ Pinned bool

+ Snapshot uint64

+ func Doctor[T any](ctx context.Context, opts ...Option) (Report, error)

+ type Snapshot struct

+ At time.Time

+ Config T

+ Fields []FieldChange

+ Version uint64

+ type Ucred struct

+ GID int

+ PID int

+ UID int

+ func PeerCredFromConn(conn net.Conn) (Ucred, error)

+ func PeerCredFromConn(net.Conn) (Ucred, error)

type Watcher

+ func (w *Watcher[T]) AdminAddr() net.Addr

+ func (w *Watcher[T]) Health() error

+ func (w *Watcher[T]) History() []Snapshot[T]

+ func (w *Watcher[T]) Pin(version uint64) error

+ func (w *Watcher[T]) PinCurrent() uint64

+ func (w *Watcher[T]) Pinned() (uint64, bool)

+ func (w *Watcher[T]) Status() Report

+ func (w *Watcher[T]) Unpin()

v1.1.8

Jul 26, 2026

v1.1.7

Jul 20, 2026

v1.1.6

Jul 20, 2026

v1.1.5

Jul 19, 2026

v1.1.4

Jul 19, 2026

v1.1.3

Jul 19, 2026

v1.1.2

Jul 19, 2026

v1.1.1

Jul 19, 2026

v1.1.0

Jul 19, 2026

Changes in this version

type Option

+ func WithDecodeHook(h mapstructure.DecodeHookFunc) Option

v1.0.0

Jul 19, 2026

Changes in this version

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

+ func Load[T any](ctx context.Context, opts ...Option) (T, error)

+ func Register(p Provider)

+ func RegisteredSchemes() []string

+ func SelectKey(data []byte, key string) ([]byte, error)

+ func VersionHash(b []byte) string

+ type BatchProvider interface

+ ResolveBatch func(ctx context.Context, refs []Ref) (map[string]Value, error)

+ type Change struct

+ Fields []FieldChange

+ New T

+ Old T

+ func (c Change[T]) Changed(path string) bool

+ type Clock interface

+ After func(d time.Duration) <-chan time.Time

+ NewTicker func(d time.Duration) *Ticker

+ NewTimer func(d time.Duration) *Timer

+ Now func() time.Time

+ func SystemClock() Clock

+ type FakeClock struct

+ func NewFakeClock(start time.Time) *FakeClock

+ func (c *FakeClock) Advance(d time.Duration)

+ func (c *FakeClock) After(d time.Duration) <-chan time.Time

+ func (c *FakeClock) NewTicker(d time.Duration) *Ticker

+ func (c *FakeClock) NewTimer(d time.Duration) *Timer

+ func (c *FakeClock) Now() time.Time

+ type FieldChange struct

+ NewVersion string

+ OldVersion string

+ Path string

+ type Meter interface

+ RecordRefresh func(scheme string)

+ RecordResolve func(scheme string, dur time.Duration, err error)

+ RecordWatchError func(scheme string)

+ type Option func(*options)

+ func OnChange[T any](fn func(Change[T])) Option

+ func OnError(fn func(error)) Option

+ func WithBackoff(base, max time.Duration) Option

+ func WithClock(c Clock) Option

+ func WithDebounce(d time.Duration) Option

+ func WithExecProvider() Option

+ func WithJitter(f float64) Option

+ func WithMeter(m Meter) Option

+ func WithPollInterval(d time.Duration) Option

+ func WithProvider(p Provider) Option

+ func WithQueueDepth(n int) Option

+ func WithStale(maxAge time.Duration) Option

+ func WithTracer(t Tracer) Option

+ func WithValidator(v Validator) Option

+ type Provider interface

+ Resolve func(ctx context.Context, ref Ref) (Value, error)

+ Scheme func() string

+ type ProviderError struct

+ Err error

+ Ref string

+ Scheme string

+ func (e *ProviderError) Error() string

+ func (e *ProviderError) Unwrap() error

+ type Ref struct

+ Key string

+ Opts url.Values

+ Path string

+ Raw string

+ Scheme string

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

+ func (r Ref) Opt(name string) string

+ func (r Ref) String() string

+ type StaleError struct

+ Err error

+ Ref string

+ func (e *StaleError) Error() string

+ func (e *StaleError) Unwrap() error

+ type Ticker struct

+ C <-chan time.Time

+ func (t *Ticker) Stop()

+ type Timer struct

+ C <-chan time.Time

+ func (t *Timer) Stop() bool

+ type Tracer interface

+ StartResolve func(ctx context.Context, scheme, ref string) (context.Context, func(err error))

+ type Update struct

+ Err error

+ Value Value

+ type ValidationError struct

+ Err error

+ func (e *ValidationError) Error() string

+ func (e *ValidationError) Unwrap() error

+ type Validator interface

+ Validate func(v any) error

+ type Value struct

+ Bytes []byte

+ Metadata map[string]string

+ NotAfter time.Time

+ Sensitive bool

+ Version string

+ type WatchableProvider interface

+ Watch func(ctx context.Context, ref Ref) (<-chan Update, error)

+ type Watcher struct

+ func Watch[T any](ctx context.Context, opts ...Option) (*Watcher[T], error)

+ func (w *Watcher[T]) Close() error

+ func (w *Watcher[T]) Get() T