content

Documentation

Index

• func IsKeyLoadError(err error) bool
• func IsManifestLoadError(err error) bool
• func MakeDatafilePath(ctx Context, filemeta Filemeta) string
• type Context
  • func FromPath(path string) (Context, error)
  • func (c Context) ImportManifest() (Manifest, error)
  • func (c Context) ProjRelPath(absPath string) string
  • func (c Context) RelPath(absPath string) string
• type Datafile
  • func NewDatafile(ctx Context, absPath string) (Datafile, error)
  • func ReadDatafile(ctx Context, filemeta Filemeta) (Datafile, error)
  • func (d Datafile) DecodeData() ([]byte, error)
  • func (d Datafile) Equal(other Datafile) bool
  • func (d Datafile) Id() []byte
  • func (d Datafile) MatchesCurrent(filemeta Filemeta) bool
  • func (d Datafile) Path() string
  • func (d Datafile) Perm() int
  • func (d Datafile) Serialize() []byte
  • func (d Datafile) Write(filemeta Filemeta)
• type Filemeta
  • func NewFilemeta(absPath string, datafile Datafile) Filemeta
  • func (f Filemeta) IdString() string
  • func (f Filemeta) String() string
• type KeyLoadError
  • func (err *KeyLoadError) Error() string
• type LgConfig
  • func NewLgConfig() LgConfig
  • func ReadConfig(ctx Context) (LgConfig, error)
  • func (c *LgConfig) AddPattern(pattern string) bool
  • func (c LgConfig) FindPattern(path string) int
  • func (c *LgConfig) RemovePattern(pattern string) bool
  • func (config LgConfig) Write(path string)
• type Manifest
  • func ImportManifest(ctx Context) (Manifest, error)
  • func (m *Manifest) Add(filemeta Filemeta)
  • func (m Manifest) Export()
  • func (m Manifest) Find(projRelPath string) int
• type ManifestLoadError
  • func (err *ManifestLoadError) Error() string

Functions

func IsKeyLoadError

func IsKeyLoadError(err error) bool

func IsManifestLoadError

func IsManifestLoadError(err error) bool

func MakeDatafilePath

func MakeDatafilePath(ctx Context, filemeta Filemeta) string

Types

type Context

type Context struct {
	WorkingPath string   // working dir
	ProjectPath string   // path of the parent for .lockgit
	LockgitPath string   // path to .lockgit
	DataPath    string   // path to .lockgit/data
	ConfigPath  string   // path to .lockgit/data/lgconfig
	Config      LgConfig // Config data

	Key []byte // key bytes loaded from lgconfig (if key is present)
}

func FromPath

func FromPath(path string) (Context, error)

Return a Context provided a base to begin traversal from. The context will be from the first .lockgit directory found

func (Context) ImportManifest

func (c Context) ImportManifest() (Manifest, error)

func (Context) ProjRelPath

func (c Context) ProjRelPath(absPath string) string

func (Context) RelPath

func (c Context) RelPath(absPath string) string

type Datafile

type Datafile struct {
	// contains filtered or unexported fields
}

func NewDatafile

func NewDatafile(ctx Context, absPath string) (Datafile, error)

func ReadDatafile

func ReadDatafile(ctx Context, filemeta Filemeta) (Datafile, error)

func (Datafile) DecodeData

func (d Datafile) DecodeData() ([]byte, error)

func (Datafile) Equal

func (d Datafile) Equal(other Datafile) bool

func (Datafile) Id

func (d Datafile) Id() []byte

func (Datafile) MatchesCurrent

func (d Datafile) MatchesCurrent(filemeta Filemeta) bool

Tests if a potential Datafile update matches the one already in the vault

func (Datafile) Path

func (d Datafile) Path() string

func (Datafile) Perm

func (d Datafile) Perm() int

func (Datafile) Serialize

func (d Datafile) Serialize() []byte

func (Datafile) Write

func (d Datafile) Write(filemeta Filemeta)

type Filemeta

type Filemeta struct {
	AbsPath string
	RelPath string
	Id      []byte
}

Meta data about a secret

func NewFilemeta

func NewFilemeta(absPath string, datafile Datafile) Filemeta

func (Filemeta) IdString

func (f Filemeta) IdString() string

func (Filemeta) String

func (f Filemeta) String() string

type KeyLoadError

type KeyLoadError struct {
	// contains filtered or unexported fields
}

func (*KeyLoadError) Error

func (err *KeyLoadError) Error() string

type LgConfig

type LgConfig struct {
	Ver      int
	Id       string
	Patterns []string
}

func NewLgConfig

func NewLgConfig() LgConfig

func ReadConfig

func ReadConfig(ctx Context) (LgConfig, error)

func (*LgConfig) AddPattern

func (c *LgConfig) AddPattern(pattern string) bool

func (LgConfig) FindPattern

func (c LgConfig) FindPattern(path string) int

func (*LgConfig) RemovePattern

func (c *LgConfig) RemovePattern(pattern string) bool

func (LgConfig) Write

func (config LgConfig) Write(path string)

type Manifest

type Manifest struct {
	Files []Filemeta
	// contains filtered or unexported fields
}

func ImportManifest

func ImportManifest(ctx Context) (Manifest, error)

func (*Manifest) Add

func (m *Manifest) Add(filemeta Filemeta)

func (Manifest) Export

func (m Manifest) Export()

func (Manifest) Find

func (m Manifest) Find(projRelPath string) int

type ManifestLoadError

type ManifestLoadError struct {
	// contains filtered or unexported fields
}

func (*ManifestLoadError) Error

func (err *ManifestLoadError) Error() string