storage

package

Go to main page

Versions in this module

v0

v0.2.0

Nov 2, 2026

Changes in this version

type RouterLease

+ IngressURL string

v0.1.1

Oct 18, 2026

Changes in this version

type SQLStore

+ func (s *SQLStore) SetKeyring(ctx context.Context, current KeyPair, verifying []KeyPair, ...) error

+ func (s *SQLStore) SetOIDCKeyring(ctx context.Context, current OIDCKeyPair, verifying []OIDCKeyPair, ...) error

type Store

+ SetKeyring func(ctx context.Context, current KeyPair, verifying []KeyPair, ...) error

+ SetOIDCKeyring func(ctx context.Context, current OIDCKeyPair, verifying []OIDCKeyPair, ...) error

v0.1.0

Oct 15, 2026

Changes in this version

+ var ErrBootstrapTokenUnusable = errors.New("bootstrap token is expired, revoked or exhausted")

+ var ErrEnrollmentAlreadyResolved = errors.New("enrollment request is already resolved")

+ var ErrNodeBanned = errors.New("node is banned")

+ var ErrNodeSessionExpired = errors.New("node session expired")

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

+ type BootstrapToken struct

+ AutonomousRecovery bool

+ CreatedAt time.Time

+ Description string

+ Ephemeral bool

+ ExpiresAt time.Time

+ ID string

+ MaxUsages int

+ OwnerID string

+ RevokedAt *time.Time

+ Role string

+ TokenHash string

+ UsagesCount int

+ func (t *BootstrapToken) IsRevoked() bool

+ type EnrolledNode struct

+ AutonomousRecovery bool

+ Banned bool

+ Biscuit []byte

+ ClaimsJSON string

+ EnrolledAt time.Time

+ EnrollmentType string

+ Ephemeral bool

+ ExpiresAt time.Time

+ Labels map[string]string

+ OwnerID string

+ PeerID string

+ PublicKey []byte

+ Role string

+ func (n *EnrolledNode) CheckAdmission(now time.Time) error

+ type EnrollmentRequest struct

+ BiscuitToken []byte

+ CreatedAt time.Time

+ ID string

+ Labels map[string]string

+ PeerID string

+ PublicKey []byte

+ ResolvedAt *time.Time

+ ResolvedBy string

+ Status api.EnrollmentStatus

+ TokenID string

+ type KeyPair struct

+ Expiration time.Time

+ Private ed25519.PrivateKey

+ Public ed25519.PublicKey

+ type NodeCount struct

+ Count int

+ Role string

+ State NodeState

+ type NodeCursor struct

+ EnrolledAt time.Time

+ PeerID string

+ type NodeFilter struct

+ After *NodeCursor

+ Limit int

+ Now time.Time

+ OwnerID *string

+ Role string

+ States []NodeState

+ type NodeState string

+ const NodeAdmitted

+ const NodeBanned

+ const NodeExpired

+ type OIDCKeyPair struct

+ Expiration time.Time

+ Kid string

+ PrivateKey []byte

+ PublicKey []byte

+ type RouterLease struct

+ Addresses []string

+ ConnectedPeers []string

+ ConnectionLimit int

+ Connections int

+ DHTSize int

+ ExpiresAt time.Time

+ LastRenewal time.Time

+ PeerID string

+ type SQLStore struct

+ func NewSQLStore(driverName, dataSourceName string) (*SQLStore, error)

+ func (s *SQLStore) ClaimKeyRotation(ctx context.Context, now time.Time, interval time.Duration) (bool, error)

+ func (s *SQLStore) Close() error

+ func (s *SQLStore) ConsumeBootstrapTokenUsage(ctx context.Context, id string, now time.Time) error

+ func (s *SQLStore) CountEnrollmentRequests(ctx context.Context) (map[api.EnrollmentStatus]int64, error)

+ func (s *SQLStore) CountNodes(ctx context.Context, now time.Time) ([]NodeCount, error)

+ func (s *SQLStore) CountRows(ctx context.Context) (map[string]int64, error)

+ func (s *SQLStore) CreateEnrollmentRequest(ctx context.Context, req *EnrollmentRequest) error

+ func (s *SQLStore) DeleteExpiredBootstrapTokens(ctx context.Context, before time.Time) (int64, error)

+ func (s *SQLStore) DeleteExpiredNodes(ctx context.Context, before time.Time) (int64, error)

+ func (s *SQLStore) DeleteExpiredRouterLeases(ctx context.Context, before time.Time) (int64, error)

+ func (s *SQLStore) DeleteSilentBootstrapNodes(ctx context.Context, before, ephemeralBefore time.Time) (int64, int64, error)

+ func (s *SQLStore) DeleteStaleEnrollmentRequests(ctx context.Context, before, ephemeralBefore time.Time) (int64, error)

+ func (s *SQLStore) EnrollNode(ctx context.Context, node *EnrolledNode) error

+ func (s *SQLStore) GetActiveRouters(ctx context.Context) ([]RouterLease, error)

+ func (s *SQLStore) GetAllValidKeys(ctx context.Context) ([]KeyPair, error)

+ func (s *SQLStore) GetAllValidOIDCKeys(ctx context.Context) ([]OIDCKeyPair, error)

+ func (s *SQLStore) GetAllValidPublicKeys(ctx context.Context) ([]ed25519.PublicKey, error)

+ func (s *SQLStore) GetBootstrapToken(ctx context.Context, id string) (*BootstrapToken, error)

+ func (s *SQLStore) GetCurrentKey(ctx context.Context) (ed25519.PrivateKey, ed25519.PublicKey, error)

+ func (s *SQLStore) GetCurrentOIDCKey(ctx context.Context) (*OIDCKeyPair, error)

+ func (s *SQLStore) GetEgressDestinations(ctx context.Context) ([]*api.EgressDestination, error)

+ func (s *SQLStore) GetEnrollmentRequest(ctx context.Context, peerID string) (*EnrollmentRequest, error)

+ func (s *SQLStore) GetEnrollmentRequestByID(ctx context.Context, id string) (*EnrollmentRequest, error)

+ func (s *SQLStore) GetMeshPolicy(ctx context.Context) ([]*api.PolicyRole, []*api.PolicyBinding, error)

+ func (s *SQLStore) GetNode(ctx context.Context, peerID string) (*EnrolledNode, error)

+ func (s *SQLStore) GetUser(ctx context.Context, id string) (*User, error)

+ func (s *SQLStore) IsBiscuitRevoked(ctx context.Context, revocationID string, now time.Time) (bool, error)

+ func (s *SQLStore) IsIdentityBanned(ctx context.Context, identity string) (bool, error)

+ func (s *SQLStore) IsNodeBanned(ctx context.Context, peerID string) (bool, error)

+ func (s *SQLStore) ListBannedPeerIDs(ctx context.Context) ([]string, error)

+ func (s *SQLStore) ListBootstrapTokens(ctx context.Context) ([]BootstrapToken, error)

+ func (s *SQLStore) ListEnrollmentRequests(ctx context.Context) ([]EnrollmentRequest, error)

+ func (s *SQLStore) ListNodes(ctx context.Context, filter NodeFilter) ([]EnrolledNode, error)

+ func (s *SQLStore) ListRevokedBiscuits(ctx context.Context, now time.Time) (map[string]time.Time, error)

+ func (s *SQLStore) ListUsers(ctx context.Context) ([]User, error)

+ func (s *SQLStore) NextKeyRotation(ctx context.Context) (time.Time, error)

+ func (s *SQLStore) Ping(ctx context.Context) error

+ func (s *SQLStore) ReleaseKeyRotationClaim(ctx context.Context, now time.Time, interval time.Duration) error

+ func (s *SQLStore) ResolveEnrollmentRequest(ctx context.Context, id string, status api.EnrollmentStatus, biscuit []byte, ...) error

+ func (s *SQLStore) RevokeBootstrapToken(ctx context.Context, id string) error

+ func (s *SQLStore) RotateKeys(ctx context.Context, newPriv ed25519.PrivateKey, newPub ed25519.PublicKey, ...) error

+ func (s *SQLStore) RotateOIDCKeys(ctx context.Context, kid string, newPriv, newPub []byte, ...) error

+ func (s *SQLStore) SaveBootstrapToken(ctx context.Context, token *BootstrapToken) error

+ func (s *SQLStore) SaveEgressDestinations(ctx context.Context, egress []*api.EgressDestination) error

+ func (s *SQLStore) SaveInitialKey(ctx context.Context, priv ed25519.PrivateKey, pub ed25519.PublicKey) error

+ func (s *SQLStore) SaveInitialOIDCKey(ctx context.Context, kid string, priv, pub []byte) error

+ func (s *SQLStore) SaveMeshPolicy(ctx context.Context, roles []*api.PolicyRole, bindings []*api.PolicyBinding) error

+ func (s *SQLStore) SavePolicyDocument(ctx context.Context, roles []*api.PolicyRole, bindings []*api.PolicyBinding, ...) error

+ func (s *SQLStore) SaveRevokedBiscuit(ctx context.Context, revocationID string, expiresAt time.Time) error

+ func (s *SQLStore) SaveUser(ctx context.Context, user *User) error

+ func (s *SQLStore) ScheduleKeyRotationIfUnset(ctx context.Context, at time.Time) (bool, error)

+ func (s *SQLStore) SetIdentityBanned(ctx context.Context, identity string, banned bool) error

+ func (s *SQLStore) SetNodeAndIdentityBanned(ctx context.Context, peerID, identity string, banned bool) error

+ func (s *SQLStore) SetNodeAutonomousRecovery(ctx context.Context, peerID string, enabled bool) error

+ func (s *SQLStore) SetNodeBanned(ctx context.Context, peerID string, banned bool) error

+ func (s *SQLStore) UpdateEnrollmentRequest(ctx context.Context, id string, status api.EnrollmentStatus, biscuit []byte, ...) error

+ func (s *SQLStore) UpsertRouterLease(ctx context.Context, lease *RouterLease) error

+ type Store interface

+ ClaimKeyRotation func(ctx context.Context, now time.Time, interval time.Duration) (bool, error)

+ Close func() error

+ ConsumeBootstrapTokenUsage func(ctx context.Context, id string, now time.Time) error

+ CountEnrollmentRequests func(ctx context.Context) (map[api.EnrollmentStatus]int64, error)

+ CountNodes func(ctx context.Context, now time.Time) ([]NodeCount, error)

+ CountRows func(ctx context.Context) (map[string]int64, error)

+ CreateEnrollmentRequest func(ctx context.Context, req *EnrollmentRequest) error

+ DeleteExpiredBootstrapTokens func(ctx context.Context, before time.Time) (int64, error)

+ DeleteExpiredNodes func(ctx context.Context, before time.Time) (int64, error)

+ DeleteExpiredRouterLeases func(ctx context.Context, before time.Time) (int64, error)

+ DeleteSilentBootstrapNodes func(ctx context.Context, before, ephemeralBefore time.Time) (regular, ephemeral int64, err error)

+ DeleteStaleEnrollmentRequests func(ctx context.Context, before, ephemeralBefore time.Time) (int64, error)

+ EnrollNode func(ctx context.Context, node *EnrolledNode) error

+ GetActiveRouters func(ctx context.Context) ([]RouterLease, error)

+ GetAllValidKeys func(ctx context.Context) ([]KeyPair, error)

+ GetAllValidOIDCKeys func(ctx context.Context) ([]OIDCKeyPair, error)

+ GetAllValidPublicKeys func(ctx context.Context) ([]ed25519.PublicKey, error)

+ GetBootstrapToken func(ctx context.Context, id string) (*BootstrapToken, error)

+ GetCurrentKey func(ctx context.Context) (ed25519.PrivateKey, ed25519.PublicKey, error)

+ GetCurrentOIDCKey func(ctx context.Context) (*OIDCKeyPair, error)

+ GetEgressDestinations func(ctx context.Context) ([]*api.EgressDestination, error)

+ GetEnrollmentRequest func(ctx context.Context, peerID string) (*EnrollmentRequest, error)

+ GetEnrollmentRequestByID func(ctx context.Context, id string) (*EnrollmentRequest, error)

+ GetMeshPolicy func(ctx context.Context) ([]*api.PolicyRole, []*api.PolicyBinding, error)

+ GetNode func(ctx context.Context, peerID string) (*EnrolledNode, error)

+ GetUser func(ctx context.Context, id string) (*User, error)

+ IsBiscuitRevoked func(ctx context.Context, revocationID string, now time.Time) (bool, error)

+ IsIdentityBanned func(ctx context.Context, identity string) (bool, error)

+ IsNodeBanned func(ctx context.Context, peerID string) (bool, error)

+ ListBannedPeerIDs func(ctx context.Context) ([]string, error)

+ ListBootstrapTokens func(ctx context.Context) ([]BootstrapToken, error)

+ ListEnrollmentRequests func(ctx context.Context) ([]EnrollmentRequest, error)

+ ListNodes func(ctx context.Context, filter NodeFilter) ([]EnrolledNode, error)

+ ListRevokedBiscuits func(ctx context.Context, now time.Time) (map[string]time.Time, error)

+ ListUsers func(ctx context.Context) ([]User, error)

+ NextKeyRotation func(ctx context.Context) (time.Time, error)

+ Ping func(ctx context.Context) error

+ ReleaseKeyRotationClaim func(ctx context.Context, now time.Time, interval time.Duration) error

+ ResolveEnrollmentRequest func(ctx context.Context, id string, status api.EnrollmentStatus, biscuit []byte, ...) error

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

+ RotateKeys func(ctx context.Context, newPriv ed25519.PrivateKey, newPub ed25519.PublicKey, ...) error

+ RotateOIDCKeys func(ctx context.Context, kid string, newPriv, newPub []byte, ...) error

+ SaveBootstrapToken func(ctx context.Context, token *BootstrapToken) error

+ SaveEgressDestinations func(ctx context.Context, egress []*api.EgressDestination) error

+ SaveInitialKey func(ctx context.Context, priv ed25519.PrivateKey, pub ed25519.PublicKey) error

+ SaveInitialOIDCKey func(ctx context.Context, kid string, priv, pub []byte) error

+ SaveMeshPolicy func(ctx context.Context, roles []*api.PolicyRole, bindings []*api.PolicyBinding) error

+ SavePolicyDocument func(ctx context.Context, roles []*api.PolicyRole, bindings []*api.PolicyBinding, ...) error

+ SaveRevokedBiscuit func(ctx context.Context, revocationID string, expiresAt time.Time) error

+ SaveUser func(ctx context.Context, user *User) error

+ ScheduleKeyRotationIfUnset func(ctx context.Context, at time.Time) (bool, error)

+ SetIdentityBanned func(ctx context.Context, identity string, banned bool) error

+ SetNodeAndIdentityBanned func(ctx context.Context, peerID, identity string, banned bool) error

+ SetNodeAutonomousRecovery func(ctx context.Context, peerID string, enabled bool) error

+ SetNodeBanned func(ctx context.Context, peerID string, banned bool) error

+ UpdateEnrollmentRequest func(ctx context.Context, id string, status api.EnrollmentStatus, biscuit []byte, ...) error

+ UpsertRouterLease func(ctx context.Context, lease *RouterLease) error

+ type User struct

+ CreatedAt time.Time

+ Email string

+ ID string

+ Issuer string

+ Role string

+ func (u *User) IdentityKey() string

v0.1.0-rc.10

Oct 14, 2026

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