store

Documentation

Overview

Package store provides the persistence repositories.

Package store is the cross-database control-plane store. GORM lives here and nowhere else; the rest of the app depends only on the repository interfaces.

Index

• Variables
• type AIConversationStore
• type AIMessageStore
• type AIProviderStore
• type AuditFilter
• type AuditStore
• type Config
• type ConnectionFolderStore
• type ConnectionPlacementStore
• type ConnectionStore
• type CredentialGrantStore
• type CredentialStore
• type Driver
• type EnrollmentStore
• type GrantStore
• type InvitationStore
• type PolicyStore
• type PreferenceStore
• type RecordingFilter
• type RecordingStore
• type SnippetStore
• type Store
  • func NewMemory() *Store
  • func Open(cfg Config) (*Store, error)
  • func (s *Store) Close() error
• type UserStore

Variables

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

ErrNotFound is returned when a record does not exist. Backends normalize their own not-found errors to this sentinel.

Types

type AIConversationStore

type AIConversationStore interface {
	Create(ctx context.Context, c *models.AIConversation) error
	Get(ctx context.Context, id string) (models.AIConversation, error)
	List(ctx context.Context, ownerID, connectionID string) ([]models.AIConversation, error)
	Update(ctx context.Context, c *models.AIConversation) error
	Delete(ctx context.Context, id string) error
}

AIConversationStore persists chat threads (user + connection scoped).

type AIMessageStore

type AIMessageStore interface {
	Append(ctx context.Context, m *models.AIMessage) error
	List(ctx context.Context, conversationID string) ([]models.AIMessage, error)
	// Recent returns the newest limit messages, ordered oldest→newest.
	Recent(ctx context.Context, conversationID string, limit int) ([]models.AIMessage, error)
	// Range returns messages [offset, offset+limit) ordered oldest→newest.
	Range(ctx context.Context, conversationID string, offset, limit int) ([]models.AIMessage, error)
	Count(ctx context.Context, conversationID string) (int, error)
	DeleteByConversation(ctx context.Context, conversationID string) error
}

AIMessageStore persists conversation messages in sequence.

type AIProviderStore

type AIProviderStore interface {
	Create(ctx context.Context, c *models.AIProviderConfig) error
	Get(ctx context.Context, id string) (models.AIProviderConfig, error)
	ListByOwner(ctx context.Context, ownerID string) ([]models.AIProviderConfig, error)
	Update(ctx context.Context, c *models.AIProviderConfig) error
	Delete(ctx context.Context, id string) error
}

AIProviderStore persists user-scoped AI provider configs (ciphertext keys).

type AuditFilter

type AuditFilter struct {
	UserID       string
	ConnectionID string
	Limit        int
	Offset       int
}

AuditFilter narrows an audit query.

type AuditStore

type AuditStore interface {
	Append(ctx context.Context, e *models.AuditEntry) error
	List(ctx context.Context, f AuditFilter) ([]models.AuditEntry, error)
	// Count returns the number of entries matching the filter (Limit/Offset ignored).
	Count(ctx context.Context, f AuditFilter) (int64, error)
	DeleteBefore(ctx context.Context, before time.Time) (int64, error)
}

AuditStore is append-only: records are written and read, never updated/deleted.

type Config

type Config struct {
	Driver Driver
	// DSN is the connection string. For SQLite this is a file path (or
	// "file::memory:?cache=shared" for tests).
	DSN string
	// LogSQL enables GORM's SQL logger at info level.
	LogSQL bool
}

Config configures the control-plane store.

type ConnectionFolderStore

type ConnectionFolderStore interface {
	Create(ctx context.Context, f *models.ConnectionFolder) error
	Get(ctx context.Context, id string) (models.ConnectionFolder, error)
	ListByUser(ctx context.Context, userID string) ([]models.ConnectionFolder, error)
	Update(ctx context.Context, f *models.ConnectionFolder) error
	Delete(ctx context.Context, id string) error
}

ConnectionFolderStore persists per-user connection folders.

type ConnectionPlacementStore

type ConnectionPlacementStore interface {
	ListByUser(ctx context.Context, userID string) ([]models.ConnectionPlacement, error)
	Set(ctx context.Context, p *models.ConnectionPlacement) error
	Delete(ctx context.Context, userID, connectionID string) error
	DeleteByConnection(ctx context.Context, connectionID string) error
	ClearFolder(ctx context.Context, userID, folderID string) error
	MoveFolder(ctx context.Context, userID, folderID, targetFolderID string) error
}

ConnectionPlacementStore persists per-user connection ordering and foldering.

type ConnectionStore

type ConnectionStore interface {
	Create(ctx context.Context, c *models.Connection) error
	Get(ctx context.Context, id string) (models.Connection, error)
	ListByOwner(ctx context.Context, ownerID string) ([]models.Connection, error)
	List(ctx context.Context) ([]models.Connection, error)
	Update(ctx context.Context, c *models.Connection) error
	Delete(ctx context.Context, id string) error
}

ConnectionStore persists connections (with ciphertext for inline secrets).

type CredentialGrantStore

type CredentialGrantStore interface {
	Create(ctx context.Context, g *models.CredentialGrant) error
	Delete(ctx context.Context, id string) error
	Has(ctx context.Context, credentialID, subjectID string) (bool, error)
	ListByCredential(ctx context.Context, credentialID string) ([]models.CredentialGrant, error)
	ListBySubject(ctx context.Context, subjectID string) ([]models.CredentialGrant, error)
}

CredentialGrantStore persists credential use-grants (no secret readback).

type CredentialStore

type CredentialStore interface {
	Create(ctx context.Context, c *models.Credential) error
	Get(ctx context.Context, id string) (models.Credential, error)
	ListByOwner(ctx context.Context, ownerID string) ([]models.Credential, error)
	Update(ctx context.Context, c *models.Credential) error
	Delete(ctx context.Context, id string) error
}

CredentialStore persists reusable credentials (with ciphertext material).

type Driver

type Driver string

Driver selects the SQL engine. SQLite is the zero-config single-binary default.

const (
	DriverSQLite   Driver = "sqlite"
	DriverPostgres Driver = "postgres"
	DriverMySQL    Driver = "mysql"
)

type EnrollmentStore

type EnrollmentStore interface {
	Create(ctx context.Context, e *models.AgentEnrollment) error
	Get(ctx context.Context, id string) (models.AgentEnrollment, error)
	GetByTokenHash(ctx context.Context, tokenHash string) (models.AgentEnrollment, error)
	ListByConnection(ctx context.Context, connectionID string) ([]models.AgentEnrollment, error)
	UpdateStatus(ctx context.Context, id string, status models.AgentEnrollmentStatus) error
	// UpdateToken sets the redeemable token hash and resets the install window.
	// Used by URL-delivered artifacts, which mint the real token only when the
	// artifact body is fetched (the record is created with a placeholder hash).
	UpdateToken(ctx context.Context, id, tokenHash string, expiresAt time.Time) error
	// Consume atomically transitions an install token to online. Pending tokens
	// must be unexpired; already enrolled offline/online tokens may reconnect.
	Consume(ctx context.Context, id string, now time.Time) (bool, error)
}

EnrollmentStore persists agent enrollment lifecycle records.

type GrantStore

type GrantStore interface {
	Create(ctx context.Context, g *models.Grant) error
	Delete(ctx context.Context, id string) error
	Get(ctx context.Context, connectionID, subjectID string) (models.Grant, error)
	ListByConnection(ctx context.Context, connectionID string) ([]models.Grant, error)
	ListBySubject(ctx context.Context, subjectID string) ([]models.Grant, error)
}

GrantStore persists per-connection sharing grants.

type InvitationStore

type InvitationStore interface {
	Create(ctx context.Context, i *models.Invitation) error
	Get(ctx context.Context, id string) (models.Invitation, error)
	GetByTokenHash(ctx context.Context, tokenHash string) (models.Invitation, error)
	List(ctx context.Context) ([]models.Invitation, error)
	Update(ctx context.Context, i *models.Invitation) error
	Consume(ctx context.Context, id string, acceptedAt time.Time) (bool, error)
	Delete(ctx context.Context, id string) error
}

InvitationStore persists account invitations (only the token hash is stored).

type PolicyStore

type PolicyStore interface {
	Create(ctx context.Context, p *models.PolicyRule) error
	Delete(ctx context.Context, id string) error
	List(ctx context.Context) ([]models.PolicyRule, error)
}

PolicyStore persists additive authorization policies loaded into Casbin.

type PreferenceStore

type PreferenceStore interface {
	Get(ctx context.Context, userID, key string) (models.Preference, error)
	Set(ctx context.Context, p *models.Preference) error
	Delete(ctx context.Context, userID, key string) error
}

PreferenceStore persists per-user key/value preferences.

type RecordingFilter

type RecordingFilter struct {
	UserID       string
	ConnectionID string
	Protocol     string
	Class        string
	Format       string
	Status       string
	Since        time.Time
	Until        time.Time
	// ExpiredBefore selects recordings whose ExpiresAt is set and at/before it
	// (used by retention cleanup). Ignored when zero.
	ExpiredBefore time.Time
	Limit         int
}

RecordingFilter narrows a recording query. Zero-value fields are ignored.

type RecordingStore

type RecordingStore interface {
	Create(ctx context.Context, r *models.Recording) error
	Get(ctx context.Context, id string) (models.Recording, error)
	Update(ctx context.Context, r *models.Recording) error
	Delete(ctx context.Context, id string) error
	List(ctx context.Context, f RecordingFilter) ([]models.Recording, error)
}

RecordingStore persists session-recording metadata (the blobs live elsewhere).

type SnippetStore

type SnippetStore interface {
	Create(ctx context.Context, s *models.Snippet) error
	Get(ctx context.Context, id string) (models.Snippet, error)
	ListByOwner(ctx context.Context, ownerID, protocol string) ([]models.Snippet, error)
	Update(ctx context.Context, s *models.Snippet) error
	Delete(ctx context.Context, id string) error
}

SnippetStore persists saved command/query snippets.

type Store

type Store struct {
	Users                UserStore
	Connections          ConnectionStore
	ConnectionFolders    ConnectionFolderStore
	ConnectionPlacements ConnectionPlacementStore
	Credentials          CredentialStore
	Grants               GrantStore
	CredentialGrants     CredentialGrantStore
	Audit                AuditStore
	Snippets             SnippetStore
	Preferences          PreferenceStore
	Enrollments          EnrollmentStore
	Policies             PolicyStore
	Invitations          InvitationStore
	Recordings           RecordingStore
	AIProviders          AIProviderStore
	AIConversations      AIConversationStore
	AIMessages           AIMessageStore
	// contains filtered or unexported fields
}

Store aggregates every repository plus lifecycle controls.

func NewMemory

func NewMemory() *Store

NewMemory returns a fully in-memory Store for unit tests — no DB, no gorm.

func Open

func Open(cfg Config) (*Store, error)

Open connects using a pure-Go driver, runs AutoMigrate, and wires the repos.

func (*Store) Close

func (s *Store) Close() error

Close releases the underlying database, if any.

type UserStore

type UserStore interface {
	Create(ctx context.Context, u *models.User, passwordHash string) error
	GetByID(ctx context.Context, id string) (models.User, error)
	GetByUsername(ctx context.Context, username string) (models.User, error)
	GetByEmail(ctx context.Context, email string) (models.User, error)
	GetPasswordHash(ctx context.Context, userID string) (string, error)
	SetPasswordHash(ctx context.Context, userID, hash string) error
	List(ctx context.Context) ([]models.User, error)
	Update(ctx context.Context, u *models.User) error
	Delete(ctx context.Context, id string) error
	Count(ctx context.Context) (int64, error)

	// SetTwoFactor persists the user's TOTP enrollment state atomically: the
	// encrypted secret, the enabled flag, and the hashed recovery codes.
	SetTwoFactor(ctx context.Context, userID string, secret []byte, enabled bool, recoveryHashes []string) error
	// SetMFARemindedAt records when the user was last nudged to enable 2FA.
	SetMFARemindedAt(ctx context.Context, userID string, at *time.Time) error
}

UserStore persists platform users and their local password hashes.