refactor(key)!: use a builder-like pattern and owned internal represe…

…ntation (#168) * refactor(key)!: change DatabaseKey to owned representation in preparation of adding additional key element types, change DatabaseKey to use an owned representation instead. BREAKING CHANGE: cases where DatabaseKey objects were directly constructed will need to be updated * refactor(key)!: builder-like DatabaseKey Change DatabaseKey objects to be initialized empty and accept with_* functions to provide key elements. This should greatly simplify adding additional key element types in the future. BREAKING CHANGE: Key construction is changed for all users of the library. * refactor(key)!: make member variables private In preparation for future key elements, hide the internal structure of the DatabaseKey objects to prevent direct construction, so that additional elements can be added without breaking backward compatibility. BREAKING CHANGE: If elements were provided directly, this is no longer supported. --------- Co-authored-by: Stefan Seemayer <stefan@seemayer.de> Co-authored-by: louib <code@louib.net>
sseemayer · Jul 22, 2023 · c89df31 · c89df31
1 parent ae1360f
commit c89df31
Show file tree

Hide file tree

Showing 14 changed files with 132 additions and 142 deletions.
diff --git a/README.md b/README.md
@@ -26,12 +26,10 @@ use keepass::{
 use std::fs::File;
 
 fn main() -> Result<(), DatabaseOpenError> {
-    // Open KeePass database
-    let path = std::path::Path::new("tests/resources/test_db_with_password.kdbx");
-    let db = Database::open(
-        &mut File::open(path)?,                 // the database
-        DatabaseKey::with_password("demopass"), // password (keyfile is also supported)
-    )?;
+    // 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 {
@@ -90,7 +88,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     #[cfg(feature = "save_kdbx4")]
     db.save(
         &mut File::create("demo.kdbx")?,
-        DatabaseKey::with_password("demopass"),
+        DatabaseKey::new().with_password("demopass"),
     )?;
 
     Ok(())

diff --git a/src/bin/kp-dump-json.rs b/src/bin/kp-dump-json.rs
@@ -1,5 +1,5 @@
 /// utility to dump keepass database as JSON document
-use std::{fs::File, io::Read};
+use std::fs::File;
 
 use anyhow::Result;
 use clap::Parser;
@@ -21,20 +21,20 @@ pub fn main() -> Result<()> {
     let args = Args::parse();
 
     let mut source = File::open(args.in_kdbx)?;
-    let mut keyfile: Option<File> = args.keyfile.and_then(|f| File::open(f).ok());
+    let mut key = DatabaseKey::new();
+
+    if let Some(f) = args.keyfile {
+        key = key.with_keyfile(&mut File::open(f)?)?;
+    }
 
     let password =
         rpassword::prompt_password("Password (or blank for none): ").expect("Read password");
 
-    let password = if password.is_empty() {
-        None
-    } else {
-        Some(&password[..])
+    if !password.is_empty() {
+        key = key.with_password(&password);
     };
 
-    let keyfile = keyfile.as_mut().map(|kf| kf as &mut dyn Read);
-
-    let db = Database::open(&mut source, DatabaseKey { password, keyfile })?;
+    let db = Database::open(&mut source, key)?;
 
     let stdout = std::io::stdout().lock();
     serde_json::ser::to_writer(stdout, &db)?;

diff --git a/src/bin/kp-dump-xml.rs b/src/bin/kp-dump-xml.rs
@@ -1,6 +1,6 @@
 /// utility to dump keepass database internal XML data.
 use std::fs::File;
-use std::io::{Read, Write};
+use std::io::Write;
 
 use anyhow::Result;
 use clap::Parser;
@@ -25,20 +25,20 @@ pub fn main() -> Result<()> {
     let args = Args::parse();
 
     let mut source = File::open(args.in_kdbx)?;
-    let mut keyfile: Option<File> = args.keyfile.and_then(|f| File::open(f).ok());
+    let mut key = DatabaseKey::new();
 
-    let password = rpassword::prompt_password("Password (or blank for none): ")
-        .expect("Could not read password from TTY");
+    if let Some(f) = args.keyfile {
+        key = key.with_keyfile(&mut File::open(f)?)?;
+    }
 
-    let password = if password.is_empty() {
-        None
-    } else {
-        Some(&password[..])
-    };
+    let password =
+        rpassword::prompt_password("Password (or blank for none): ").expect("Read password");
 
-    let keyfile = keyfile.as_mut().map(|kf| kf as &mut dyn Read);
+    if !password.is_empty() {
+        key = key.with_password(&password);
+    };
 
-    let xml = Database::get_xml(&mut source, DatabaseKey { password, keyfile })?;
+    let xml = Database::get_xml(&mut source, key)?;
 
     File::create(args.out_xml)?.write_all(&xml)?;
 

diff --git a/src/bin/kp-rewrite.rs b/src/bin/kp-rewrite.rs
@@ -1,6 +1,5 @@
 /// utility to parse a KeePass database, and then write it out again, to see if anything is lost.
 use std::fs::File;
-use std::io::{Cursor, Read};
 
 use anyhow::Result;
 use clap::Parser;
@@ -25,40 +24,23 @@ pub fn main() -> Result<()> {
     let args = Args::parse();
 
     let mut source = File::open(args.in_kdbx)?;
+    let mut key = DatabaseKey::new();
 
-    let password = rpassword::prompt_password("Password (or blank for none): ")
-        .expect("Could not read password from TTY");
+    if let Some(f) = args.keyfile {
+        key = key.with_keyfile(&mut File::open(f)?)?;
+    }
 
-    let password = if password.is_empty() {
-        None
-    } else {
-        Some(&password[..])
-    };
+    let password =
+        rpassword::prompt_password("Password (or blank for none): ").expect("Read password");
 
-    let mut keyfile: Option<Cursor<_>> = if let Some(kf) = args.keyfile {
-        let mut f = File::open(kf)?;
-        let mut buf = Vec::new();
-        f.read_to_end(&mut buf)?;
-        Some(Cursor::new(buf))
-    } else {
-        None
+    if !password.is_empty() {
+        key = key.with_password(&password);
     };
 
-    let db = Database::open(
-        &mut source,
-        DatabaseKey {
-            password,
-            keyfile: keyfile.as_mut().map(|kf| kf as &mut dyn Read),
-        },
-    )?;
+    let db = Database::open(&mut source, key.clone())?;
 
-    db.save(
-        &mut File::create(args.out_kdbx)?,
-        DatabaseKey {
-            password,
-            keyfile: keyfile.as_mut().map(|kf| kf as &mut dyn Read),
-        },
-    )?;
+    let mut out_file = File::create(args.out_kdbx)?;
+    db.save(&mut out_file, key)?;
 
     Ok(())
 }
diff --git a/src/bin/kp-show-db.rs b/src/bin/kp-show-db.rs
@@ -1,6 +1,5 @@
 /// utility to show a parsed KeePass database
 use std::fs::File;
-use std::io::Read;
 
 use anyhow::Result;
 use clap::Parser;
@@ -22,20 +21,20 @@ pub fn main() -> Result<()> {
     let args = Args::parse();
 
     let mut source = File::open(args.in_kdbx)?;
-    let mut keyfile: Option<File> = args.keyfile.and_then(|f| File::open(f).ok());
+    let mut key = DatabaseKey::new();
 
-    let password = rpassword::prompt_password("Password (or blank for none): ")
-        .expect("Could not read password from TTY");
+    if let Some(f) = args.keyfile {
+        key = key.with_keyfile(&mut File::open(f)?)?;
+    }
 
-    let password = if password.is_empty() {
-        None
-    } else {
-        Some(&password[..])
-    };
+    let password =
+        rpassword::prompt_password("Password (or blank for none): ").expect("Read password");
 
-    let keyfile = keyfile.as_mut().map(|kf| kf as &mut dyn Read);
+    if !password.is_empty() {
+        key = key.with_password(&password);
+    };
 
-    let db = Database::open(&mut source, DatabaseKey { password, keyfile })?;
+    let db = Database::open(&mut source, key)?;
 
     println!("{:#?}", db);
 

diff --git a/src/bin/kp-show-otp.rs b/src/bin/kp-show-otp.rs
@@ -1,6 +1,5 @@
 /// utility to dump keepass database internal XML data.
 use std::fs::File;
-use std::io::Read;
 
 use anyhow::Result;
 use clap::Parser;
@@ -24,21 +23,20 @@ pub fn main() -> Result<()> {
     let args = Args::parse();
 
     let mut source = File::open(args.in_kdbx)?;
+    let mut key = DatabaseKey::new();
 
-    let mut keyfile: Option<File> = args.keyfile.and_then(|f| File::open(f).ok());
+    if let Some(f) = args.keyfile {
+        key = key.with_keyfile(&mut File::open(f)?)?;
+    }
 
     let password =
         rpassword::prompt_password("Password (or blank for none): ").expect("Read password");
 
-    let password = if password.is_empty() {
-        None
-    } else {
-        Some(&password[..])
+    if !password.is_empty() {
+        key = key.with_password(&password);
     };
 
-    let keyfile = keyfile.as_mut().map(|kf| kf as &mut dyn Read);
-
-    let db = Database::open(&mut source, DatabaseKey { password, keyfile })?;
+    let db = Database::open(&mut source, key)?;
 
     if let Some(NodeRef::Entry(e)) = db.root.get(&[&args.entry]) {
         let totp = e.get_otp().unwrap();

diff --git a/src/db/group.rs b/src/db/group.rs
@@ -68,12 +68,12 @@ impl Group {
     /// Recursively get a Group or Entry reference by specifying a path relative to the current Group
     /// ```
     /// use keepass::{Database, DatabaseKey, db::NodeRef};
-    /// use std::{fs::File, path::Path};
+    /// use std::fs::File;
     ///
-    /// let path = Path::new("tests/resources/test_db_with_password.kdbx");
+    /// let mut file = File::open("tests/resources/test_db_with_password.kdbx").unwrap();
     /// let db = Database::open(
-    ///     &mut File::open(path).unwrap(),
-    ///     DatabaseKey::with_password("demopass")
+    ///     &mut file,
+    ///     DatabaseKey::new().with_password("demopass")
     /// ).unwrap();
     ///
     /// if let Some(NodeRef::Entry(e)) = db.root.get(&["General", "Sample Entry #2"]) {

diff --git a/src/db/mod.rs b/src/db/mod.rs
@@ -330,7 +330,7 @@ mod database_tests {
     fn test_xml() -> Result<(), DatabaseOpenError> {
         let xml = Database::get_xml(
             &mut File::open("tests/resources/test_db_with_password.kdbx")?,
-            DatabaseKey::with_password("demopass"),
+            DatabaseKey::new().with_password("demopass"),
         )?;
 
         assert!(xml.len() > 100);
@@ -350,12 +350,12 @@ mod database_tests {
 
         let mut buffer = Vec::new();
 
-        db.save(&mut buffer, DatabaseKey::with_password("testing"))
+        db.save(&mut buffer, DatabaseKey::new().with_password("testing"))
             .unwrap();
 
         let db_loaded = Database::open(
             &mut buffer.as_slice(),
-            DatabaseKey::with_password("testing"),
+            DatabaseKey::new().with_password("testing"),
         )
         .unwrap();
 

diff --git a/src/db/otp.rs b/src/db/otp.rs
@@ -177,7 +177,10 @@ mod kdbx4_otp_tests {
     fn kdbx4_entry() -> Result<(), Box<dyn std::error::Error>> {
         // KDBX4 database format Base64 encodes ExpiryTime (and all other XML timestamps)
         let path = Path::new("tests/resources/test_db_kdbx4_with_totp_entry.kdbx");
-        let db = Database::open(&mut File::open(path)?, DatabaseKey::with_password("test"))?;
+        let db = Database::open(
+            &mut File::open(path)?,
+            DatabaseKey::new().with_password("test"),
+        )?;
 
         let otp_str = "otpauth://totp/KeePassXC:none?secret=JBSWY3DPEHPK3PXP&period=30&digits=6&issuer=KeePassXC";
 

diff --git a/src/format/kdbx4/mod.rs b/src/format/kdbx4/mod.rs
@@ -81,7 +81,8 @@ mod kdbx4_tests {
             password += &std::char::from_u32(random_char as u32).unwrap().to_string();
         }
 
-        let key_elements = DatabaseKey::with_password(&password)
+        let key_elements = DatabaseKey::new()
+            .with_password(&password)
             .get_key_elements()
             .unwrap();
 
@@ -172,7 +173,8 @@ mod kdbx4_tests {
 
         db.root.children.push(Node::Entry(entry));
 
-        let key_elements = DatabaseKey::with_password("test")
+        let key_elements = DatabaseKey::new()
+            .with_password("test")
             .get_key_elements()
             .unwrap();