Merge pull request #702 from Aderemi-Adesada/prompt_confirm_password

allow request for new key to confirm entered pass

Cargo.toml

@@ -108,7 +108,7 @@ merge = { workspace = true }
 
 directories = { workspace = true }
 nom = { workspace = true }
-rpassword = { workspace = true }
+dialoguer = "0.10.4"
 bytesize = { workspace = true }
 indicatif = { workspace = true }
 path-dedot = { workspace = true }
@@ -232,7 +232,6 @@ cachedir = "0.3"
 
 # commands
 merge = "0.1"
-rpassword = "7"
 directories = "5"
 nom = "7"
 indicatif = "0.17"

changelog/new.txt

@@ -12,3 +12,4 @@ New features:
 - New option: `no-require-git` for backup - if enabled, a git repository is not required to apply `git-ignore` rule.
 - fix: wait for password-command to successfully exit, allowing to input something into the command, and read password from stdout.
 - repoinfo: Added new options --json, --only-files, --only-index
+- Creation of new keys now enforces confirmation of entered key. This helps to prevent mistype of passwords during the initial entry

crates/rustic_core/Cargo.toml

@@ -94,7 +94,7 @@ clap = { workspace = true, optional = true }
 clap_complete = { workspace = true, optional = true }
 
 merge = { workspace = true, optional = true }
-rpassword = { workspace = true }
+dialoguer = "0.10.4"
 directories = { workspace = true }
 nom = { workspace = true }
 path-dedot = { workspace = true }

crates/rustic_core/src/lib.rs

@@ -146,5 +146,5 @@ pub use crate::{
         },
         RepoFile,
     },
-    repository::{OpenRepository, Repository, RepositoryOptions},
+    repository::{read_password_from_reader, OpenRepository, Repository, RepositoryOptions},
 };

crates/rustic_core/src/repository.rs

@@ -18,7 +18,7 @@ use nom::{
     sequence::delimited,
     IResult,
 };
-use rpassword::prompt_password;
+use dialoguer::Password;
 
 use serde_with::{serde_as, DisplayFromStr};
 
@@ -155,7 +155,7 @@ pub fn parse_command<'a, E: ParseError<&'a str>>(
     )(input)
 }
 
-pub(crate) fn read_password_from_reader(file: &mut impl BufRead) -> RusticResult<String> {
+pub fn read_password_from_reader(file: &mut impl BufRead) -> RusticResult<String> {
     let mut password = String::new();
     _ = file
         .read_line(&mut password)
@@ -350,7 +350,10 @@ pub(crate) fn get_key(be: &impl ReadBackend, password: Option<String>) -> Rustic
                 // TODO: Differentiate between wrong password and other error!
                 if let Ok(key) = find_key_in_backend(
                     be,
-                    &prompt_password("enter repository password: ")
+                    &Password::new()
+                        .with_prompt("enter repository password")
+                        .allow_empty_password(true)
+                        .interact()
                         .map_err(RepositoryErrorKind::ReadingPasswordFromPromptFailed)?,
                     None,
                 ) {

src/commands/init.rs

@@ -8,7 +8,7 @@ use anyhow::{bail, Result};
 use crate::{commands::get_repository, Application, RUSTIC_APP};
 
 use bytes::Bytes;
-use rpassword::prompt_password;
+use dialoguer::Password;
 
 use rustic_core::{
     hash, random_poly, ConfigFile, DecryptBackend, DecryptWriteBackend, FileType, Id, Key, KeyFile,
@@ -80,7 +80,11 @@ pub(crate) fn save_config(
     let key = Key::new();
 
     let pass = password.map_or_else(
-        || match prompt_password("enter password for new key: ") {
+        || match Password::new().with_prompt("enter password for new key")
+        .allow_empty_password(true)
+        .with_confirmation("confirm password", "passwords do not match")
+        .interact()
+        {
             Ok(it) => it,
             Err(err) => {
                 status_err!("{}", err);

src/commands/key.rs

@@ -12,9 +12,9 @@ use anyhow::Result;
 
 use std::{fs::File, io::BufReader};
 
-use rpassword::{prompt_password, read_password_from_bufread};
+use dialoguer::Password;
 
-use rustic_core::{hash, FileType, KeyFile, WriteBackend};
+use rustic_core::{hash, read_password_from_reader, FileType, KeyFile, WriteBackend};
 
 /// `key` subcommand
 #[derive(clap::Parser, Command, Debug)]
@@ -79,7 +79,11 @@ impl AddCmd {
         let key = repo.key;
 
         let pass = self.new_password_file.as_ref().map_or_else(
-            || match prompt_password("enter password for new key: ") {
+            || match Password::new().with_prompt("enter password for new key")
+            .allow_empty_password(true)
+            .with_confirmation("confirm password", "passwords do not match")
+            .interact()
+            {
                 Ok(it) => it,
                 Err(err) => {
                     status_err!("{}", err);
@@ -94,7 +98,7 @@ impl AddCmd {
                         RUSTIC_APP.shutdown(Shutdown::Crash);
                     }
                 });
-                match read_password_from_bufread(&mut file) {
+                match read_password_from_reader(&mut file) {
                     Ok(it) => it,
                     Err(err) => {
                         status_err!("{}", err);