storage

Documentation

Index

• type AESConfig
• type Chest
  • func New(cfg Config) (Chest, error)
  • func NewEncrypted(underlying Chest, crypt *cryptfs.FS) Chest
  • func NewFilesystem(root string) (Chest, error)
• type Config
• type EncryptionConfig
• type File
• type FileStat
• type FilesystemConfig

Types

type AESConfig

type AESConfig struct {
	Base64Key string
}

type Chest

type Chest interface {
	Open(path string) (fs.File, error)
	Glob(pattern string) ([]FileStat, error)
	ReadDir(name string) ([]fs.DirEntry, error)

	ReplaceFile(oldpath, newpath string) error
	ReplaceDir(oldpath, newpath string) error

	MkdirAll(path string) error
	RmdirAll(path string) error

	WriteFile(path string, contents []byte) error
}

func New

func New(cfg Config) (Chest, error)

New returns a Chest given the configuration provided. It can also wrap that Chest in an encryption routine on each operation.

func NewEncrypted

func NewEncrypted(underlying Chest, crypt *cryptfs.FS) Chest

func NewFilesystem

func NewFilesystem(root string) (Chest, error)

type Config

type Config struct {
	Filesystem FilesystemConfig
	Encryption EncryptionConfig
}

type EncryptionConfig

type EncryptionConfig struct {
	AES      *AESConfig
	Encoding string
}

type File

type File interface {
	Filename() string
	FullPath() string

	Stat() (fs.FileInfo, error)
	Read([]byte) (int, error)
	Close() error
}

type FileStat

type FileStat struct {
	RelativePath string
	ModTime      time.Time
}

type FilesystemConfig

type FilesystemConfig struct {
	Directory string
}