api

package module

Go to main page

Versions in this module

v0

v0.2.0

Nov 6, 2026

Changes in this version

+ var ErrUnsupported = errors.New("api: unsupported capability")

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

+ type Actor struct

+ ID string

+ Kind string

+ func ActorFromContext(ctx context.Context) (Actor, bool)

+ func (a Actor) Valid() bool

+ type AuditEvent struct

+ Action string

+ Actor Actor

+ ClientID string

+ CredentialID string

+ Details map[string]any

+ ID int64

+ OccurredAt time.Time

+ OperationID string

+ VersionID string

+ type AuditReader interface

+ AuditEvents func(ctx context.Context, before int64, limit int) ([]AuditEvent, error)

+ PruneAuditEvents func(ctx context.Context, before time.Time, limit int) (int64, error)

+ type AuditedOperationStore interface

+ IssueOnceAudited func(ctx context.Context, actor Actor, spec OperationSpec, credential Credential, ...) (OperationReceipt, bool, error)

+ RotateOnceAudited func(ctx context.Context, actor Actor, spec OperationSpec, id string, ...) (OperationReceipt, bool, error)

+ type AuditedRetirementStore interface

+ RetireVersionAudited func(ctx context.Context, actor Actor, credentialID, versionID string) error

+ type AuditedStore interface

+ CreateClientAudited func(ctx context.Context, actor Actor, client Client) error

+ IssueAudited func(ctx context.Context, actor Actor, credential Credential, version SecretVersion) error

+ RevokeAllAudited func(ctx context.Context, actor Actor, id string, at time.Time) error

+ RevokeAudited func(ctx context.Context, actor Actor, id string, at time.Time) error

+ RotateAudited func(ctx context.Context, actor Actor, id string, generation int64, ...) (Credential, error)

+ SetClientBannedAudited func(ctx context.Context, actor Actor, id string, banned bool) error

+ SetClientScopesAudited func(ctx context.Context, actor Actor, id string, scopes []string) error

+ type AuditedTimedStore interface

+ IssueWithLifetimeAudited func(ctx context.Context, actor Actor, credential Credential, version SecretVersion, ...) (Credential, SecretVersion, error)

+ RotateWithLifetimeAudited func(ctx context.Context, actor Actor, id string, generation int64, ...) (Credential, SecretVersion, error)

+ type AuthenticationDetails struct

+ ExpiresAt time.Time

+ Generation int64

+ NonExpiring bool

+ Principal Principal

+ SecretVersionID string

+ type CredentialDetails struct

+ ClientBanned bool

+ Credential Credential

+ CurrentVersion SecretVersionInfo

+ EffectiveScopes []string

+ LastUsedAt *time.Time

+ UnexpiredVersions int

type IssueRequest

+ NonExpiring bool

type Issued

+ NonExpiring bool

+ type ManagementStore interface

+ CredentialDetails func(ctx context.Context, id string) (CredentialDetails, error)

+ RetireVersion func(ctx context.Context, credentialID, versionID string) error

+ SecretVersions func(ctx context.Context, id string, before int64, limit int) ([]SecretVersionInfo, error)

+ type NonExpiringStore interface

+ SupportsNonExpiring func() bool

+ type OperationReceipt struct

+ CommittedAt time.Time

+ Credential Credential

+ Fingerprint [32]byte

+ ID string

+ Kind string

+ Version SecretVersionInfo

+ type OperationResult struct

+ Issued *Issued

+ Receipt OperationReceipt

+ type OperationSpec struct

+ Fingerprint [32]byte

+ ID string

+ type OperationStore interface

+ IssueOnce func(ctx context.Context, spec OperationSpec, credential Credential, ...) (OperationReceipt, bool, error)

+ Operation func(ctx context.Context, id string) (OperationReceipt, error)

+ RotateOnce func(ctx context.Context, spec OperationSpec, id string, generation int64, ...) (OperationReceipt, bool, error)

type Option

+ func WithAudit() Option

+ func WithNonExpiring() Option

+ func WithUsageTracking(cfg UsageConfig) Option

type RotateRequest

+ NonExpiring bool

type SecretVersion

+ NonExpiring bool

+ type SecretVersionInfo struct

+ CreatedAt time.Time

+ CredentialID string

+ ExpiresAt time.Time

+ Generation int64

+ ID string

+ LastUsedAt *time.Time

+ NonExpiring bool

type Service

+ func (s *Service) AuditEvents(ctx context.Context, before int64, limit int) ([]AuditEvent, error)

+ func (s *Service) AuthenticateDetails(ctx context.Context, token string, required ...string) (AuthenticationDetails, error)

+ func (s *Service) CredentialDetails(ctx context.Context, id string) (CredentialDetails, error)

+ func (s *Service) IssueOnce(ctx context.Context, id string, req IssueRequest) (OperationResult, error)

+ func (s *Service) Operation(ctx context.Context, id string) (OperationReceipt, error)

+ func (s *Service) PruneAuditEvents(ctx context.Context, before time.Time, limit int) (int64, error)

+ func (s *Service) RetireVersion(ctx context.Context, credentialID, versionID string) error

+ func (s *Service) RotateOnce(ctx context.Context, id string, req RotateRequest) (OperationResult, error)

+ func (s *Service) SecretVersions(ctx context.Context, id string, before int64, limit int) ([]SecretVersionInfo, error)

+ func (s *Service) UsageStats() UsageStats

+ type UsageConfig struct

+ BatchSize int

+ CloseTimeout time.Duration

+ FlushInterval time.Duration

+ FlushTimeout time.Duration

+ MaxPending int

+ type UsageObservation struct

+ At time.Time

+ ClientID string

+ CredentialID string

+ VersionID string

+ type UsageStats struct

+ Dropped uint64

+ LastFlushAt time.Time

+ Pending int

+ Started bool

+ type UsageStore interface

+ RecordUsage func(ctx context.Context, observations []UsageObservation) error

v0.1.3

Oct 26, 2026

v0.1.2

Oct 3, 2026

v0.1.1

Oct 2, 2026

v0.1.0

Sep 28, 2026

Changes in this version

+ var ErrClosed = errors.New("api: closed")

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

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

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

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

+ var ErrUnauthorized = errors.New("api: unauthorized")

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

+ type Cache interface

+ Close func() error

+ Invalidate func()

+ Lookup func(ctx context.Context, key string, change uint64) (ReadResult, error)

+ Start func(ctx context.Context) error

+ type CacheFactory func(Source) (Cache, error)

+ type Client struct

+ Banned bool

+ CreatedAt time.Time

+ ID string

+ Name string

+ Scopes []string

+ type Config struct

+ DefaultTTL time.Duration

+ MaxTTL time.Duration

+ Scopes []string

+ type Credential struct

+ ClientID string

+ CreatedAt time.Time

+ Generation int64

+ ID string

+ Name string

+ RevokedAt *time.Time

+ Scopes []string

+ type IssueRequest struct

+ ClientID string

+ Name string

+ Scopes []string

+ TTL time.Duration

+ type Issued struct

+ Credential Credential

+ ExpiresAt time.Time

+ Token string

+ type Option func(*settings) error

+ func WithCache(factory CacheFactory, maxStaleness time.Duration) Option

+ type Principal struct

+ ClientID string

+ CredentialID string

+ Scopes []string

+ type ReadResult struct

+ Generation uint64

+ ReadAt time.Time

+ Record Record

+ type Record struct

+ Client Client

+ Credential Credential

+ Secret SecretVersion

+ type RotateRequest struct

+ CredentialID string

+ ExpectedGeneration int64

+ GracePeriod time.Duration

+ TTL time.Duration

+ type SecretVersion struct

+ CreatedAt time.Time

+ CredentialID string

+ Digest [32]byte

+ ExpiresAt time.Time

+ Generation int64

+ ID string

+ type Service struct

+ func New(store Store, cfg Config, options ...Option) (*Service, error)

+ func (s *Service) Authenticate(ctx context.Context, token string, required ...string) (Principal, error)

+ func (s *Service) Client(ctx context.Context, id string) (Client, error)

+ func (s *Service) Clients(ctx context.Context, after string, limit int) ([]Client, error)

+ func (s *Service) Close() error

+ func (s *Service) CreateClient(ctx context.Context, name string, scopes []string) (Client, error)

+ func (s *Service) Credential(ctx context.Context, id string) (Credential, error)

+ func (s *Service) Credentials(ctx context.Context, clientID, after string, limit int) ([]Credential, error)

+ func (s *Service) Errors() <-chan error

+ func (s *Service) Issue(ctx context.Context, req IssueRequest) (Issued, error)

+ func (s *Service) Revoke(ctx context.Context, id string) error

+ func (s *Service) RevokeAll(ctx context.Context, clientID string) error

+ func (s *Service) Rotate(ctx context.Context, req RotateRequest) (Issued, error)

+ func (s *Service) SetClientBanned(ctx context.Context, id string, banned bool) error

+ func (s *Service) SetClientScopes(ctx context.Context, id string, scopes []string) error

+ func (s *Service) Start(ctx context.Context) error

+ type Snapshot struct

+ Generation uint64

+ ReadAt time.Time

+ Records map[string]Record

+ type Source interface

+ Lookup func(ctx context.Context, secretID string) (ReadResult, error)

+ MaxStaleness func() time.Duration

+ Now func() time.Time

+ Snapshot func(ctx context.Context) (Snapshot, error)

+ type Store interface

+ Client func(ctx context.Context, id string) (Client, error)

+ Clients func(ctx context.Context, afterID string, limit int) ([]Client, error)

+ CreateClient func(ctx context.Context, client Client) error

+ Credential func(ctx context.Context, id string) (Credential, error)

+ Credentials func(ctx context.Context, clientID, afterID string, limit int) ([]Credential, error)

+ Issue func(ctx context.Context, cred Credential, version SecretVersion) error

+ Lookup func(ctx context.Context, secretID string) (Record, error)

+ Revoke func(ctx context.Context, id string, at time.Time) error

+ RevokeAll func(ctx context.Context, clientID string, at time.Time) error

+ Rotate func(ctx context.Context, credID string, expectedGeneration int64, ...) (Credential, error)

+ SetClientBanned func(ctx context.Context, id string, banned bool) error

+ SetClientScopes func(ctx context.Context, id string, scopes []string) error

+ Snapshot func(ctx context.Context) (map[string]Record, error)

+ type TimedStore interface

+ IssueWithLifetime func(ctx context.Context, cred Credential, version SecretVersion, ttl time.Duration) (Credential, SecretVersion, error)

+ RotateWithLifetime func(ctx context.Context, credID string, expectedGeneration int64, ...) (Credential, SecretVersion, error)

+ type Watcher interface

+ Watch func(ctx context.Context, invalidate func()) error

+ type WatcherWithErrors interface

+ WatchWithErrors func(ctx context.Context, invalidate func(), report func(error)) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL