Merge pull request #7 from TheAwiteb/export-command

`export` command

Cargo.toml

@@ -5,7 +5,7 @@ edition = "2021"
 license = "GPL-3.0-only"
 authors = ["Awiteb <awiteb@hotmail.com>"]
 readme = "README.md"
-description = "Local CLI password manager"
+description = "A local CLI password manager"
 repository = "https://github.com/TheAwiteb/lprs"
 rust-version = "1.70.0"
 keywords = ["password", "manager", "CLI"]

README.md

@@ -6,7 +6,7 @@ Lprs is a local password manager designed to securely store and manage your pass
 
 To install Lprs, you will need to have the Cargo package manager installed. If you do not have Cargo installed, you can install it by following the instructions [here](https://doc.rust-lang.org/cargo/getting-started/installation.html). Note the Minimum Supported Rust Version (MSRV) for Lprs is `1.70.0`.
 
-1. Clone the Lprs repository:
+1. Install using [cargo-install](https://doc.rust-lang.org/cargo/commands/cargo-install.html):
     ```bash
     cargo install --locked --git https://github.com/theawiteb/lprs.git
     ```
@@ -26,18 +26,19 @@ cargo uninstall lprs
 Lprs provides a command-line interface for managing your passwords. The following commands are available:
 
 ```
-Local CLI password manager
+A local CLI password manager
 
 Usage: lprs [OPTIONS] <COMMAND>
 
 Commands:
-  add    Add new password
+  add     Add new password
   remove  Remove password
-  list   List your password and search
+  list    List your password and search
-  clean  Clean the password file
+  clean   Clean the password file
-  edit   Edit the password content
+  edit    Edit the password content
-  gen    Generate password
+  gen     Generate password
-  help   Print this message or the help of the given subcommand(s)
+  export  Export the passwords
+  help    Print this message or the help of the given subcommand(s)
 
 Options:
   -p, --passwords-file <PASSWORDS_FILE>
@@ -66,10 +67,16 @@ Master Password: ***************
 ```
 
 
-<!--
 ### Backup
 
-It is important to regularly backup your passwords to prevent data loss. Lprs does not provide an automatic backup feature. To backup your passwords, you can use the export command provided by Lprs. This command allows you to export your encrypted passwords to a json file, which you can then manually backup to a secure location. -->
+It is important to regularly backup your passwords to prevent data loss. Lprs does not provide an automatic backup feature. To backup your passwords, you can use the `export` command provided by Lprs. This command allows you to export your encrypted passwords to a json file, which you can then manually backup to a secure location.
+
+#### Formats
+The format of the exported file can be specified using the `--format` option. The following formats are supported:
+
+-  `lprs`: The default format used by Lprs. This format is encrypted and can be imported back into Lprs using the `import` command. This is the recommended format to use for backups as it is encrypted and can be imported back into Lprs.
+- `bit-warden`: The format used by [Bitwarden](https://bitwarden.com/). This format is not encrypted and can be imported into Bitwarden. This format is useful if you want to switch to Bitwarden or another password manager that supports this format.
+
 
 
 ## Contributing

src/cli/add_command.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/cli/clean_command.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/cli/edit_command.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/cli/export_command.rs

@@ -0,0 +1,63 @@
+// Lprs - A local CLI password manager
+// Copyright (C) 2024  Awiteb
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/gpl-3.0.html>.
+
+use std::{fs, path::PathBuf};
+
+use clap::{Args, ValueEnum};
+
+use crate::{
+    password::{BitWardenPasswords, Passwords},
+    LprsError, LprsResult, RunCommand,
+};
+
+#[derive(Clone, Debug, ValueEnum)]
+pub enum ExportFormat {
+    Lprs,
+    BitWarden,
+}
+
+#[derive(Debug, Args)]
+#[command(author, version, about, long_about = None)]
+pub struct Export {
+    /// The path to export to
+    path: PathBuf,
+    /// Format to export passwords in
+    #[arg(short, long, value_name = "FORMAT", default_value_t= ExportFormat::Lprs)]
+    format: ExportFormat,
+}
+
+impl ToString for ExportFormat {
+    fn to_string(&self) -> String {
+        self.to_possible_value()
+            .expect("There is no skiped values")
+            .get_name()
+            .to_owned()
+    }
+}
+
+impl RunCommand for Export {
+    fn run(&self, password_manager: Passwords) -> LprsResult<()> {
+        let exported_data = match self.format {
+            ExportFormat::Lprs => serde_json::to_string(&password_manager.encrypt()?.passwords),
+            ExportFormat::BitWarden => {
+                serde_json::to_string(&BitWardenPasswords::from(password_manager))
+            }
+        }
+        .map_err(LprsError::from)?;
+
+        fs::write(&self.path, exported_data).map_err(LprsError::from)
+    }
+}

src/cli/gen_command.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/cli/list_command.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/cli/mod.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify
@@ -26,6 +26,7 @@ use crate::{
 pub mod add_command;
 pub mod clean_command;
 pub mod edit_command;
+pub mod export_command;
 pub mod gen_command;
 pub mod list_command;
 pub mod remove_command;
@@ -38,6 +39,7 @@ crate::create_commands!(
     "Clean the password file", Clean => clean_command::Clean
     "Edit the password content", Edit => edit_command::Edit
     "Generate password", Gen => gen_command::Gen
+    "Export the passwords", Export => export_command::Export
     // TODO: Export command
     // TODO: Import command
 );

src/cli/remove_command.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/errors.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/macros.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/main.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/password/bitwarden.rs

@@ -0,0 +1,71 @@
+use serde::{Deserialize, Serialize};
+
+use super::{Password, Passwords};
+
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub struct BitWardenLoginData {
+    pub username: String,
+    pub password: String,
+    pub uris: Option<Vec<BitWardenUri>>,
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub struct BitWardenUri {
+    #[serde(rename = "match")]
+    pub mt: Option<i32>,
+    pub uri: String,
+}
+
+#[derive(Default, Deserialize, Serialize)]
+pub struct BitWardenFolder {
+    pub id: String,
+    pub name: String,
+}
+
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub struct BitWardenPassword {
+    #[serde(rename = "type")]
+    pub ty: i32,
+    pub name: String,
+    pub login: BitWardenLoginData,
+    pub notes: Option<String>,
+}
+
+/// The bitwarden password struct
+#[derive(Default, Deserialize, Serialize)]
+pub struct BitWardenPasswords {
+    pub encrypted: bool,
+    pub folders: Vec<BitWardenFolder>,
+    pub items: Vec<BitWardenPassword>,
+}
+
+impl From<Password> for BitWardenPassword {
+    fn from(value: Password) -> Self {
+        Self {
+            ty: 1,
+            name: value.name,
+            login: BitWardenLoginData {
+                username: value.username,
+                password: value.password,
+                uris: value
+                    .service
+                    .map(|s| vec![BitWardenUri { mt: None, uri: s }]),
+            },
+            notes: value.note,
+        }
+    }
+}
+
+impl From<Passwords> for BitWardenPasswords {
+    fn from(value: Passwords) -> Self {
+        Self {
+            encrypted: false,
+            folders: Vec::new(),
+            items: value
+                .passwords
+                .into_iter()
+                .map(BitWardenPassword::from)
+                .collect(),
+        }
+    }
+}

src/password/cipher.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/password/mod.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify
@@ -22,23 +22,13 @@ use serde::{Deserialize, Serialize};
 use crate::{LprsError, LprsResult};
 
 pub mod cipher;
+
+mod bitwarden;
 mod validator;
 
+pub use bitwarden::*;
 pub use validator::*;
 
-/// The passwords manager
-#[derive(Default, Deserialize, Serialize)]
-pub struct Passwords {
-    /// Hash of the master password
-    #[serde(skip)]
-    pub master_password: Vec<u8>,
-    /// The json passwords file
-    #[serde(skip)]
-    pub passwords_file: PathBuf,
-    /// The passwords
-    pub passwords: Vec<Password>,
-}
-
 /// The password struct
 #[serde_with_macros::skip_serializing_none]
 #[derive(Clone, Debug, Deserialize, Serialize, Parser)]
@@ -60,6 +50,17 @@ pub struct Password {
     pub note: Option<String>,
 }
 
+/// The passwords manager
+#[derive(Default)]
+pub struct Passwords {
+    /// Hash of the master password
+    pub master_password: Vec<u8>,
+    /// The json passwords file
+    pub passwords_file: PathBuf,
+    /// The passwords
+    pub passwords: Vec<Password>,
+}
+
 impl Password {
     /// Encrypt the password data
     pub fn encrypt(self, master_password: &[u8]) -> LprsResult<Self> {
@@ -111,7 +112,7 @@ impl Passwords {
     }
 
     /// Encrypt the passwords
-    fn encrypt(self) -> LprsResult<Self> {
+    pub fn encrypt(self) -> LprsResult<Self> {
         Ok(Self {
             passwords: self
                 .passwords

src/password/validator.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/traits.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify

src/utils.rs

@@ -1,4 +1,4 @@
-// Local CLI password manager
+// Lprs - A local CLI password manager
 // Copyright (C) 2024  Awiteb
 //
 // This program is free software: you can redistribute it and/or modify