enpass

Documentation

Index

• type Card
  • func (c *Card) Decrypt() (string, error)
  • func (c *Card) IsDeleted() bool
  • func (c *Card) IsTrashed() bool
• type Keyfile
• type Vault
  • func NewVault(vaultPath string, logLevel logrus.Level) (*Vault, error)
  • func (v *Vault) Close()
  • func (v *Vault) GetEntries(cardType string, filters []string) ([]Card, error)
  • func (v *Vault) GetEntry(cardType string, filters []string, unique bool) (*Card, error)
  • func (v *Vault) Open(credentials *VaultCredentials) error
• type VaultCredentials
  • func (credentials *VaultCredentials) IsComplete() bool
• type VaultInfo

Types

type Card

type Card struct {
	// plaintext
	UUID      string
	CreatedAt int64
	Type      string
	UpdatedAt int64
	Title     string
	Subtitle  string
	Note      string
	Trashed   int64
	Deleted   int64
	Category  string
	Label     string
	LastUsed  int64
	Sensitive bool
	Icon      string
	RawValue  string
	// contains filtered or unexported fields
}

func (*Card) Decrypt

func (c *Card) Decrypt() (string, error)

func (*Card) IsDeleted

func (c *Card) IsDeleted() bool

func (*Card) IsTrashed

func (c *Card) IsTrashed() bool

type Keyfile

type Keyfile struct {
	Key string `xml:",innerxml"`
}

type Vault

type Vault struct {

	// settings for filtering entries
	FilterFields []string
	FilterAnd    bool
	// contains filtered or unexported fields
}

Vault : vault is the container object for vault-related operations

func NewVault

func NewVault(vaultPath string, logLevel logrus.Level) (*Vault, error)

NewVault : Create new instance of vault and load vault info

func (*Vault) Close

func (v *Vault) Close()

Close : close the connection to the underlying database. Always call this in the end.

func (*Vault) GetEntries

func (v *Vault) GetEntries(cardType string, filters []string) ([]Card, error)

GetEntries : return the cardType entries in the Enpass database filtered by filters.

func (*Vault) GetEntry

func (v *Vault) GetEntry(cardType string, filters []string, unique bool) (*Card, error)

func (*Vault) Open

func (v *Vault) Open(credentials *VaultCredentials) error

Open : setup a connection to the Enpass database. Call this before doing anything.

type VaultCredentials

type VaultCredentials struct {
	KeyfilePath string
	Password    string
	DBKey       []byte
}

func (*VaultCredentials) IsComplete

func (credentials *VaultCredentials) IsComplete() bool

type VaultInfo

type VaultInfo struct {
	EncryptionAlgo string `json:"encryption_algo"`
	HasKeyfile     int    `json:"have_keyfile"`
	KDFAlgo        string `json:"kdf_algo"`
	KDFIterations  int    `json:"kdf_iter"`
	VaultNumItems  int    `json:"vault_items_count"`
	VaultName      string `json:"vault_name"`
	VaultVersion   int    `json:"version"`
}