gokeepasslib

https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3
Admin
gokeepasslib is a Go library for reading and writing KeePass 2 (KDBX) password database files with...
Tokens:14,863
Snippets:154
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install gokeepasslib

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Use the go get command to retrieve the latest version of the library.

```bash
go get -u github.com/tobischo/gokeepasslib/v3@latest
```

--------------------------------

### Get Binary Content as String

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Returns the content of a binary as a string. Added in v3.2.3.

```go
func (b Binary) GetContentString() (string, error)
```

--------------------------------

### Get Binary Content as Bytes

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Returns the content of a binary as a byte slice. Added in v3.2.3.

```go
func (b Binary) GetContentBytes() ([]byte, error)
```

--------------------------------

### Get Binary Content as String (Deprecated)

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Returns the plaintext content of a binary as a string. This function is deprecated; use GetContentString() instead.

```go
func (b Binary) GetContent() (string, error)
```

--------------------------------

### Get VariantDictionaryItem by Key

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Retrieves a VariantDictionaryItem using its key. This method is part of the VariantDictionary type.

```go
func (vd *VariantDictionary) Get(key string) *VariantDictionaryItem
```

--------------------------------

### Get EncrypterManager

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Retrieves an `EncrypterManager` based on the provided transformed master key and Encryption IV. Returns an error if the encryption type is unsupported.

```go
func (db *Database) GetEncrypterManager(transformedKey []byte) (*EncrypterManager, error)
```

--------------------------------

### Get HMAC-Sha256 of DBHeader

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Calculates and returns the HMAC-Sha256 hash of the database header using the provided HMAC key. Essential for verifying data integrity.

```go
func (h *DBHeader) GetHmacSha256(hmacKey []byte) [32]byte
```

--------------------------------

### Get StreamManager

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Obtains a `StreamManager` based on the database headers. This manager can be used for selective entry locking. Returns an error if the stream type is unsupported.

```go
func (db *Database) GetStreamManager() (*StreamManager, error)
```

--------------------------------

### Get Sha256 of DBHeader

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Retrieves the Sha256 hash of the database header. This is a fundamental hash used for integrity checks.

```go
func (h *DBHeader) GetSha256() [32]byte
```

--------------------------------

### Create a new Database

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Creates a new Database instance with default settings for KDBX version 3.1. Accepts optional `DatabaseOption` arguments to customize settings. For a completely uninitialized database, use `gokeepasslib.Database{}`.

```go
func NewDatabase(options ...DatabaseOption) *Database
```

--------------------------------

### Create DBCredentials from Key File Path

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Builds new database credentials using a key file located at the specified path. Requires the file path as input.

```go
func NewKeyCredentials(location string) (*DBCredentials, error)
```

--------------------------------

### Create DBCredentials with Password and Key File Path

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Builds new database credentials using both a password and a key file specified by its path. Combines password authentication with key file security.

```go
func NewPasswordAndKeyCredentials(password, location string) (*DBCredentials, error)
```

--------------------------------

### Import gokeepasslib

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Include the package in your Go source files.

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

--------------------------------

### Create Binary Reference

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Creates a BinaryReference with the same ID as the Binary and a specified filename.

```go
func (b Binary) CreateReference(f string) BinaryReference
```

--------------------------------

### Binary Format Options

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Options for configuring binary format versions when adding to a database.

```go
func WithKDBXv4Binary(binary *Binary)
```

```go
func WithKDBXv31Binary(binary *Binary)
```

--------------------------------

### Create DBCredentials with Password and Key File Data

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Builds new database credentials using a password and the byte data of a key file. Suitable for scenarios where the key file content is available as bytes.

```go
func NewPasswordAndKeyDataCredentials(password string, data []byte) (*DBCredentials, error)
```

--------------------------------

### Initialize AES Encrypter

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

Initializes a new AESEncrypter. Requires a key and an initialization vector (IV).

```go
func NewAESEncrypter(key []byte, iv []byte) (*AESEncrypter, error)
```

--------------------------------

### Create DBCredentials from Key File Data

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Builds new database credentials directly from the byte data of a key file. Useful when the key file content is already in memory.

```go
func NewKeyDataCredentials(data []byte) (*DBCredentials, error)
```

--------------------------------

### Create a new DBHeader

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Creates a new DBHeader with sensible default values. This is the basic constructor for a database header.

```go
func NewHeader() *DBHeader
```

--------------------------------

### Initialize TwoFish Encrypter

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

Initializes a new TwoFishEncrypter. Requires a key and an initialization vector (IV).

```go
func NewTwoFishEncrypter(key []byte, iv []byte) (*TwoFishEncrypter, error)
```

--------------------------------

### Create New DBContent

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Creates a new database content object with default settings. Accepts optional DBContentOption functions.

```go
func NewContent(options ...DBContentOption) *DBContent
```

--------------------------------

### Create a new KDBX3 DBHeader

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Creates a new DBHeader specifically configured with good defaults for KDBX version 3. This is useful when working with older KDBX files.

```go
func NewKDBX3Header() *DBHeader
```

--------------------------------

### Create a new KDBX4 DBHeader

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Creates a new DBHeader with good defaults tailored for KDBX version 4. Use this for modern KDBX databases.

```go
func NewKDBX4Header() *DBHeader
```

--------------------------------

### Create New BinaryReference

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Creates a new BinaryReference with the specified name and ID.

```go
func NewBinaryReference(name string, id int) BinaryReference
```

--------------------------------

### NewMetaData Constructor

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

NewMetaData creates a MetaData struct with some defaults set.

```go
func NewMetaData(options ...MetaDataOption) *MetaData
```

--------------------------------

### Binary Options

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Options for specifying KDBX binary formats when adding binaries.

```APIDOC
## Binary Options

### func WithKDBXv4Binary

`func WithKDBXv4Binary(binary *Binary)`

WithKDBXv4Binary can be passed to the Binaries.Add function as an option to ensure that the Binary will follow the KDBXv4 format.

### func WithKDBXv31Binary

`func WithKDBXv31Binary(binary *Binary)`

WithKDBXv31Binary can be passed to the Binaries.Add function as an option to ensure that the Binary will follow the KDBXv31 format.
```

--------------------------------

### Database Options

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Options to configure database settings during creation or modification.

```APIDOC
## WithDatabaseFormattedTime

### Description
Configures the database to use formatted time.

### Method
DatabaseOption

### Endpoint
N/A (Function returning DatabaseOption)

### Parameters
- **formatted** (bool) - Description: Whether to use formatted time.

### Request Example
None

### Response
#### Success Response (200)
Returns a DatabaseOption.

#### Response Example
None
```

```APIDOC
## WithDatabaseKDBXVersion3

### Description
Configures the database to use KDBX version 3.

### Method
DatabaseOption

### Endpoint
N/A (Function returning DatabaseOption)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Returns a DatabaseOption.

#### Response Example
None
```

```APIDOC
## WithDatabaseKDBXVersion4

### Description
Configures the database to use KDBX version 4.

### Method
DatabaseOption

### Endpoint
N/A (Function returning DatabaseOption)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Returns a DatabaseOption.

#### Response Example
None
```

--------------------------------

### Initialize Insecure Stream

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

Initializes a new InsecureStream, which acts as a fake cipher implementing the CryptoStream interface.

```go
func NewInsecureStream() *InsecureStream
```

--------------------------------

### Add Binary to Database

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Adds a binary content to the database. This method handles placing the binary correctly based on the database's format version. It returns a pointer to the added `Binary` object.

```go
func (db *Database) AddBinary(binaryContent []byte) *Binary
```

--------------------------------

### Initialize ChaCha Encrypter

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

Initializes a new ChaChaStream cipher for encryption. Requires a key and an initialization vector (IV).

```go
func NewChaChaEncrypter(key []byte, iv []byte) (*ChaChaStream, error)
```

--------------------------------

### Create DBOptions

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Creates new DBOptions with default values. The primary option is `ValidateHashes`, which controls header hash validation during decoding.

```go
func NewOptions() *DBOptions
```

--------------------------------

### Find Binary via Reference (Deprecated)

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Finds a binary in the database using the reference's ID. This function is deprecated; use Database.FindBinary instead.

```go
func (br *BinaryReference) Find(db *Database) *Binary
```

--------------------------------

### String representation of DBHeader

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Provides a string representation for the DBHeader. Helpful for debugging and inspecting header details.

```go
func (h DBHeader) String() string
```

--------------------------------

### NewRootData Constructor

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

NewRootData returns a RootData struct with good defaults.

```go
func NewRootData(options ...RootDataOption) *RootData
```

--------------------------------

### Build HMAC for Block

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Builds an HMAC for a given block using the index, length, and data.

```go
func (b *BlockHMACBuilder) BuildHMAC(index uint64, length uint32, data []byte) []byte
```

--------------------------------

### Binary String Representation

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Returns a string representation of the Binary object.

```go
func (b Binary) String() string
```

--------------------------------

### Read a KeePass file

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Demonstrates opening a kdbx file, providing credentials, and accessing entry data. Always call UnlockProtectedEntries before accessing data and LockProtectedEntries before saving.

```go
package main

import (
    "fmt"
    "github.com/tobischo/gokeepasslib/v3"
    "os"
)

func main() {
    file, _ := os.Open("examples/reading/example.kdbx")

    db := gokeepasslib.NewDatabase()
    db.Credentials = gokeepasslib.NewPasswordCredentials("abcdefg12345678")
    _ = gokeepasslib.NewDecoder(file).Decode(db)

    db.UnlockProtectedEntries()

    // Note: This is a simplified example and the groups and entries will depend on the specific file.
    // bound checking for the slices is recommended to avoid panics.
    entry := db.Content.Root.Groups[0].Groups[0].Entries[0]
    fmt.Println(entry.GetTitle())
    fmt.Println(entry.GetPassword())
}
```

--------------------------------

### AutoType Data Structures

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Structures for managing AutoType settings and associations.

```go
type AutoTypeAssociation struct {
	Window            string `xml:"Window"`
	KeystrokeSequence string `xml:"KeystrokeSequence"`
}
```

```go
type AutoTypeData struct {
	Enabled                 w.BoolWrapper         `xml:"Enabled"`
	DataTransferObfuscation int64                 `xml:"DataTransferObfuscation"`
	DefaultSequence         string                `xml:"DefaultSequence"`
	Associations            []AutoTypeAssociation `xml:"Association,omitempty"`
}
```

--------------------------------

### Initialize Salsa Stream

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

Initializes a new SalsaStream cipher for streaming operations. Requires a key.

```go
func NewSalsaStream(key []byte) (*SalsaStream, error)
```

--------------------------------

### KDBX Signature Variables

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Defines the base and version-specific signatures for KDBX database files.

```go
var (
	// BaseSignature is the valid base signature for kdbx files
	BaseSignature = [...]byte{0x03, 0xd9, 0xa2, 0x9a}

	// SecondarySignature is the valid version signature for kdbx files
	SecondarySignature = [...]byte{0x67, 0xfb, 0x4b, 0xb5}

	// DefaultKDBX3Sig is the full valid default signature struct for new databases (Kdbx v3.1)
	DefaultKDBX3Sig = Signature{BaseSignature, SecondarySignature, 1, 3}

	// DefaultKDBX4Sig is the full valid default signature struct for new databases (Kdbx v4.0)
	DefaultKDBX4Sig = Signature{BaseSignature, SecondarySignature, 0, 4}

	// DefaultSig is the full valid default signature struct for new databases (Kdbx v3.1)
	DefaultSig = DefaultKDBX3Sig
)
```

--------------------------------

### Create DBCredentials from Password

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Builds new database credentials using only a password string. This is a simpler credential type, typically used when no key file is involved.

```go
func NewPasswordCredentials(password string) *DBCredentials
```

--------------------------------

### Find Binary by ID

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Finds and returns a reference to a binary with a matching ID from the Binaries slice. Returns nil if no binary is found.

```go
func (bs Binaries) Find(id int) *Binary
```

--------------------------------

### BinaryReference String Representation

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Returns a string representation of the BinaryReference object.

```go
func (br BinaryReference) String() string
```

--------------------------------

### Database Content API

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Methods for initializing and managing the core database content structure.

```APIDOC
## POST /DBContent/New

### Description
Creates a new database content container with default settings.

### Method
POST

### Request Body
- **options** (DBContentOption) - Optional - Configuration options for the database content.

### Response
#### Success Response (200)
- **content** (DBContent) - The initialized database content object.
```

--------------------------------

### Initialize ChaCha Stream

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

Initializes a new ChaChaStream cipher for streaming operations. Requires only a key.

```go
func NewChaChaStream(key []byte) (*ChaChaStream, error)
```

--------------------------------

### Set Binary Content

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Encodes and compresses (if applicable) the provided byte slice and sets it as the Binary's content.

```go
func (b *Binary) SetContent(c []byte) error
```

--------------------------------

### Encoding and Decoding

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions for reading and writing KDBX database files.

```APIDOC
## func NewDecoder(r io.Reader) *Decoder

### Description
Creates a new decoder to read a database from an io.Reader.

## func (d *Decoder) Decode(db *Database) error

### Description
Decodes the database content into the provided Database object.

## func NewEncoder(w io.Writer) *Encoder

### Description
Creates a new encoder to write a database to an io.Writer.

## func (e *Encoder) Encode(db *Database) error

### Description
Encodes the provided Database object into the writer.
```

--------------------------------

### Create DBHashes

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Creates new DBHashes based on the provided database header. This function is used to initialize the hash structures for a database.

```go
func NewHashes(header *DBHeader) *DBHashes
```

--------------------------------

### Find Binary in Database

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Searches for and returns a binary object within the database using its unique ID. Returns `nil` if no binary with the specified ID is found.

```go
func (db *Database) FindBinary(id int) *Binary
```

--------------------------------

### Key Parsing Functions

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions for extracting hashed keys from files or raw data.

```go
func ParseKeyData(data []byte) ([]byte, error)
```

```go
func ParseKeyFile(location string) ([]byte, error)
```

--------------------------------

### Credential Handling

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions for creating various types of database credentials.

```APIDOC
## func NewPasswordCredentials(password string) *DBCredentials

### Description
Creates credentials using only a password.

## func NewKeyCredentials(location string) (*DBCredentials, error)

### Description
Creates credentials using a key file located at the specified path.

## func NewPasswordAndKeyCredentials(password, location string) (*DBCredentials, error)

### Description
Creates credentials using both a password and a key file.
```

--------------------------------

### String representation of DBCredentials

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Provides a string representation for DBCredentials. This method is useful for debugging or logging.

```go
func (c *DBCredentials) String() string
```

--------------------------------

### Binaries Type Definition

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Defines a collection of binaries for database metadata.

```go
type Binaries []Binary
```

--------------------------------

### String Method for KdfParameters

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Provides a string representation for the KdfParameters struct.

```go
func (k *KdfParameters) String() string
```

--------------------------------

### Check if DBHeader is KDBX4

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Returns true if the database header indicates it is version 4 (KDBX4). Useful for applying version-specific logic.

```go
func (h *DBHeader) IsKdbx4() bool
```

--------------------------------

### MarshalText for TimeWrapper (Kdbx v3.1/v4)

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/wrappers

Marshals time into RFC3339 format for Kdbx v3.1 or calculates and base64 encodes seconds for Kdbx v4.

```go
func (tw TimeWrapper) MarshalText() ([]byte, error)
```

--------------------------------

### NewTwoFishEncrypter

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

Initializes a new TwoFishEncrypter instance using the provided key and initialization vector.

```APIDOC
## func NewTwoFishEncrypter

### Description
Initializes a new TwoFishEncrypter that implements the Encrypter interface.

### Parameters
- **key** ([]byte) - Required - The encryption key.
- **iv** ([]byte) - Required - The initialization vector.

### Response
- **TwoFishEncrypter** (*TwoFishEncrypter) - The initialized encrypter instance.
- **error** (error) - Returns an error if initialization fails.
```

--------------------------------

### DBCredentials Management

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions for creating and managing database credentials from passwords and key files.

```APIDOC
## DBCredentials Creation

### Description
Functions to build DBCredentials from various sources including passwords and key files.

### Methods
- NewKeyCredentials(location string) (*DBCredentials, error)
- NewKeyDataCredentials(data []byte) (*DBCredentials, error)
- NewPasswordAndKeyCredentials(password, location string) (*DBCredentials, error)
- NewPasswordAndKeyDataCredentials(password string, data []byte) (*DBCredentials, error)
- NewPasswordCredentials(password string) *DBCredentials
```

--------------------------------

### Compression Flags

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Defines flags for compression methods, including no compression and Gzip compression.

```go
const (
	NoCompressionFlag   uint32 = 0 // No compression flag
	GzipCompressionFlag uint32 = 1 // Gzip compression flag

)
```

--------------------------------

### DBContentOption Function Type

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Defines the function type for options used when creating DBContent.

```go
type DBContentOption func(*DBContent)
```

--------------------------------

### WithDBContentFormattedTime Option

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

A DBContentOption function to set whether time values should be formatted.

```go
func WithDBContentFormattedTime(formatted bool) DBContentOption
```

--------------------------------

### Key Parsing Functions

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions for parsing key data and key files.

```APIDOC
## Key Parsing Functions

### func ParseKeyData

`func ParseKeyData(data []byte) ([]byte, error)`

ParseKeyData returns the hashed key from a key file in bytes, parsing xml if needed.

### func ParseKeyFile

`func ParseKeyFile(location string) ([]byte, error)`

ParseKeyFile returns the hashed key from a key file at the path specified by location, parsing xml if needed.
```

--------------------------------

### Constants and Variables

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Defines constants and variables used within the GoKeepasslib library, including file signatures, cipher IDs, and key derivation function IDs.

```APIDOC
## Constants and Variables

### BaseSignature

`var BaseSignature = [...]byte{0x03, 0xd9, 0xa2, 0x9a}`

Valid base signature for kdbx files.

### SecondarySignature

`var SecondarySignature = [...]byte{0x67, 0xfb, 0x4b, 0xb5}`

Valid version signature for kdbx files.

### DefaultKDBX3Sig

`var DefaultKDBX3Sig = Signature{BaseSignature, SecondarySignature, 1, 3}`

Full valid default signature struct for new databases (Kdbx v3.1).

### DefaultKDBX4Sig

`var DefaultKDBX4Sig = Signature{BaseSignature, SecondarySignature, 0, 4}`

Full valid default signature struct for new databases (Kdbx v4.0).

### DefaultSig

`var DefaultSig = DefaultKDBX3Sig`

Full valid default signature struct for new databases (Kdbx v3.1).

### CipherAES

`var CipherAES = []byte{...}`

AES cipher ID.

### CipherChaCha20

`var CipherChaCha20 = []byte{...}`

ChaCha20 cipher ID.

### CipherTwoFish

`var CipherTwoFish = []byte{...}`

TwoFish cipher ID.

### KdfAES3

`var KdfAES3 = []byte{...}`

AES key derivation function ID for Kdbx v3.1.

### KdfAES4

`var KdfAES4 = []byte{...}`

AES key derivation function ID for Kdbx v4.

### KdfArgon2

`var KdfArgon2 = []byte{...}`

Argon2 key derivation function ID.
```

--------------------------------

### String representation of DBHashes

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Provides a string representation for DBHashes. Useful for inspecting hash values.

```go
func (h DBHashes) String() string
```

--------------------------------

### RootData Management

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions and structures for handling the root content of the database.

```APIDOC
## NewRootData

### Description
Returns a RootData struct initialized with default values.

### Parameters
#### Request Body
- **options** (...RootDataOption) - Optional - Functional options to configure the root data.

### Response
- **RootData** (struct) - The initialized root data object.
```

--------------------------------

### Function: WithKDBX4Formatting

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/wrappers

WithKDBX4Formatting is a TimeOption that configures TimeWrapper for KDBX4 formatting.

```APIDOC
## Function WithKDBX4Formatting

### Description
WithKDBX4Formatting is a TimeOption that configures TimeWrapper for KDBX4 formatting.

### Signature
```go
func WithKDBX4Formatting(t *TimeWrapper)
```

### Parameters
* **t** (*TimeWrapper) - A pointer to the TimeWrapper to configure.
```

--------------------------------

### Entry Methods

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Methods for retrieving information from a KeePass Entry.

```APIDOC
## func (*Entry) GetPasswordIndex

### Description
Returns the index in the values slice belonging to the password.

## func (*Entry) GetTitle

### Description
Returns the title of an entry.
```

--------------------------------

### Define RootData Struct

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

RootData stores the actual content of a database (all entries sorted into groups and the recycle bin).

```go
type RootData struct {
	Groups         []Group             `xml:"Group"`
	DeletedObjects []DeletedObjectData `xml:"DeletedObjects>DeletedObject"`
}
```

--------------------------------

### MetaData Management

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions and structures for handling database metadata headers.

```APIDOC
## NewMetaData

### Description
Creates a new MetaData struct with default settings applied.

### Parameters
#### Request Body
- **options** (...MetaDataOption) - Optional - Functional options to configure the metadata.

### Response
- **MetaData** (struct) - The initialized metadata object.
```

--------------------------------

### NewBlockHMACBuilder

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Creates a new BlockHMACBuilder with the provided master seed and transformed key.

```go
func NewBlockHMACBuilder(masterSeed []byte, transformedKey []byte) *BlockHMACBuilder
```

--------------------------------

### BinaryReference Structure Definition

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Stores a reference to a binary, appearing in an entry's XML. Contains a name and a reference ID.

```go
type BinaryReference struct {
	Name  string `xml:"Key"`
	Value struct {
		ID int `xml:"Ref,attr"`
	} `xml:"Value"`
}
```

--------------------------------

### Add Binary Data to Binaries Slice

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Appends binary data to the Binaries slice. This function is deprecated; use Database.AddBinary instead.

```go
func (bs *Binaries) Add(c []byte, options ...BinaryOption) *Binary
```

--------------------------------

### Define History Struct

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

History stores information about changes made to an entry, in the form of a list of previous versions of that entry.

```go
type History struct {
	Entries []Entry `xml:"Entry"`
}
```

--------------------------------

### Binary Management API

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Methods for managing binary data within a KeePass database, including finding, creating, and retrieving content.

```APIDOC
## GET /Binary/Find

### Description
Find returns a reference to a binary with the same ID as id, or nil if none is found.

### Method
GET

### Parameters
#### Path Parameters
- **id** (int) - Required - The ID of the binary to find.

## GET /Binary/GetContentBytes

### Description
Returns a byte slice containing the content of a binary.

### Method
GET

### Response
#### Success Response (200)
- **content** ([]byte) - The binary content.
```

--------------------------------

### Binary Structure Definition

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Defines the Binary structure, which stores binary data found in a database's metadata header. Includes fields for ID, memory protection, content, and compression status.

```go
type Binary struct {
	ID               int           `xml:"ID,attr"`	// Index (Manually counted on KDBX v4)
	MemoryProtection byte          `xml:"-"`				// Memory protection flag (Only KDBX v4)
	Content          []byte        `,innerxml"`		// Binary content
	Compressed       w.BoolWrapper `xml:"Compressed,attr"`	// Compressed flag (Only KDBX v3.1)
	// contains filtered or unexported fields
}
```

--------------------------------

### Key Derivation Function ID Constants

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Byte slices representing identifiers for supported key derivation functions.

```go
var KdfAES3 = []byte{
	0xC9, 0xD9, 0xF3, 0x9A,
	0x62, 0x8A, 0x44, 0x60,
	0xBF, 0x74, 0x0D, 0x08,
	0xC1, 0x8A, 0x4F, 0xEA,
}
```

```go
var KdfAES4 = []byte{
	0x7C, 0x02, 0xBB, 0x82,
	0x79, 0xA7, 0x4A, 0xC0,
	0x92, 0x7D, 0x11, 0x4A,
	0x00, 0x64, 0x82, 0x38,
}
```

```go
var KdfArgon2 = []byte{
	0xEF, 0x63, 0x6D, 0xDF,
	0x8C, 0x29, 0x44, 0x4B,
	0x91, 0xF7, 0xA9, 0xA4,
	0x03, 0xE3, 0x0A, 0x0C,
}
```

--------------------------------

### AES Encrypt Data

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

Encrypts the provided byte slice using the AESEncrypter.

```go
func (ae *AESEncrypter) Encrypt(data []byte) []byte
```

--------------------------------

### String representation of TimeWrapper

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/wrappers

Provides a string representation for the TimeWrapper type.

```go
func (tw TimeWrapper) String() string
```

--------------------------------

### InsecureStream API

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

A fake cipher implementation for testing or non-secure streams.

```APIDOC
## InsecureStream

### Description
InsecureStream is a fake cipher that implements the CryptoStream interface.

### Methods
- **NewInsecureStream() *InsecureStream**: Initializes a new InsecureStream.
- **Pack(payload []byte) string**: Returns the payload as an encrypted string.
- **Unpack(payload string) []byte**: Returns the payload as an unencrypted byte array.
```

--------------------------------

### MetaDataOption Type

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

MetaDataOption is a function type used for configuring MetaData.

```go
type MetaDataOption func(*MetaData)
```

--------------------------------

### Define KdfParameters Struct

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

KdfParameters contains every field of the KdfParameters header field.

```go
type KdfParameters struct {
	RawData     *VariantDictionary // Raw data of KdfParameters
	UUID        []byte             // $UUID - KDF ID
	Rounds      uint64             // R - Rounds
	Salt        [32]byte           // S - Salt (Argon 2) / Seed (AES)
	Parallelism uint32             // P - Parallelism
	Memory      uint64             // M - Memory
	Iterations  uint64             // I - Iterations
	Version     uint32             // V - Version
	SecretKey   []byte             // K - Secret key
	AssocData   []byte             // A - AssocData
}
```

--------------------------------

### Group Management

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions for creating and cloning groups within the database.

```APIDOC
## func NewGroup

### Description
Returns a new group with time data and uuid set.

## func (Group) Clone

### Description
Creates a copy of a Group struct including its child entities.
```

--------------------------------

### TwoFish Encrypt Data

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

Encrypts the provided byte slice using the TwoFishEncrypter.

```go
func (tfe *TwoFishEncrypter) Encrypt(data []byte) []byte
```

--------------------------------

### String Method for InnerHeader

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Provides a string representation for the InnerHeader struct.

```go
func (ih InnerHeader) String() string
```

--------------------------------

### Database Operations

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Core database structure and management methods.

```APIDOC
## Database Management

### Description
Methods for interacting with the main Database structure, including binary management and stream managers.

### Methods
- NewDatabase(options ...DatabaseOption) *Database
- AddBinary(binaryContent []byte) *Binary
- FindBinary(id int) *Binary
- GetEncrypterManager(transformedKey []byte) (*EncrypterManager, error)
- GetStreamManager() (*StreamManager, error)
```

--------------------------------

### Define MetaData Struct

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

MetaData is the structure for the metadata headers at the top of kdbx files, it contains things like the name of the database.

```go
type MetaData struct {
	Generator                  string         `xml:"Generator"`
	SettingsChanged            *w.TimeWrapper `xml:"SettingsChanged"`
	HeaderHash                 string         `xml:"HeaderHash,omitempty"`
	DatabaseName               string         `xml:"DatabaseName"`
	DatabaseNameChanged        *w.TimeWrapper `xml:"DatabaseNameChanged"`
	DatabaseDescription        string         `xml:"DatabaseDescription"`
	DatabaseDescriptionChanged *w.TimeWrapper `xml:"DatabaseDescriptionChanged"`
	DefaultUserName            string         `xml:"DefaultUserName"`
	DefaultUserNameChanged     *w.TimeWrapper `xml:"DefaultUserNameChanged"`
	MaintenanceHistoryDays     int64          `xml:"MaintenanceHistoryDays"`
	Color                      string         `xml:"Color"`
	MasterKeyChanged           *w.TimeWrapper `xml:"MasterKeyChanged"`
	MasterKeyChangeRec         int64          `xml:"MasterKeyChangeRec"`
	MasterKeyChangeForce       int64          `xml:"MasterKeyChangeForce"`
	MemoryProtection           MemProtection  `xml:"MemoryProtection"`
	CustomIcons                []CustomIcon   `xml:"CustomIcons>Icon"`
	RecycleBinEnabled          w.BoolWrapper  `xml:"RecycleBinEnabled"`
	RecycleBinUUID             UUID           `xml:"RecycleBinUUID"`
	RecycleBinChanged          *w.TimeWrapper `xml:"RecycleBinChanged"`
	EntryTemplatesGroup        string         `xml:"EntryTemplatesGroup"`
	EntryTemplatesGroupChanged *w.TimeWrapper `xml:"EntryTemplatesGroupChanged"`
	HistoryMaxItems            int64          `xml:"HistoryMaxItems"`
	HistoryMaxSize             int64          `xml:"HistoryMaxSize"`
	LastSelectedGroup          string         `xml:"LastSelectedGroup"`
	LastTopVisibleGroup        string         `xml:"LastTopVisibleGroup"`
	Binaries                   Binaries       `xml:"Binaries>Binary,omitempty"`
	CustomData                 []CustomData   `xml:"CustomData>Item"`
}
```

--------------------------------

### UnmarshalText for TimeWrapper (Kdbx v3.1/v4)

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/wrappers

Unmarshals time from RFC3339 format for Kdbx v3.1 or calculates time from base64 encoded seconds for Kdbx v4.

```go
func (tw *TimeWrapper) UnmarshalText(data []byte) error
```

--------------------------------

### Database Management

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions for creating, locking, and unlocking KeePass databases.

```APIDOC
## func NewDatabase(options ...DatabaseOption) *Database

### Description
Creates a new Database instance with optional configuration.

### Parameters
- **options** (...DatabaseOption) - Optional - Functional options to configure the database (e.g., KDBX version).

## func (db *Database) LockProtectedEntries() error

### Description
Locks all protected entries within the database.

## func (db *Database) UnlockProtectedEntries() error

### Description
Unlocks all protected entries within the database.
```

--------------------------------

### VariantDictionary.Get

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Retrieves a VariantDictionaryItem by its key.

```APIDOC
## GET /variantdictionary/item

### Description
Retrieves a VariantDictionaryItem by its key.

### Method
GET

### Endpoint
/variantdictionary/item

### Parameters
#### Query Parameters
- **key** (string) - Required - The key of the item to retrieve.

### Response
#### Success Response (200)
- **VariantDictionaryItem** (object) - The retrieved item.

### Response Example
```json
{
  "Type": "byte",
  "NameLength": 10,
  "Name": "exampleName",
  "ValueLength": 20,
  "Value": "exampleValue"
}
```
```

--------------------------------

### DBCredentials Structure Definition

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Holds the credentials used to lock and unlock a database, including passphrase, keyfile content, and Windows authentication data, all stored as SHA256 hashes.

```go
type DBCredentials struct {
	Passphrase []byte	// Passphrase if using one, stored in sha256 hash
	Key        []byte	// Contents of the keyfile if using one, stored in sha256 hash
	Windows    []byte	// Whatever is returned from windows user account auth, stored in sha256 hash
}
```

--------------------------------

### Type Definitions

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Defines data structures used within the GoKeepasslib library.

```APIDOC
## Type Definitions

### type AutoTypeAssociation

`type AutoTypeAssociation struct {
	Window            string `xml:"Window"`
	KeystrokeSequence string `xml:"KeystrokeSequence"`
}`

AutoTypeAssociation is a structure that stores the keystroke sequence of a window for AutoTypeData.

### type AutoTypeData

`type AutoTypeData struct {
	Enabled                 w.BoolWrapper `xml:"Enabled"`
	DataTransferObfuscation int64         `xml:"DataTransferObfuscation"`
	DefaultSequence         string        `xml:"DefaultSequence"`
	Associations            []AutoTypeAssociation `xml:"Association,omitempty"`
}`

AutoTypeData is a structure containing auto type settings of an entry.

### type Binaries

`type Binaries []Binary`

Binaries stores a slice of binaries in the metadata header of a database. This will be used only on KDBX 3.1. Since KDBX 4, binaries are stored into the InnerHeader.
```

--------------------------------

### CustomData Structure Definition

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Represents custom data for plugins, including a key and a value.

```go
type CustomData struct {
	XMLName xml.Name `xml:"Item"`
	Key     string   `xml:"Key"`
	Value   string   `xml:"Value"`
}
```

--------------------------------

### String Representation of VariantDictionary

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Provides a string representation for the VariantDictionary type. This method is associated with the VariantDictionary type.

```go
func (vd VariantDictionary) String() string
```

--------------------------------

### DBHeader Management

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions for creating and validating KeePass database headers.

```APIDOC
## DBHeader Operations

### Description
Manage database headers, including version-specific defaults and hash validation.

### Methods
- NewHeader() *DBHeader
- NewKDBX3Header() *DBHeader
- NewKDBX4Header() *DBHeader
- GetHmacSha256(hmacKey []byte) [32]byte
- GetSha256() [32]byte
- IsKdbx4() bool
- ValidateHmacSha256(hmacKey []byte, hash [32]byte) error
- ValidateSha256(hash [32]byte) error
```

--------------------------------

### Entry Operations

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions for creating and managing individual entries within a database.

```APIDOC
## NewEntry

### Description
Returns a new entry with time data and UUID set.

### Method
NewEntry

### Endpoint
N/A (Function returning Entry)

### Parameters
- **options** (...EntryOption) - Description: Options to configure the new entry.

### Request Example
None

### Response
#### Success Response (200)
Returns a new Entry.

#### Response Example
None
```

```APIDOC
## Clone

### Description
Creates a copy of an Entry struct including its child entities.

### Method
(Entry) Clone

### Endpoint
N/A (Method on Entry struct)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Returns a copy of the Entry.

#### Response Example
None
```

```APIDOC
## Get

### Description
Returns the value in the entry corresponding with the given key, or an empty string otherwise.

### Method
(*Entry) Get

### Endpoint
N/A (Method on Entry struct)

### Parameters
- **key** (string) - Description: The key of the value to retrieve.

### Request Example
None

### Response
#### Success Response (200)
Returns the ValueData corresponding to the key, or an empty string if not found.

#### Response Example
None
```

```APIDOC
## GetContent

### Description
Returns the content of the value belonging to the given key in string form.

### Method
(*Entry) GetContent

### Endpoint
N/A (Method on Entry struct)

### Parameters
- **key** (string) - Description: The key of the value to retrieve.

### Request Example
None

### Response
#### Success Response (200)
Returns the content of the value as a string.

#### Response Example
None
```

```APIDOC
## GetIndex

### Description
Returns the index of the Value belonging to the given key, or -1 if none is found.

### Method
(*Entry) GetIndex

### Endpoint
N/A (Method on Entry struct)

### Parameters
- **key** (string) - Description: The key of the value to find the index for.

### Request Example
None

### Response
#### Success Response (200)
Returns the index of the Value, or -1 if not found.

#### Response Example
None
```

```APIDOC
## GetPassword

### Description
Returns the password of an entry.

### Method
(*Entry) GetPassword

### Endpoint
N/A (Method on Entry struct)

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Returns the password as a string.

#### Response Example
None
```

--------------------------------

### BinaryOption Function Type

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Defines the function type for options used with Binary structs. Added in v3.3.0.

```go
type BinaryOption func(binary *Binary)
```

--------------------------------

### DBContent Structure Definition

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

A container for all elements of a KeePass database, including raw data, inner header, metadata, and root data.

```go
type DBContent struct {
	RawData     []byte       `xml:"-"`	// XML encoded original data
	InnerHeader *InnerHeader `xml:"-"`
	XMLName     xml.Name     `xml:"KeePassFile"`
	Meta        *MetaData    `xml:"Meta"`
	Root        *RootData    `xml:"Root"`
}
```

--------------------------------

### Salsa Stream Pack Payload

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

Packs and encrypts a payload into a string representation using SalsaStream.

```go
func (s *SalsaStream) Pack(payload []byte) string
```

--------------------------------

### CustomIcon Structure Definition

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Stores custom icon data, including a UUID and base64 encoded PNG data. Added in v3.2.1.

```go
type CustomIcon struct {
	UUID UUID   `xml:"UUID"`	// Entry's CustomIcon UUID should match this
	Data string `xml:"Data"`	// base64 encoded PNG icon.  Unknown size constraints
}
```

--------------------------------

### FileHeaders Management

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Functions for creating and managing KeePass file headers.

```APIDOC
## func NewFileHeaders

### Description
Creates a new FileHeaders with good defaults.

## func NewKDBX3FileHeaders

### Description
Creates a new FileHeaders with good defaults for KDBX3.

## func NewKDBX4FileHeaders

### Description
Creates a new FileHeaders with good defaults for KDBX4.
```

--------------------------------

### ChaChaStream API

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/crypto

ChaCha20 cipher implementation for stream and encrypter interfaces.

```APIDOC
## ChaChaStream

### Description
ChaChaStream is a ChaCha20 cipher that implements Stream and Encrypter interfaces.

### Methods
- **NewChaChaEncrypter(key []byte, iv []byte) (*ChaChaStream, error)**: Initializes a new ChaChaStream interfaced with Encrypter.
- **NewChaChaStream(key []byte) (*ChaChaStream, error)**: Initializes a new ChaChaStream interfaced with Stream.
- **Decrypt(data []byte) []byte**: Returns the decrypted data.
- **Encrypt(data []byte) []byte**: Returns the encrypted data.
- **Pack(payload []byte) string**: Returns the payload as an encrypted string.
- **Unpack(payload string) []byte**: Returns the payload as an unencrypted byte array.
```

--------------------------------

### Error Handling

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Defines common error types returned by the GoKeepasslib library.

```APIDOC
## Error Handling

### ErrEndOfHeaders

`var ErrEndOfHeaders = errors.New("gokeepasslib: header id was 0, end of headers")`

Error returned when the end of headers is reached.

### ErrEndOfInnerHeaders

`var ErrEndOfInnerHeaders = errors.New("gokeepasslib: inner header id was 0, end of inner headers")`

Error returned when the end of inner header is reached.

### ErrInvalidDatabaseOrCredentials

`var ErrInvalidDatabaseOrCredentials = errors.New("Cannot read database: Either credentials are invalid or the database file is corrupted")`

Returned when the database file cannot be read, indicating invalid credentials or corruption.

### ErrInvalidUUIDLength

`var ErrInvalidUUIDLength = errors.New("gokeepasslib: length of decoded UUID was not 16")`

Returned during unmarshaling if the UUID does not have a 16-byte length.

### ErrUnsupportedEncrypterType

`var ErrUnsupportedEncrypterType = errors.New("Type of encrypter unsupported")`

Returned if no encrypter manager can be created due to an invalid EncryptionIV length.

### ErrUnsupportedStreamType

`var ErrUnsupportedStreamType = errors.New("Type of stream manager unsupported")`

Returned if no stream manager can be created due to an unsupported InnerRandomStreamID value.
```

--------------------------------

### History Management

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Operations for managing entry history versions.

```APIDOC
## History.Clone

### Description
Creates a deep copy of a History struct, including all child entities.

### Response
- **History** (struct) - A cloned instance of the history object.
```

--------------------------------

### VariantDictionaryItem Structure

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Defines the structure of a VariantDictionaryItem, which includes type, name, and value information. This is a core data structure.

```go
type VariantDictionaryItem struct {
	Type        byte
	NameLength  int32
	Name        []byte
	ValueLength int32
	Value       []byte
}
```

--------------------------------

### WithRootDataFormattedTime Option

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

WithRootDataFormattedTime is a RootDataOption that sets whether time values should be formatted.

```go
func WithRootDataFormattedTime(formatted bool) RootDataOption
```

--------------------------------

### Error Variables

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Standard error definitions used throughout the package for validation and parsing failures.

```go
var ErrEndOfHeaders = errors.New("gokeepasslib: header id was 0, end of headers")
```

```go
var ErrEndOfInnerHeaders = errors.New("gokeepasslib: inner header id was 0, end of inner headers")
```

```go
var ErrInvalidDatabaseOrCredentials = errors.New(
	"Cannot read database: Either credentials are invalid or the database file is corrupted",
)
```

```go
var ErrInvalidUUIDLength = errors.New("gokeepasslib: length of decoded UUID was not 16")
```

```go
var ErrUnsupportedEncrypterType = errors.New("Type of encrypter unsupported")
```

```go
var ErrUnsupportedStreamType = errors.New("Type of stream manager unsupported")
```

--------------------------------

### Type: TimeOption

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3/wrappers

TimeOption is a function type used to configure TimeWrapper.

```APIDOC
## Type TimeOption

### Description
TimeOption is a function type used to configure TimeWrapper.

### Signature
```go
type TimeOption func(*TimeWrapper)
```

### Methods
* **WithFormatted(formatted bool) TimeOption**: Returns a TimeOption that sets the formatting preference for the TimeWrapper.
```

--------------------------------

### Clone History Struct

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Clone creates a copy of a History struct including its child entities. Added in v3.5.0.

```go
func (h History) Clone() History
```

--------------------------------

### Cipher ID Constants

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Byte slices representing identifiers for supported encryption ciphers.

```go
var CipherAES = []byte{
	0x31, 0xC1, 0xF2, 0xE6,
	0xBF, 0x71, 0x43, 0x50,
	0xBE, 0x58, 0x05, 0x21,
	0x6A, 0xFC, 0x5A, 0xFF,
}
```

```go
var CipherChaCha20 = []byte{
	0xD6, 0x03, 0x8A, 0x2B,
	0x8B, 0x6F, 0x4C, 0xB5,
	0xA5, 0x24, 0x33, 0x9A,
	0x31, 0xDB, 0xB5, 0x9A,
}
```

```go
var CipherTwoFish = []byte{
	0xAD, 0x68, 0xF2, 0x9F,
	0x57, 0x6F, 0x4B, 0xB9,
	0xA3, 0x6A, 0xD4, 0x7A,
	0xF9, 0x65, 0x34, 0x6C,
}
```

--------------------------------

### UUID Utility

Source: https://pkg.go.dev/github.com/tobischo/gokeepasslib/v3

Utility functions for generating and comparing UUIDs used within the database.

```APIDOC
## NewUUID

### Description
Generates a new unique identifier.

### Response
- **uuid** (UUID) - A newly generated UUID.
```
Tokens:
Raw