keepassxc

Documentation

Index

• Constants
• Variables
• func SocketPath() (string, error)
• type BoolString
  • func (bs *BoolString) UnmarshalJSON(b []byte) error
• type Client
  • func DefaultClient() (*Client, error)
  • func NewClient(socketPath, assoName string, assoKey nacl.Key, options ...ClientOption) *Client
  • func (c *Client) Associate() error
  • func (c *Client) ChangePublicKeys() error
  • func (c *Client) Connect() error
  • func (c *Client) CreateDatabaseGroup(name string) (string, string, error)
  • func (c *Client) Disconnect() error
  • func (c *Client) GeneratePassword() (*Entry, error)
  • func (c *Client) GetAssociatedProfile() (string, string)
  • func (c *Client) GetDatabaseGroups() ([]*DBGroup, error)
  • func (c *Client) GetDatabaseHash() (string, error)
  • func (c *Client) GetLogins(url string) ([]*Entry, error)
  • func (c *Client) GetTOTP(uuid string) (string, error)
  • func (c *Client) LockDatabase() error
  • func (c *Client) SetLogin() error
  • func (c *Client) TestAssociate() error
• type ClientOption
  • func WithApplicationName(name string) ClientOption
• type DBGroup
• type Entries
• type Entry
• type Fields
  • func (f Fields) String() string
• type Message
• type Password
  • func (p Password) Plaintext() string
  • func (p Password) String() string
• type Response

Constants

const APPLICATIONNAME = "keepassxc-go"

const SocketName = "org.keepassxc.KeePassXC.BrowserServer"

Variables

var (
	ErrUnspecifiedSocketPath = errors.New("unspecified socket path")
	ErrInvalidPeerKey        = errors.New("invalid peer key")
	ErrNotImplemented        = errors.New("not implemented yet")
)

var ErrInvalidResponse = errors.New("invalid response does not include entries")

Functions

func SocketPath

func SocketPath() (string, error)

Types

type BoolString

type BoolString bool

func (*BoolString) UnmarshalJSON

func (bs *BoolString) UnmarshalJSON(b []byte) error

type Client

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

func DefaultClient

func DefaultClient() (*Client, error)

func NewClient

func NewClient(socketPath, assoName string, assoKey nacl.Key, options ...ClientOption) *Client

func (*Client) Associate

func (c *Client) Associate() error

func (*Client) ChangePublicKeys

func (c *Client) ChangePublicKeys() error

func (*Client) Connect

func (c *Client) Connect() error

func (*Client) CreateDatabaseGroup

func (c *Client) CreateDatabaseGroup(name string) (string, string, error)

func (*Client) Disconnect

func (c *Client) Disconnect() error

func (*Client) GeneratePassword

func (c *Client) GeneratePassword() (*Entry, error)

func (*Client) GetAssociatedProfile

func (c *Client) GetAssociatedProfile() (string, string)

func (*Client) GetDatabaseGroups

func (c *Client) GetDatabaseGroups() ([]*DBGroup, error)

func (*Client) GetDatabaseHash

func (c *Client) GetDatabaseHash() (string, error)

func (*Client) GetLogins

func (c *Client) GetLogins(url string) ([]*Entry, error)

func (*Client) GetTOTP

func (c *Client) GetTOTP(uuid string) (string, error)

func (*Client) LockDatabase

func (c *Client) LockDatabase() error

func (*Client) SetLogin

func (c *Client) SetLogin() error

func (*Client) TestAssociate

func (c *Client) TestAssociate() error

type ClientOption

type ClientOption func(*Client)

func WithApplicationName

func WithApplicationName(name string) ClientOption

type DBGroup

type DBGroup struct{}

type Entries

type Entries []*Entry

type Entry

type Entry struct {
	Name     string     `json:"name"`
	Login    string     `json:"login"`
	Password Password   `json:"password"`
	Group    string     `json:"group"`
	UUID     string     `json:"uuid"`
	Fields   Fields     `json:"stringFields"`
	Expired  BoolString `json:"expired"`
}

type Fields

type Fields []string

func (Fields) String

func (f Fields) String() string

type Message

type Message map[string]interface{}

type Password

type Password string

func (Password) Plaintext

func (p Password) Plaintext() string

func (Password) String

func (p Password) String() string

type Response

type Response map[string]interface{}