https://github.com/bigbuildbench/sseemayer_keepass-rs

https://github.com/bigbuildbench/sseemayer_keepass-rs

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.5%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: BigBuildBench
  • License: mit
  • Language: Rust
  • Default Branch: master
  • Size: 2.64 MB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License Codeowners Security

README.md

keepass-rs

Crates.io Documentation Build Status codecov dependency status License file

Rust KeePass database file parser for KDB, KDBX3 and KDBX4, with experimental support for KDBX4 writing.

Usage

### Open a database ```rust 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. ```rust use keepass::{ db::{Database, Entry, Group, Node, NodeRef, Value}, DatabaseKey, }; use std::fs::File; fn main() -> Result<(), Box> { 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](Cargo.toml) for a complete list. An example command line for running the `kp-dump-xml` command would be: ```bash 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:

ignore [dependencies] keepass = "*" # TODO replace with current version

Performance Notes

Please set the RUSTFLAGS environment variable when compiling to enable CPU-specific optimizations (this greatly affects the speed of the AES key derivation):

bash export RUSTFLAGS='-C target-cpu=native'

For best results, also compile in Release mode.

Alternatively, you can add a .cargo/config.toml like in this project to ensure that rustflags are always set.

For AArch64 / ARMv8:

The aes optimizations are not yet enabled on stable rust. If you want a big performance boost you can build using nightly and enabling the armv8 feature of the aes crate:

```ignore [dependencies.aes]

Needs at least 0.7.5 for the feature

version = "0.7.5" features = ["armv8"] ```

License

MIT

Owner

  • Name: BigBuildBench
  • Login: BigBuildBench
  • Kind: organization

abbr. B3, benchmarking the repo-level understanding capability of your LLMs by reconstructing project build-file.

GitHub Events

Total
  • Create event: 6
Last Year
  • Create event: 6

Dependencies

.github/workflows/ci.yml actions
  • actions/checkout v4 composite
  • dtolnay/rust-toolchain stable composite
  • taiki-e/install-action v2 composite
  • wagoid/commitlint-github-action v5 composite
.github/workflows/merge.yml actions
  • actions/checkout v4 composite
  • codecov/codecov-action v4 composite
  • dtolnay/rust-toolchain stable composite
  • paulhatch/semantic-version c423ebb78413907bc5382d5a0e840be160a83981 composite
Cargo.toml cargo
  • rustfmt 0.10 development