plugin

package

Go to main page

Versions in this module

v0

v0.56.0

Oct 11, 2026

Changes in this version

+ var LegacySignatureWindow = compat.Get("storage-build-signature-sha256")

+ func LegacySignatureLog() string

v0.55.0

Oct 9, 2026

Changes in this version

+ const BuildPayloadV1

+ const CheckConformanceFailed

+ const CheckDescribeInvalid

+ const CheckHandshake

+ const CheckNoSelfTest

+ const CheckRefused

+ const CheckStartFailed

+ const CheckTimeout

+ const StateHeld

+ var ErrFeedChanged = errors.New("the feed is not the one the store reviewed")

+ var ErrStoreBuild = errors.New("a store signed this build and does not vouch for it here")

+ type BuildClaim struct

+ Name string

+ Platform string

+ SHA256 string

+ Version string

+ func (c BuildClaim) Normal() BuildClaim

+ func (c BuildClaim) Payload() []byte

+ type BuildGate func(ctx context.Context, via string, c BuildClaim, key ed25519.PublicKey, ...) error

+ type BuildSignature struct

+ Key ed25519.PublicKey

+ Legacy bool

+ func VerifyBuild(trusted []ed25519.PublicKey, c BuildClaim, signature string) (BuildSignature, error)

+ type CheckOptions struct

+ Binary string

+ Log *slog.Logger

+ Name string

+ Tune func(cmd *exec.Cmd)

+ UpTimeout time.Duration

+ WorkDir string

+ type CheckResult struct

+ Code string

+ Conformance *Report

+ Describe *DescribeResponse

+ Message string

+ OK bool

+ func CheckBinary(ctx context.Context, o CheckOptions) *CheckResult

type Manager

+ func (m *Manager) ByName(ctx context.Context, name string) (*Status, error)

+ func (m *Manager) InstallBinaryVersion(ctx context.Context, name, filename string, r io.Reader, ...) (*Status, error)

+ func (m *Manager) InstallBuild(ctx context.Context, name, source string, b FeedBinary, from StoreLink, ...) (*Status, error)

+ func (m *Manager) InstallFromURLVersion(ctx context.Context, name, rawURL, sha, signature, version string) (*Status, error)

+ func (m *Manager) JudgeRange(rng string) (ok bool, requires, filex string, err error)

+ func (m *Manager) Platform() string

+ func (m *Manager) ReadPinnedFeed(ctx context.Context, addr, sha string) (*Feed, error)

+ func (m *Manager) SetBuildGate(g BuildGate)

+ func (m *Manager) SetLicenseHold(name, reason string)

+ func (m *Manager) SignatureVerifies(ctx context.Context, name string, b FeedBinary, from StoreLink, sigs []string) (required, verifies bool)

+ func (m *Manager) StoreSignature(ctx context.Context, name string, b FeedBinary, from StoreLink, sigs []string) (required bool, err error)

+ func (m *Manager) UpgradeBuild(ctx context.Context, id int64, b FeedBinary, from StoreLink, sigs []string) (*Status, error)

+ func (m *Manager) UpgradeVersion(ctx context.Context, id int64, filename string, r io.Reader, ...) (*Status, error)

type Process

+ Tune func(cmd *exec.Cmd)

type Status

+ LegacySignature bool

+ type StoreLink struct

+ Store string

+ Version string

v0.54.0

Oct 8, 2026

v0.53.0

Oct 7, 2026

v0.52.0

Oct 5, 2026

v0.51.0

Oct 4, 2026

v0.50.0

Oct 3, 2026

Changes in this version

type Manager

+ func (m *Manager) LogFor(driver string) *pluginlog.Log

+ func (m *Manager) Logs(ctx context.Context, id, after int64) ([]pluginlog.Line, int64, error)

+ func (m *Manager) MaxBinaryBytes() int64

type Options

+ LoopbackSources bool

type Process

+ Prepare func() (exe string, done func(), err error)

v0.49.0

Sep 29, 2026

Changes in this version

+ var ErrSHA256Mismatch = errors.New("sha256 mismatch")

+ var ErrSourceChanged = errors.New("the source now publishes a different build than the one that was approved")

type Manager

+ func (m *Manager) HashURL(ctx context.Context, rawURL string) (string, int64, error)

+ func (m *Manager) InstallFromSourcePinned(ctx context.Context, name, source, wantSHA string) (*Status, error)

+ func (m *Manager) ResolveSource(ctx context.Context, source string) (*SourceBuild, error)

+ func (m *Manager) ResolveUpdate(ctx context.Context, id int64) (*SourceBuild, *model.Plugin, error)

+ func (m *Manager) UpgradeFromSourcePinned(ctx context.Context, id int64, wantSHA string) (*Status, error)

+ type SourceBuild struct

+ Binary FeedBinary

+ Feed *Feed

+ Platform string

v0.48.1

Sep 28, 2026

v0.48.0

Sep 28, 2026

Changes in this version

+ const FeedFileName

+ const UpdateAvailable

+ const UpdateCheckFailed

+ const UpdateCurrent

+ const UpdateIncompatible

+ func FeedURL(source string) (string, error)

+ type Feed struct

+ Binaries map[string]FeedBinary

+ Filex string

+ Name string

+ Notes string

+ Version string

+ type FeedBinary struct

+ SHA256 string

+ Signature string

+ URL string

type Manager

+ func (m *Manager) BackgroundUpdates() bool

+ func (m *Manager) CheckUpdates(ctx context.Context) (*UpdateReport, error)

+ func (m *Manager) InstallFromSource(ctx context.Context, name, source string) (*Status, error)

+ func (m *Manager) LastUpdateCheck(ctx context.Context) time.Time

+ func (m *Manager) SetSource(ctx context.Context, id int64, source string) (*Status, error)

+ func (m *Manager) SetUpdateHooks(h UpdateHooks)

+ func (m *Manager) StartUpdater(ctx context.Context, enabled bool)

+ func (m *Manager) UpgradeFromSource(ctx context.Context, id int64) (*Status, error)

type Options

+ Platform string

type Status

+ Update *UpdateInfo

+ type UpdateHooks struct

+ Announce func(ctx context.Context, name, version, notes string)

+ Range func(rng string) (ok bool, requires, filex string, err error)

+ type UpdateInfo struct

+ Announced string

+ CheckedAt *time.Time

+ Error string

+ Notes string

+ Platform string

+ Requires string

+ SHA256 string

+ Status string

+ Version string

+ type UpdateReport struct

+ Available []string

+ Checked int

+ CheckedAt time.Time

+ Failed []string

v0.47.0

Sep 26, 2026

v0.46.1

Sep 26, 2026

v0.46.0

Sep 26, 2026

v0.45.1

Sep 25, 2026

v0.45.0

Sep 25, 2026

v0.44.2

Sep 25, 2026

v0.43.0

Sep 24, 2026

Changes in this version

+ const ConformanceEnforce

+ const ConformanceOff

+ const ConformanceTimeout

+ const ConformanceWarn

+ const DefaultMaxInFlight

+ const DefaultOpTimeout

+ const DriverPrefix

+ const ErrCodeInvalid

+ const ErrCodeNoInstance

+ const ErrCodeNotFound

+ const ErrCodeReadOnly

+ const ErrCodeUnsupported

+ const HandshakePrefix

+ const ProbeFail

+ const ProbePass

+ const ProbeSkip

+ const ProtocolVersion

+ const SizeHeader

+ const StateDisabled

+ const StateFailed

+ const StateRefused

+ const StateRunning

+ const StateStarting

+ var ErrBadName = errors.New("plugin name must match [a-z0-9][a-z0-9_-]{0,31}")

+ var ErrBusy = errors.New("plugin is at its concurrency limit")

+ var ErrGaveUp = errors.New("plugin failed to start 10 times in a row; not restarting until Restart")

+ var ErrHandshake = errors.New("plugin did not print its handshake line")

+ var ErrRefused = errors.New("plugin refused by host")

+ var ErrSignatureInvalid = errors.New("signature invalid")

+ var ErrSignatureRequired = errors.New("signature required")

+ var ErrStopped = errors.New("plugin stopped")

+ func NewDriver(h Handle, caps Capabilities) storage.Driver

+ func ParsePublicKey(k string) (ed25519.PublicKey, error)

+ func ParsePublicKeys(keys []string) ([]ed25519.PublicKey, error)

+ func ValidName(s string) bool

+ func ValidateDescribe(d *DescribeResponse) error

+ func VerifyDetached(trusted []ed25519.PublicKey, sha, signature string) error

+ type Address struct

+ Network string

+ Target string

+ URL string

+ func ParseAddress(s string) (Address, error)

+ type Capabilities struct

+ Copy bool

+ Delete bool

+ Mkdir bool

+ Move bool

+ Multipart bool

+ Presign bool

+ Range bool

+ SetMtime bool

+ Watch bool

+ Write bool

+ func (c Capabilities) Writable() bool

+ type Client struct

+ func NewClient(addr Address, token string) *Client

+ func (c *Client) AbortMultipart(ctx context.Context, id, path, uploadID string) error

+ func (c *Client) Close()

+ func (c *Client) CompleteMultipart(ctx context.Context, id, path, uploadID string, parts []MultipartPart) error

+ func (c *Client) Copy(ctx context.Context, id, src, dst string) error

+ func (c *Client) CreateInstance(ctx context.Context, cfg map[string]any) (string, error)

+ func (c *Client) Delete(ctx context.Context, id, path string) error

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

+ func (c *Client) Describe(ctx context.Context) (*DescribeResponse, error)

+ func (c *Client) InitMultipart(ctx context.Context, id, path string, totalSize int64, partCount int) (MultipartInitResponse, error)

+ func (c *Client) List(ctx context.Context, id, path string) ([]Object, error)

+ func (c *Client) Mkdir(ctx context.Context, id, path string) error

+ func (c *Client) Move(ctx context.Context, id, src, dst string) error

+ func (c *Client) PresignDownload(ctx context.Context, id, path string, ttl time.Duration) (PresignResponse, error)

+ func (c *Client) PresignUpload(ctx context.Context, id, path string, size int64) (PresignResponse, error)

+ func (c *Client) Read(ctx context.Context, id, path string, off, length int64) (io.ReadCloser, error)

+ func (c *Client) SelfTest(ctx context.Context) (string, error)

+ func (c *Client) SetMtime(ctx context.Context, id, path string, t time.Time) error

+ func (c *Client) Stat(ctx context.Context, id, path string) (Object, error)

+ func (c *Client) UploadPart(ctx context.Context, id, path, uploadID string, part int, r io.Reader, ...) (string, error)

+ func (c *Client) Watch(ctx context.Context, id string) (<-chan Event, error)

+ func (c *Client) Write(ctx context.Context, id, path string, r io.Reader, size int64) error

+ type DescribeResponse struct

+ Capabilities Capabilities

+ Fields []storage.Field

+ Label string

+ Name string

+ Protocol int

+ Version string

+ type ErrorResponse struct

+ Error string

+ Message string

+ type Event struct

+ From string

+ Op string

+ Path string

+ type Handle interface

+ Client func() (*Client, error)

+ DriverName func() string

+ type InstanceRequest struct

+ Config map[string]any

+ type InstanceResponse struct

+ Instance string

+ type ListResponse struct

+ Objects []Object

+ type Manager struct

+ func New(o Options) (*Manager, error)

+ func (m *Manager) CapabilitiesFor(driver string) (Capabilities, bool)

+ func (m *Manager) ConformanceMode() string

+ func (m *Manager) Dir() string

+ func (m *Manager) Get(ctx context.Context, id int64) (*Status, error)

+ func (m *Manager) InstallBinary(ctx context.Context, name, filename string, r io.Reader, signature string) (*Status, error)

+ func (m *Manager) InstallFromURL(ctx context.Context, name, rawURL, sha, signature string) (*Status, error)

+ func (m *Manager) InstallRemote(ctx context.Context, name, address, token string) (*Status, error)

+ func (m *Manager) List(ctx context.Context) ([]*Status, error)

+ func (m *Manager) Load(ctx context.Context) error

+ func (m *Manager) Remove(ctx context.Context, id int64) error

+ func (m *Manager) RequiresSignature() bool

+ func (m *Manager) Restart(ctx context.Context, id int64) (*Status, error)

+ func (m *Manager) SetEnabled(ctx context.Context, id int64, on bool) (*Status, error)

+ func (m *Manager) Shutdown()

+ func (m *Manager) Upgrade(ctx context.Context, id int64, filename string, r io.Reader, signature string) (*Status, error)

+ func (m *Manager) WaitReady(d time.Duration)

+ type MoveRequest struct

+ Dst string

+ Src string

+ type MtimeRequest struct

+ Mtime time.Time

+ Path string

+ type MultipartCompleteRequest struct

+ Parts []MultipartPart

+ Path string

+ UploadID string

+ type MultipartInitRequest struct

+ PartCount int

+ Path string

+ TotalSize int64

+ type MultipartInitResponse struct

+ PartURLs []string

+ UploadID string

+ type MultipartPart struct

+ Etag string

+ PartNumber int

+ type MultipartPartResponse struct

+ Etag string

+ type Object struct

+ Etag string

+ Kind string

+ Metadata map[string]string

+ Mime string

+ Mtime time.Time

+ Name string

+ Path string

+ Size int64

+ type Options struct

+ Conformance string

+ Dir string

+ HTTP *http.Client

+ Log *slog.Logger

+ MaxBinaryBytes int64

+ MaxInFlight int

+ SecretKey string

+ Store db.Store

+ TrustedKeys []string

+ type PathRequest struct

+ Path string

+ type PresignRequest struct

+ Path string

+ Size int64

+ TTLSeconds int64

+ type PresignResponse struct

+ ExpiresAt time.Time

+ Headers map[string]string

+ Method string

+ URL string

+ type ProbeResult struct

+ Detail string

+ Name string

+ Status string

+ Took time.Duration

+ TookMS int64

+ type Process struct

+ Binary string

+ Log *slog.Logger

+ Name string

+ OnDown func(err error)

+ OnUp func(ctx context.Context, c *Client) error

+ SockDir string

+ Token string

+ func (p *Process) Client() *Client

+ func (p *Process) Err() error

+ func (p *Process) Restarts() int

+ func (p *Process) Start(ctx context.Context)

+ func (p *Process) Stop()

+ type RejectedError struct

+ func (e RejectedError) Error() string

+ func (e RejectedError) Unwrap() error

+ type Report struct

+ RanAt time.Time

+ Results []ProbeResult

+ Scratch string

+ Verified bool

+ func RunConformance(ctx context.Context, drv storage.Driver, caps Capabilities, ...) *Report

+ func VerifyStorage(ctx context.Context, drv storage.Driver, caps Capabilities) *Report

+ func (r *Report) FailureError() error

+ func (r *Report) Failures() []ProbeResult

+ func (r *Report) Summary() string

+ type Stats struct

+ InFlight int64

+ Max int

+ Rejected int64

+ Waited int64

+ type Status struct

+ Capabilities *Capabilities

+ Conformance *Report

+ FieldCount int

+ InUse int

+ Label string

+ Load Stats

+ Restarts int

+ State string

+ StateError string

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