openlore

package

Go to main page

Versions in this module

v0

v0.6.1

Sep 9, 2026

v0.6.0

Sep 4, 2026

Changes in this version

+ var ErrRefreshStaleRetry = errors.New("stale refresh retry")

+ var WithRulesTokenizer = config.WithRulesTokenizer

type DirFS

+ func (d *DirFS) HostDir(p string) (string, bool)

+ type HistoryPage struct

+ NextCursor string

+ Records []HistoryRecord

+ type HistoryQuery struct

+ Actor string

+ Cursor string

+ FileKey string

+ Limit int

+ Principal string

+ Roots []string

+ type HistoryRecord struct

+ Action string

+ Attribution Attribution

+ ContentHash string

+ FileKey string

+ Time time.Time

+ type HistoryRecorder interface

+ Record func(context.Context, []HistoryRecord) error

+ type HistoryStore interface

+ Query func(context.Context, HistoryQuery) (HistoryPage, error)

+ type JSONLHistoryStore struct

+ func NewJSONLHistoryStore(dir string) *JSONLHistoryStore

+ func (s *JSONLHistoryStore) Query(_ context.Context, query HistoryQuery) (HistoryPage, error)

+ func (s *JSONLHistoryStore) Record(_ context.Context, records []HistoryRecord) error

type MergeFS

+ func (m *MergeFS) HostDir(p string) (string, bool)

type OverlayFS

+ func (o *OverlayFS) HostDir(p string) (string, bool)

+ type RefreshRotation struct

+ Retried bool

+ Token RefreshToken

type RefreshToken

+ ReplacedBy string

+ RotatedAt time.Time

v0.5.0

Aug 19, 2026

Changes in this version

+ var WithDebug = config.WithDebug

+ type Attribution struct

+ Actor string

+ ClientAuth ClientAuthLevel

+ Extra map[string]string

+ Principal string

+ func (a Attribution) String() string

+ type AuditEvent struct

+ Attribution Attribution

+ Details map[string]any

+ Time time.Time

+ Type string

+ type AuditLog interface

+ Record func(context.Context, AuditEvent) error

type AuthorizationPolicy

+ DenyCapabilities []string

+ DenyDocsets []string

+ type CIMDClient struct

+ AuthMethods []string

+ ClientID string

+ ClientName string

+ ExpiresAt time.Time

+ FetchedAt time.Time

+ JWKSURI string

+ Origin string

+ RedirectURIs []string

+ func (c CIMDClient) Offers(method string) bool

+ type CIMDResolver interface

+ Resolve func(context.Context, string) (*CIMDClient, error)

type Claims

+ Actor string

+ ClientAuth ClientAuthLevel

+ type ClientAuthLevel string

+ const AuthCIMD

+ const AuthDCRDomain

+ const AuthDCRLocal

+ const AuthPrivateKeyJWT

+ const AuthPrivateKeyJWTMTLS

+ func (l ClientAuthLevel) Verified() bool

+ type ClientAuthenticator interface

+ Authenticate func(*http.Request, *CIMDClient) (ClientAuthLevel, error)

type CommitInfo

+ Attribution Attribution

+ type CommitRecord struct

+ Attribution Attribution

+ ChangeSet vfs.ChangeSet

+ Hash string

+ Time time.Time

+ func (r CommitRecord) DisplayAttribution() string

+ func (r CommitRecord) Validate() error

+ type CommitRecorder interface

+ RecordCommit func(context.Context, CommitRecord) error

type Identity

+ Attribution Attribution

+ type JSONLAuditLog struct

+ func NewJSONLAuditLog(path string) *JSONLAuditLog

+ func (l *JSONLAuditLog) Record(_ context.Context, event AuditEvent) error

+ type JSONLCommitRecorder struct

+ func NewJSONLCommitRecorder(path string) *JSONLCommitRecorder

+ func (r *JSONLCommitRecorder) RecordCommit(_ context.Context, record CommitRecord) error

type Job

+ Attribution Attribution

type MCPOption

+ func WithMCPReadOnly(readOnly bool) MCPOption

type OAuthClient

+ CIMD *CIMDClient

+ LastDelegate string

type ReadOp

+ Attribution Attribution

type RefreshToken

+ Actor string

+ ClientAuth ClientAuthLevel

+ ClientID string

type RefreshTokenStore

+ RevokeDelegation func(subject, actor string) (int, error)

type Server

+ func (s *Server) ExchangeDelegation(_ context.Context, actorToken, principalName string) (Attribution, string, time.Duration, error)

+ func (s *Server) PromoteIdentity(attribution Attribution, name string, roles []string, home, publicKey string, ...) error

+ func (s *Server) Reload(source cmds.JobAttribution) error

+ type SigningKeyStore interface

+ ActiveKeyID func() string

+ Rotate func(revokePrevious bool) (string, error)

type WriteOp

+ Attribution Attribution

v0.4.1

Aug 8, 2026

v0.4.0

Aug 7, 2026

Changes in this version

+ type ContentTransform func(path string, content []byte) []byte

+ type ContentTransformProvider interface

+ ContentTransforms func() []ContentTransform

type DirFS

+ func (d *DirFS) GetXattr(p, name string) ([]byte, error)

+ func (d *DirFS) ListXattrs(p string) ([]string, error)

+ func (d *DirFS) MigrateXattrs(p string, m vfs.XattrMigration) error

+ func (d *DirFS) PreflightChange(change vfs.Change) error

+ func (d *DirFS) PreserveAndRecreateXattrs(p string, attrs map[string][]byte) error

+ func (d *DirFS) RemoveXattr(p, name string) error

+ func (d *DirFS) SetXattr(p, name string, value []byte, flags vfs.XattrFlags) error

+ func (d *DirFS) WithMaxWriteBytes(max int64) *DirFS

+ type HTTPRouteProvider interface

+ PrepareHTTPRoutes func(*Server) (HTTPRouteRegistrar, error)

+ type HTTPRouteRegistrar func(*http.ServeMux)

type InboxPlugin

+ func (p *InboxPlugin) PrepareHTTPRoutes(s *Server) (HTTPRouteRegistrar, error)

+ type InboxToken struct

+ CreatedAt time.Time

+ ExpiresAt *time.Time

+ ID string

+ Identity string

+ Label string

+ Secret string

+ func (t InboxToken) Credential() string

+ type InboxTokenStore struct

+ func NewInboxTokenStore(dataDir string) (*InboxTokenStore, error)

+ func (s *InboxTokenStore) Create(identity, label string, expires *time.Time) (InboxToken, error)

+ func (s *InboxTokenStore) Delete(id string) (bool, error)

+ func (s *InboxTokenStore) Get(id string) (InboxToken, bool, error)

+ func (s *InboxTokenStore) List() ([]InboxToken, error)

type MergeFS

+ func (m *MergeFS) GetXattr(p, name string) ([]byte, error)

+ func (m *MergeFS) ListXattrs(p string) ([]string, error)

+ func (m *MergeFS) MigrateXattrs(p string, migration vfs.XattrMigration) error

+ func (m *MergeFS) PreflightChange(change vfs.Change) error

+ func (m *MergeFS) PreserveAndRecreateXattrs(p string, attrs map[string][]byte) error

+ func (m *MergeFS) RemoveXattr(p, name string) error

+ func (m *MergeFS) SetXattr(p, name string, value []byte, flags vfs.XattrFlags) error

type OverlayFS

+ func (o *OverlayFS) GetXattr(p, name string) ([]byte, error)

+ func (o *OverlayFS) ListXattrs(p string) ([]string, error)

+ func (o *OverlayFS) MigrateXattrs(p string, m vfs.XattrMigration) error

+ func (o *OverlayFS) PreflightChange(change vfs.Change) error

+ func (o *OverlayFS) PreserveAndRecreateXattrs(p string, attrs map[string][]byte) error

+ func (o *OverlayFS) RemoveXattr(p, name string) error

+ func (o *OverlayFS) SetXattr(p, name string, value []byte, flags vfs.XattrFlags) error

type Server

+ func (s *Server) AdmitChangeSet(ctx context.Context, id Identity, cs vfs.ChangeSet) (WriteResult, error)

type WriteOp

+ func NewWriteOp(actor Actor, cs vfs.ChangeSet) WriteOp

+ func (op WriteOp) Leaves() []vfs.Change

+ func (op WriteOp) Pending(ref string) *vfs.PendingChangeError

v0.3.0

Jul 14, 2026

Changes in this version

+ var ValidateAuthConfig = config.ValidateAuthConfig

+ var WithWritableDir = config.WithWritableDir

+ type AuthenticatedPrincipal struct

+ Claims map[string]any

+ IdentityName string

+ Scope string

+ Source string

+ Subject string

+ type AuthorizationPolicy struct

+ HomeDocset string

+ IdentityName string

+ Roles []string

+ type AuthorizationStore interface

+ ResolveAuthorization func(context.Context, AuthenticatedPrincipal) (AuthorizationPolicy, error)

type Identity

+ Principal AuthenticatedPrincipal

type InboxPlugin

+ func (*InboxPlugin) Info() PluginInfo

+ type MetaExtenderProvider interface

+ MetaExtenders func() []meta.Extender

+ type MetaFilterProvider interface

+ MetaFilters func() []meta.Filter

+ type OverlayFS struct

+ func NewOverlayFS(upper *DirFS, lower vfs.FileSystem) *OverlayFS

+ func (o *OverlayFS) Mkdir(p string) error

+ func (o *OverlayFS) MkdirAll(p string) error

+ func (o *OverlayFS) ReadDir(p string) ([]vfs.FileInfo, error)

+ func (o *OverlayFS) ReadFile(p string) ([]byte, error)

+ func (o *OverlayFS) Remove(p string) error

+ func (o *OverlayFS) RemoveAll(p string, opts vfs.RemoveOpts) error

+ func (o *OverlayFS) SetReadonly() error

+ func (o *OverlayFS) SetWriteable() error

+ func (o *OverlayFS) Stat(p string) (*vfs.FileInfo, error)

+ func (o *OverlayFS) WriteFileAtomic(p string, content []byte, opts vfs.WriteOpts) (string, error)

+ type PluginInfo struct

+ Name string

+ Version string

+ type PluginInfoProvider interface

+ Info func() PluginInfo

type Server

+ func NewServerWithLowerFS(lower fs.FS, opts ...config.Option) (*Server, error)

+ type ValidatorProvider interface

+ Validators func() []validation.Validator

v0.2.0

Jul 9, 2026

Changes in this version

+ const DefaultJobTimeout

+ const ScopeFull

+ const ScopeRead

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

+ var ErrLogClosed = errors.New("openlore: write log closed")

+ var ErrRefreshInvalid = errors.New("invalid refresh token")

+ var ErrRefreshReuse = errors.New("refresh token reuse detected")

+ var ErrUnknownIdentity = errors.New("unknown identity")

+ var ErrWIFDisabled = errors.New("workload identity federation is not enabled")

+ var WithMCPEnabled = config.WithMCPEnabled

+ var WithMCPPath = config.WithMCPPath

+ var WithReadonly = config.WithReadonly

+ func EncodeEvent(e Event) ([]byte, error)

+ func MatchAll(Event) bool

+ type Actor struct

+ Extra map[string]string

+ ID string

+ type Claims struct

+ Audience string

+ Expiry time.Time

+ Issuer string

+ Raw map[string]any

+ Scope string

+ Subject string

+ type ClientStore interface

+ Lookup func(ctx context.Context, clientID string) (OAuthClient, bool, error)

+ Save func(ctx context.Context, client OAuthClient) error

+ type CommitInfo struct

+ Actor Actor

+ ChangeSet vfs.ChangeSet

+ Hash string

type DirFS

+ func (d *DirFS) Mkdir(p string) error

+ func (d *DirFS) MkdirAll(p string) error

+ func (d *DirFS) Remove(p string) error

+ func (d *DirFS) RemoveAll(p string, opts vfs.RemoveOpts) error

+ func (d *DirFS) SetReadonly() error

+ func (d *DirFS) SetWriteable() error

+ func (d *DirFS) WithDocsetRoots(roots []string) *DirFS

+ func (d *DirFS) WriteFileAtomic(p string, content []byte, opts vfs.WriteOpts) (string, error)

+ type Emit interface

+ Emit func(ctx context.Context, e Event) error

+ type EmitFunc func(ctx context.Context, e Event) error

+ func (f EmitFunc) Emit(ctx context.Context, e Event) error

+ type Event struct

+ Agent string

+ At time.Time

+ Bytes int

+ ContentHash string

+ Extra map[string]string

+ Kind EventKind

+ Partition string

+ Path string

+ type EventFilter func(Event) bool

+ func MatchPartition(partition string) EventFilter

+ type EventKind string

+ const KindOnStartup

+ const KindPostDelete

+ const KindPostWrite

+ const KindPreRead

+ const KindTopicRefreshed

+ type GrantType interface

+ AllowsWrite func() bool

+ CanRead func(ds config.DocsetSpec, p string) bool

+ CanWrite func(ds config.DocsetSpec, action vfs.ChangeAction, p string) bool

+ Name func() string

+ type GrantTypeProvider interface

+ GrantTypes func() []GrantType

type Identity

+ Capabilities []string

+ Grants map[string]string

+ HomeDir string

+ HomeDocset string

+ Scopes []string

+ type IdentityStore interface

+ Resolve func(ctx context.Context, claims Claims) (Identity, error)

+ type InboxPlugin struct

+ func NewInboxPlugin() *InboxPlugin

+ func (*InboxPlugin) GrantTypes() []GrantType

+ type Issuer interface

+ JWKS func() ([]byte, error)

+ Mint func(sub, scope string, ttl time.Duration) (token string, exp time.Time, err error)

+ Verify func(token string) (Claims, error)

+ func NewIssuerFromConfig(cfg config.Config) (Issuer, error)

+ type Job struct

+ Command string

+ EndedAt time.Time

+ ID string

+ Identity string

+ Note string

+ StartedAt time.Time

+ State JobState

+ Target string

+ type JobManager struct

+ func NewJobManager(maxConcurrent int, runner Runner, logger *slog.Logger) *JobManager

+ func (m *JobManager) Drain(timeout time.Duration) bool

+ func (m *JobManager) Submit(spec cmds.JobSpec) (string, error)

+ type JobState string

+ const JobDone

+ const JobFailed

+ const JobRunning

+ type JobsFS struct

+ func NewJobsFS(mgr *JobManager) *JobsFS

+ func (f *JobsFS) ReadDir(p string) ([]vfs.FileInfo, error)

+ func (f *JobsFS) ReadFile(p string) ([]byte, error)

+ func (f *JobsFS) Stat(p string) (*vfs.FileInfo, error)

+ type MCPHTTPAPI struct

+ func NewMCPHTTPAPI(server *mcp.Server) *MCPHTTPAPI

+ func (a *MCPHTTPAPI) Handler(prefix string) http.Handler

type MergeFS

+ func (m *MergeFS) Mkdir(p string) error

+ func (m *MergeFS) MkdirAll(p string) error

+ func (m *MergeFS) MountSystem(name string, fs vfs.FileSystem)

+ func (m *MergeFS) Remove(p string) error

+ func (m *MergeFS) RemoveAll(p string, opts vfs.RemoveOpts) error

+ func (m *MergeFS) SetReadonly() error

+ func (m *MergeFS) SetWriteable() error

+ func (m *MergeFS) SystemMountPaths() []string

+ func (m *MergeFS) WriteFileAtomic(p string, content []byte, opts vfs.WriteOpts) (string, error)

+ type OAuthClient struct

+ ClientID string

+ ClientIDIssuedAt time.Time

+ ClientName string

+ GrantTypes []string

+ RedirectURIs []string

+ ResponseTypes []string

+ Scope string

+ TokenEndpointAuthMethod string

+ func (c OAuthClient) AllowsRedirect(uri string) bool

+ type OIDCVerifier interface

+ Verify func(ctx context.Context, assertion string) (Claims, error)

+ type PostCommitHandler func(ctx context.Context, info CommitInfo) error

+ type PostCommitMiddleware func(next PostCommitHandler) PostCommitHandler

+ type PostCommitProvider interface

+ PostCommitMiddleware func() []PostCommitMiddleware

+ type ReadHandler func(ctx context.Context, op ReadOp) error

+ type ReadKind string

+ const ReadKindDir

+ const ReadKindFile

+ const ReadKindStat

+ type ReadMiddleware func(next ReadHandler) ReadHandler

+ type ReadMiddlewareProvider interface

+ ReadMiddleware func() []ReadMiddleware

+ type ReadOp struct

+ Actor Actor

+ Kind ReadKind

+ Path string

+ type RefreshToken struct

+ ChainID string

+ ExpiresAt time.Time

+ Scope string

+ Subject string

+ Token string

+ Used bool

+ type RefreshTokenStore interface

+ Lookup func(token string) (RefreshToken, bool, error)

+ RevokeChain func(chainID string) error

+ Rotate func(oldToken string, newToken RefreshToken) error

+ Save func(rt RefreshToken) error

+ type Runner interface

+ Run func(ctx context.Context, cmd string, env []string) ([]byte, error)

type Server

+ func NewServerWithRootFS(root vfs.FileSystem, opts ...config.Option) (*Server, error)

+ func (s *Server) CommitChangeSet(ctx context.Context, actor Actor, cs vfs.ChangeSet) (WriteResult, error)

+ func (s *Server) CompleteAuthorize(requestID, sub string) (string, bool)

+ func (s *Server) ExchangeAssertion(ctx context.Context, assertion string) (sub, scope string, ttl time.Duration, err error)

+ func (s *Server) IdentityExists(name string) bool

+ func (s *Server) IssueAuthCode(sub, scope string) (string, bool)

+ func (s *Server) RegisterPlugin(p any)

+ type ShellRunner struct

+ func (ShellRunner) Run(ctx context.Context, cmdLine string, env []string) ([]byte, error)

+ type Stream struct

+ func NewStream(opts ...StreamOption) *Stream

+ func (s *Stream) ClientCount() int

+ func (s *Stream) Emit(_ context.Context, e Event) error

+ func (s *Stream) HTTPHandler(filterFromRequest func(*http.Request) EventFilter) http.Handler

+ func (s *Stream) OpenReader(ctx context.Context, filter EventFilter) io.ReadCloser

+ func (s *Stream) Recent(filter EventFilter, n int) []Event

+ func (s *Stream) Subscribe(filter EventFilter) (<-chan Event, func())

+ type StreamOption func(*Stream)

+ func WithClientBuffer(n int) StreamOption

+ func WithRingSize(n int) StreamOption

+ type WriteHandler func(ctx context.Context, op WriteOp) (WriteResult, error)

+ type WriteMiddleware func(next WriteHandler) WriteHandler

+ type WriteMiddlewareProvider interface

+ WriteMiddleware func() []WriteMiddleware

+ type WriteOp struct

+ Actor Actor

+ ChangeSet vfs.ChangeSet

+ type WriteResult struct

+ Hash string

v0.1.0

Jun 24, 2026

Changes in this version

+ var LoadAuthConfig = config.LoadAuthConfig

+ var WithAllowKeyless = config.WithAllowKeyless

+ var WithAllowedPatterns = config.WithAllowedPatterns

+ var WithAuthFile = config.WithAuthFile

+ var WithCAKeysFile = config.WithCAKeysFile

+ var WithConfigFile = config.WithConfigFile

+ var WithDefaultCwd = config.WithDefaultCwd

+ var WithEmbeddedConfig = config.WithEmbeddedConfig

+ var WithHTTPPort = config.WithHTTPPort

+ var WithHostCertFile = config.WithHostCertFile

+ var WithHostKeyPath = config.WithHostKeyPath

+ var WithIgnorePatterns = config.WithIgnorePatterns

+ var WithLogger = config.WithLogger

+ var WithMOTD = config.WithMOTD

+ var WithMOTDFile = config.WithMOTDFile

+ var WithMetricsPort = config.WithMetricsPort

+ var WithPasskeys = config.WithPasskeys

+ var WithPort = config.WithPort

+ var WithSkillsDir = config.WithSkillsDir

+ var WithTLS = config.WithTLS

+ func NewMCPServer(fs bashfs.FileSystem, opts ...MCPOption) *mcp.Server

+ type AuthConfig = config.AuthConfig

+ type AuthIdentity = config.AuthIdentity

+ type DirFS struct

+ func NewDirFS(root string, files config.FilesConfig) *DirFS

+ func (d *DirFS) ReadDir(p string) ([]bashfs.FileInfo, error)

+ func (d *DirFS) ReadFile(p string) ([]byte, error)

+ func (d *DirFS) Stat(p string) (*bashfs.FileInfo, error)

+ func (d *DirFS) WithBus(bus *eventbus.Bus) *DirFS

+ func (d *DirFS) WriteFile(p string, content []byte) error

+ type DocsetSpec = config.DocsetSpec

+ type EmbedFS struct

+ func NewEmbedFS(efs embed.FS, root string, files config.FilesConfig) *EmbedFS

+ func (e *EmbedFS) ReadDir(p string) ([]bashfs.FileInfo, error)

+ func (e *EmbedFS) ReadFile(p string) ([]byte, error)

+ func (e *EmbedFS) Stat(p string) (*bashfs.FileInfo, error)

+ type FSAdapter struct

+ func NewFSAdapter(fsys fs.FS) *FSAdapter

+ func (a *FSAdapter) ReadDir(p string) ([]bashfs.FileInfo, error)

+ func (a *FSAdapter) ReadFile(p string) ([]byte, error)

+ func (a *FSAdapter) Stat(p string) (*bashfs.FileInfo, error)

+ type FileSystem = bashfs.FileSystem

+ type FilesConfig = config.FilesConfig

+ type FolderConfig = config.FolderConfig

+ type Identity struct

+ ConnectedAt time.Time

+ IdentityName string

+ LoreName string

+ PathAccess []config.PathMapping

+ PublicKey ssh.PublicKey

+ PublishDocsets []string

+ RemoteAddr string

+ SessionID string

+ User string

+ type MCPOption func(*mcpConfig)

+ func WithMCPEnvVars(vars map[string]string) MCPOption

+ func WithMCPInstructions(instructions string) MCPOption

+ func WithMCPServerName(name string) MCPOption

+ func WithMCPShellDescription(desc string) MCPOption

+ type MergeFS struct

+ func NewMergeFS() *MergeFS

+ func (m *MergeFS) FilteredView(allowedMounts map[string]bool) *MergeFS

+ func (m *MergeFS) Mount(name string, fs bashfs.FileSystem)

+ func (m *MergeFS) ReadDir(p string) ([]bashfs.FileInfo, error)

+ func (m *MergeFS) ReadFile(p string) ([]byte, error)

+ func (m *MergeFS) SetRoot(fs bashfs.FileSystem)

+ func (m *MergeFS) Stat(p string) (*bashfs.FileInfo, error)

+ type OnConnectFunc func(Identity)

+ type OnDisconnectFunc func(Identity)

+ type Option = config.Option

+ type PasskeysConfig = config.PasskeysConfig

+ type PathMapping = config.PathMapping

+ type SFTPHandler struct

+ func NewSFTPHandler(fs bashfs.FileSystem) *SFTPHandler

+ func (h *SFTPHandler) Filecmd(r *sftp.Request) error

+ func (h *SFTPHandler) Filelist(r *sftp.Request) (sftp.ListerAt, error)

+ func (h *SFTPHandler) Fileread(r *sftp.Request) (io.ReaderAt, error)

+ func (h *SFTPHandler) Filewrite(r *sftp.Request) (io.WriterAt, error)

+ type Server struct

+ func NewServer(rootDir string, opts ...config.Option) (*Server, error)

+ func (s *Server) Config() config.Config

+ func (s *Server) FileSystem() bashfs.FileSystem

+ func (s *Server) ListenAndServe() error

+ func (s *Server) Mount(name string, fs bashfs.FileSystem)

+ func (s *Server) MountFS(name string, fsys fs.FS)

+ func (s *Server) OnConnect(fn OnConnectFunc)

+ func (s *Server) OnDisconnect(fn OnDisconnectFunc)

+ func (s *Server) SetRootBashFS(fsys bashfs.FileSystem)

+ func (s *Server) SetRootFS(fsys fs.FS)

+ func (s *Server) SetSessionFSFn(fn SessionFSFn)

+ func (s *Server) Shutdown(ctx context.Context) error

+ type SessionFSFn func(id Identity, base bashfs.FileSystem) bashfs.FileSystem

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