Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

storage

package

Go to main page

Versions in this module

v0

v0.9.4

Aug 13, 2026

v0.9.3

Jul 24, 2026

Changes in this version

+ const CertsDeviceCaKeyFile

+ const CertsDeviceCaPemFile

+ const CertsRootKeyFile

+ const CertsRootPemFile

+ var ErrUpdateInUse = errors.New("update is referenced by one or more devices")

+ func LoadPemFile[T any](path string, parse func([]byte) (T, error)) (T, error)

+ func PemBytesToObject[T any](pemBytes []byte, parse func([]byte) (T, error)) (T, error)

type CertsFsHandle

+ func (s CertsFsHandle) AssertCleanPki() error

type Update

+ DeviceCount int

v0.9.2

Jul 14, 2026

Changes in this version

+ const AktomlFile

+ const AuditDir

+ const AuthConfigFile

+ const AuthDir

+ const BrandingConfigFile

+ const BrandingDir

+ const CertsCasPemFile

+ const CertsDir

+ const CertsTlsCsrFile

+ const CertsTlsKeyFile

+ const CertsTlsPemFile

+ const ConfigAppliedFile

+ const ConfigSotaOverride

+ const ConfigsDeviceDir

+ const ConfigsDir

+ const ConfigsFactoryDir

+ const ConfigsGroupDir

+ const ConfigsJournalFile

+ const DbFile

+ const DevicesDir

+ const EventsPrefix

+ const HmacFile

+ const HwInfoFile

+ const LogRolloutsFile

+ const NetInfoFile

+ const StatesPrefix

+ const TestArtifactsPrefix

+ const TestsPrefix

+ const TufDir

+ const TufRootFile

+ const TufSnapshotFile

+ const TufTargetsFile

+ const TufTimestampFile

+ const UpdatesAppsDir

+ const UpdatesDir

+ const UpdatesLogsDir

+ const UpdatesOstreeDir

+ const UpdatesRolloutsDir

+ const UpdatesTufDir

+ var ErrDbConstraintUnique = sqllite.ErrConstraintUnique

+ var ErrInvalidUpdate = errors.New("invalid update archive")

+ var ErrTufAlreadyInitialized = errors.New("TUF is already initialized")

+ var ErrTufNotInitialized = errors.New("TUF is not initialized")

+ var TestIdRegex = regexp.MustCompile(`^[A-Za-z0-9\-\_]{15,48}$`)

+ var ValidCorrelationId = regexp.MustCompile(`^[a-zA-Z0-9_\-]+$`).MatchString

+ func AbsPathNoEscape(root, path string) (absPath string, err error)

+ func IsDbError(err error, code sqllite.ErrNoExtended) bool

+ type AppliedConfigs struct

+ AppliedAt int64

+ AuditTrail [3]struct{ ... }

+ Files map[string]ConfigFile

+ type AppsStates struct

+ Apps map[string]struct{ ... }

+ DeviceTime string

+ Ostree string

+ type AuditLogsFsHandle struct

+ func (h AuditLogsFsHandle) AppendEvent(userid int64, event string)

+ func (h AuditLogsFsHandle) ReadEvents(userid int64) (string, error)

+ type AuthConfig struct

+ Config json.RawMessage

+ NewUserDefaultScopes []string

+ RateLimits RateLimitConfig

+ SessionTimeoutHours int

+ Type string

+ type AuthFsHandle struct

+ func (h AuthFsHandle) GetAuthConfig() (*AuthConfig, error)

+ func (h AuthFsHandle) GetHmacSecret() ([]byte, error)

+ func (h AuthFsHandle) InitHmacSecret() error

+ func (h AuthFsHandle) SaveAuthConfig(cfg AuthConfig) error

+ type CertsFsHandle struct

+ func (s CertsFsHandle) AssertCleanTls() error

+ func (s CertsFsHandle) FilePath(name string) string

+ func (s CertsFsHandle) ReadFile(name string) ([]byte, error)

+ func (s CertsFsHandle) WriteFile(name string, content []byte) error

+ type ConfigFile struct

+ OnChanged []string

+ Unencrypted bool

+ Value string

+ type ConfigFileSet struct

+ CreatedAt int64

+ CreatedBy string

+ Files map[string]ConfigFile

+ RawFiles string

+ Reason string

+ type ConfigsFsHandle struct

+ func (s ConfigsFsHandle) PurgeDeviceConfigHistory(uuid string, keepLatest int) error

+ func (s ConfigsFsHandle) PurgeFactoryConfigHistory(keepLatest int) error

+ func (s ConfigsFsHandle) PurgeGroupConfigHistory(name string, keepLatest int) error

+ func (s ConfigsFsHandle) ReadDeviceConfigHistory(uuid string, latest int, withFiles bool) (history []*ConfigFileSet, err error)

+ func (s ConfigsFsHandle) ReadFactoryConfigHistory(latest int, withFiles bool) (history []*ConfigFileSet, err error)

+ func (s ConfigsFsHandle) ReadGroupConfigHistory(name string, latest int, withFiles bool) (history []*ConfigFileSet, err error)

+ func (s ConfigsFsHandle) ReadGroupNames() ([]string, error)

+ func (s ConfigsFsHandle) SaveUpload(payload io.Reader, onCleanupFailure func(error)) error

+ func (s ConfigsFsHandle) WriteDeviceConfig(uuid, content, username, reason string) error

+ func (s ConfigsFsHandle) WriteFactoryConfig(content, username, reason string) error

+ func (s ConfigsFsHandle) WriteGroupConfig(name, content, username, reason string) error

+ type DbHandle struct

+ func NewDb(dbfile string) (*DbHandle, error)

+ func (d DbHandle) Close() error

+ func (d DbHandle) InitStmt(stmt ...DbStmtInit) (err error)

+ func (d DbHandle) Prepare(name, query string) (stmt *sql.Stmt, err error)

+ type DbStmt struct

+ Stmt *sql.Stmt

+ type DbStmtInit interface

+ Init func(db DbHandle) error

+ type DeviceEvent struct

+ CorrelationId string

+ Details string

+ Ecu string

+ Success *bool

+ TargetName string

+ Version string

+ type DeviceEventType struct

+ Id string

+ Version int

+ type DeviceStatus struct

+ CorrelationId string

+ DeviceTime string

+ Status string

+ TargetName string

+ Uuid string

+ type DeviceUpdateEvent struct

+ DeviceTime string

+ Event DeviceEvent

+ EventType DeviceEventType

+ Id string

+ func (e DeviceUpdateEvent) ParseStatus() DeviceStatus

+ type DevicesFsHandle struct

+ func (s DevicesFsHandle) AppendFile(uuid, name, content string) error

+ func (s DevicesFsHandle) Delete(uuid string) error

+ func (s DevicesFsHandle) ListFiles(uuid, prefix string, sortByModTime bool) ([]string, error)

+ func (s DevicesFsHandle) ReadFile(uuid, name string) (string, error)

+ func (s DevicesFsHandle) ReadFileStream(uuid string, name string) (io.ReadCloser, error)

+ func (s DevicesFsHandle) RolloverFiles(uuid, prefix string, max int) error

+ func (s DevicesFsHandle) WriteFile(uuid, name, content string) error

+ func (s DevicesFsHandle) WriteFileStream(uuid, name string, src io.Reader) error

+ type DoneChan = <-chan struct

+ type ErrConfigUploadBroken struct

+ ConfigsPath string

+ UploadPath string

+ func (e ErrConfigUploadBroken) Error() string

+ type FsConfig string

+ func (c FsConfig) AuditDir() string

+ func (c FsConfig) AuthDir() string

+ func (c FsConfig) BrandingDir() string

+ func (c FsConfig) CertsDir() string

+ func (c FsConfig) ConfigsDir() string

+ func (c FsConfig) DbFile() string

+ func (c FsConfig) DevicesDir() string

+ func (c FsConfig) ReadBrandingConfig() ([]byte, error)

+ func (c FsConfig) RootDir() string

+ func (c FsConfig) TufDir() string

+ func (c FsConfig) UpdatesDir() string

+ type FsHandle struct

+ Audit AuditLogsFsHandle

+ Auth AuthFsHandle

+ Certs CertsFsHandle

+ Config FsConfig

+ Configs ConfigsFsHandle

+ Devices DevicesFsHandle

+ Tuf TufFsHandle

+ Updates updatesFsHandleWrap

+ func NewFs(root string) (*FsHandle, error)

+ type RateLimitConfig struct

+ AttemptsBlockDurationSec int

+ AttemptsPerSecond int

+ BadAuthBlockDurationSec int

+ BadAuthLimit int

+ type RolloutsFsHandle struct

+ func (s RolloutsFsHandle) AppendJournal(content string) error

+ func (s RolloutsFsHandle) ListFiles(tag, update string) ([]string, error)

+ func (s RolloutsFsHandle) ReadJournal() iter.Seq2[string, error]

+ func (s RolloutsFsHandle) RolloverJournal() (err error)

+ type TarHeader = tar.Header

+ type TarUnpackOption func(tarUnpackConfig) tarUnpackConfig

+ func TarUnpackCreateDest(val bool) TarUnpackOption

+ func TarUnpackDirAccess(mode os.FileMode) TarUnpackOption

+ func TarUnpackFileAccess(mode os.FileMode) TarUnpackOption

+ func TarUnpackMergeDest(val bool) TarUnpackOption

+ func TarUnpackOnEvents(val tarUnpackEvents) TarUnpackOption

+ func TarUnpackReplaceDest(val bool) TarUnpackOption

+ func TarUnpackUseTmpDir(val string) TarUnpackOption

+ func TarUnpackUseTmpFile(val string) TarUnpackOption

+ type TargetTest struct

+ Artifacts []string

+ CompletedOn *int64

+ CreatedOn int64

+ Details string

+ Name string

+ Results []TargetTestResult

+ Status string

+ TargetName string

+ Uuid string

+ type TargetTestResult struct

+ Details string

+ LocalTs float64

+ Metrics map[string]float64

+ Name string

+ Status string

+ type TufFsHandle struct

+ RootExpiration time.Duration

+ TargetsExpiration time.Duration

+ TimestampExpiration time.Duration

+ func (h *TufFsHandle) LoadTuf() error

+ func (h TufFsHandle) Enabled() bool

+ func (h TufFsHandle) GetRoots() ([]tuf.AtsTufRoot, error)

+ func (h TufFsHandle) ImportTuf(rootJSONs [][]byte, candidateKeys []tuf.AtsKey) error

+ func (h TufFsHandle) InitTuf() error

+ func (h TufFsHandle) ReadRoot(version int) ([]byte, error)

+ func (h TufFsHandle) ReadTufMeta(tag, update, name string, v any) error

+ func (h TufFsHandle) Sign(role tuf.RoleName, v any) (tuf.Signature, error)

+ func (h TufFsHandle) WriteMeta(tufDir string, targets, snapshot, timestamp []byte) error

+ func (h TufFsHandle) WriteTimestamp(tag, update string, ts []byte) error

+ type Update struct

+ Name string

+ UploadedAt int64

+ UploadedBy string

+ type UpdatesFsHandle struct

+ func (s UpdatesFsHandle) AppendFile(tag, update, name, content string) error

+ func (s UpdatesFsHandle) FilePath(tag, update, name string) string

+ func (s UpdatesFsHandle) LatestRootMetaName(tag, update string) (string, error)

+ func (s UpdatesFsHandle) ReadFile(tag, update, name string) (string, error)

+ func (s UpdatesFsHandle) TailFileLines(tag, update, name string, stop DoneChan) iter.Seq2[string, error]

+ func (s UpdatesFsHandle) WriteFile(tag, update, name, content string) error