Expand description
§keepass-rs
Rust KeePass database file parser for KDB, KDBX3 and KDBX4, with experimental support for KDBX4 writing.
§Usage
§Open a database
use keepass::{
db::NodeRef,
Database,
DatabaseKey,
error::DatabaseOpenError
};
use std::fs::File;
fn main() -> Result<(), DatabaseOpenError> {
// Open KeePass database using a password (keyfile is also supported)
let mut file = File::open("tests/resources/test_db_with_password.kdbx")?;
let key = DatabaseKey::new().with_password("demopass");
let db = Database::open(&mut file, key)?;
// Iterate over all `Group`s and `Entry`s
for node in &db.root {
match node {
NodeRef::Group(g) => {
println!("Saw group '{0}'", g.name);
},
NodeRef::Entry(e) => {
let title = e.get_title().unwrap_or("(no title)");
let user = e.get_username().unwrap_or("(no username)");
let pass = e.get_password().unwrap_or("(no password)");
println!("Entry '{0}': '{1}' : '{2}'", title, user, pass);
}
}
}
Ok(())
}
§Save a KDBX4 database (EXPERIMENTAL)
IMPORTANT: The inner XML data structure will be re-written from scratch from the internal object representation of this crate, so any field that is not parsed by the library will be lost in the written output file! Please make sure to back up your database before trying this feature.
You can enable the experimental support for saving KDBX4 databases using the save_kdbx4
feature.
use keepass::{
db::{Database, Entry, Group, Node, NodeRef, Value},
DatabaseKey,
};
use std::fs::File;
fn main() -> Result<(), Box<dyn std::error::Error>> {
let mut db = Database::new(Default::default());
db.meta.database_name = Some("Demo database".to_string());
let mut group = Group::new("Demo group");
let mut entry = Entry::new();
entry.fields.insert("Title".to_string(), Value::Unprotected("Demo entry".to_string()));
entry.fields.insert("UserName".to_string(), Value::Unprotected("jdoe".to_string()));
entry.fields.insert("Password".to_string(), Value::Protected("hunter2".as_bytes().into()));
group.add_child(entry);
db.root.add_child(group);
#[cfg(feature = "save_kdbx4")]
db.save(
&mut File::create("demo.kdbx")?,
DatabaseKey::new().with_password("demopass"),
)?;
Ok(())
}
§Use developer tools
This crate contains several command line tools that can be enabled with the utilities
feature flag.
See the [[bin]]
sections in Cargo.toml for a complete list.
An example command line for running the kp-dump-xml
command would be:
cargo run --release --features "utilities" --bin kp-dump-xml -- path/to/database.kdbx
§Installation
Add the following to the dependencies
section of your Cargo.toml
:
[dependencies]
keepass = "*" # TODO replace with current version
§Performance Notes
For the best performance, this crate requires specific cargo configuration to enable CPU-specific optimizations, especially for AES key derivation.
Please see the recommended settings in the .cargo/config.toml file in this repository.
§License
MIT
Re-exports§
pub use self::db::Database;
Modules§
- config
- Configuration options for how to compress and encrypt databases
- db
- Types for representing data contained in a KeePass database
- error
- Error types that this crate can return
Structs§
- Database
Key - A KeePass key, which might consist of a password and/or a keyfile