tobischo/ gokeepasslib

(v3.0.3) 10 months ago

Need help with gokeepasslib?

Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

tobischo

139 Stars

20 Forks

MIT License

326 Commits

0 Opened issues

Description

A library to read and write keepass 2 files written in go

Services available

Need anything else?

Contributors list

Readme

gokeepasslib

Name: gokeepasslib
Brand: gokeepasslib
SKU: //tobischo/gokeepasslib
Rating: 2.0975 (139 reviews)

gokeepasslib is a library which allows reading Keepass 2 files (kdbx).

Note: only Keepass v2.30 or higher is properly supported since earlier versions do not allow empty XML tags but expected self-closing tags (which is valid XML but not really supported by Golang on XML marshaling) Basically: this lib can probably read most Keepass2 files, but only Keepass v2.30 can be expected to read files created in this lib.

Installing

Use

go get

to retrieve the latest version:

go get -u github.com/tobischo/gokeepasslib

Include it in an application (modulized):

import "github.com/tobischo/gokeepasslib/v3"

For non-modulized applications use:

import "github.com/tobischo/gokeepasslib"

Note that this may cause breaking changes when updating from a previous version.

Example: reading a file

package main

import (
    "fmt"
    "github.com/tobischo/gokeepasslib/v3"
    "os"
)
func main() {
    file, _ := os.Open("examples/example.kdbx")
db := gokeepasslib.NewDatabase()
db.Credentials = gokeepasslib.NewPasswordCredentials("abcdefg12345678")
_ = gokeepasslib.NewDecoder(file).Decode(db)

db.UnlockProtectedEntries()

entry := db.Content.Root.Groups[0].Groups[0].Entries[0]
fmt.Println(entry.GetTitle())
fmt.Println(entry.GetPassword())
}

Note the

db.UnlockProtectedEntries()

call: you have to unlock protected entries before using the database and call

db.LockProtectedEntries()

before saving it to ensure that the passwords are not stored in plaintext in the xml. In kdbx files, which are encrypted using the file credentials, fields are protected with another stream cipher.

Example: writing a file

See examples/example-writing.go

Example: deleting a file

See examples/example-deleting.go

TODO

Improve code readability
Write more tests