feat: Support TOTP
All checks were successful
Rust CI / Rust CI (pull_request) Successful in 2m28s
Write changelog / write-changelog (push) Successful in 3s
Rust CI / Rust CI (push) Successful in 2m3s

This commit is contained in:
Awiteb 2024-05-11 13:56:32 +03:00
parent 3f72e8a26a
commit 6f83bcccf9
Signed by: awiteb
GPG key ID: 3F6B55640AA6682F
7 changed files with 141 additions and 23 deletions

View file

@ -31,10 +31,14 @@ use crate::{
pub struct Add { pub struct Add {
#[command(flatten)] #[command(flatten)]
vault_info: Vault, vault_info: Vault,
/// The password, if there is no value for it you will prompt it /// The password, if there is no value you will prompt it
#[arg(short, long)] #[arg(short, long)]
#[allow(clippy::option_option)] #[allow(clippy::option_option)]
password: Option<Option<String>>, password: Option<Option<String>>,
/// The TOTP secret, if there is no value you will prompt it
#[arg(short, long)]
#[allow(clippy::option_option)]
totp_secret: Option<Option<String>>,
/// Add a custom field to the vault /// Add a custom field to the vault
#[arg(name = "KEY=VALUE", short = 'c', long = "custom")] #[arg(name = "KEY=VALUE", short = 'c', long = "custom")]
#[arg(value_parser = clap_parsers::kv_parser)] #[arg(value_parser = clap_parsers::kv_parser)]

View file

@ -28,31 +28,35 @@ pub struct Edit {
#[arg(short, long)] #[arg(short, long)]
/// The new vault name /// The new vault name
name: Option<String>, name: Option<String>,
#[arg(short, long)] #[arg(short, long)]
/// The new vault username /// The new vault username
username: Option<String>, username: Option<String>,
#[arg(short, long)] #[arg(short, long)]
/// The new password, if there is no value for it you will prompt it /// The new password, if there is no value for it you will prompt it
#[allow(clippy::option_option)] #[allow(clippy::option_option)]
password: Option<Option<String>>, password: Option<Option<String>>,
#[arg(short, long)] #[arg(short, long)]
/// The new vault service /// The new vault service
service: Option<String>, service: Option<String>,
#[arg(short = 'o', long)] #[arg(short = 'o', long)]
/// The new vault note /// The new vault note
note: Option<String>, note: Option<String>,
/// The TOTP secret, if there is no value you will prompt it
#[arg(short, long)]
#[allow(clippy::option_option)]
totp_secret: Option<Option<String>>,
/// The custom field, make its value empty to delete it /// The custom field, make its value empty to delete it
/// ///
/// If the custom field not exist will created it, if it's will update it /// If the custom field not exist will created it, if it's will update it
#[arg(name = "KEY=VALUE", short = 'c', long = "custom")] #[arg(name = "KEY=VALUE", short = 'c', long = "custom")]
#[arg(value_parser = clap_parsers::kv_parser)] #[arg(value_parser = clap_parsers::kv_parser)]
pub custom_fields: Vec<(String, String)>, custom_fields: Vec<(String, String)>,
/// Force edit, will not return error if there is a problem with the args. /// Force edit, will not return error if there is a problem with the args.
/// ///
/// For example, duplication in the custom fields and try to editing nothing /// For example, duplication in the custom fields and try to editing nothing
#[arg(short, long)] #[arg(short, long)]
force: bool, force: bool,
} }
impl LprsCommand for Edit { impl LprsCommand for Edit {
@ -75,6 +79,9 @@ impl LprsCommand for Edit {
if self.password.is_some() { if self.password.is_some() {
vault.password = utils::user_secret(self.password, "New vault password:")?; vault.password = utils::user_secret(self.password, "New vault password:")?;
} }
if self.totp_secret.is_some() {
vault.totp_secret = utils::user_secret(self.totp_secret, "TOTP Secret:")?;
}
if let Some(new_username) = self.username { if let Some(new_username) = self.username {
vault.username = Some(new_username); vault.username = Some(new_username);
} }

View file

@ -20,7 +20,7 @@ use clap::Args;
use crate::{ use crate::{
utils, utils,
vault::{Vault, Vaults}, vault::{cipher, Vault, Vaults},
LprsCommand, LprsCommand,
LprsError, LprsError,
LprsResult, LprsResult,
@ -34,6 +34,8 @@ enum VaultGetField {
Password, Password,
Service, Service,
Note, Note,
TotpSecret,
TotpCode,
Custom(String), Custom(String),
} }
@ -48,6 +50,8 @@ impl FromStr for VaultGetField {
"password" => Self::Password, "password" => Self::Password,
"service" => Self::Service, "service" => Self::Service,
"note" => Self::Note, "note" => Self::Note,
"totp_secret" => Self::TotpSecret,
"totp_code" => Self::TotpCode,
_ => Self::Custom(input.to_owned()), _ => Self::Custom(input.to_owned()),
}) })
} }
@ -63,6 +67,8 @@ impl VaultGetField {
Self::Password => vault.password.as_deref(), Self::Password => vault.password.as_deref(),
Self::Service => vault.service.as_deref(), Self::Service => vault.service.as_deref(),
Self::Note => vault.note.as_deref(), Self::Note => vault.note.as_deref(),
Self::TotpSecret => vault.totp_secret.as_deref(),
Self::TotpCode => None,
Self::Custom(custom_field) => vault.custom_fields.get(custom_field).map(|x| x.as_str()), Self::Custom(custom_field) => vault.custom_fields.get(custom_field).map(|x| x.as_str()),
} }
} }
@ -76,6 +82,8 @@ impl VaultGetField {
Self::Password => "password", Self::Password => "password",
Self::Service => "service", Self::Service => "service",
Self::Note => "note", Self::Note => "note",
Self::TotpSecret => "totp_secret",
Self::TotpCode => "totp_code",
Self::Custom(field) => field.as_str(), Self::Custom(field) => field.as_str(),
} }
} }
@ -90,8 +98,10 @@ pub struct Get {
location: String, location: String,
/// A Specific field to get. /// A Specific field to get.
/// ///
/// Can be [name,username,password,service,note,"string"] where the string /// Can be [name, username, password, service, note, totp_secret, totp_code,
/// means a custom field /// "string"]
///
/// where the string means a custom field
#[arg(value_parser = VaultGetField::from_str)] #[arg(value_parser = VaultGetField::from_str)]
field: Option<VaultGetField>, field: Option<VaultGetField>,
} }
@ -106,13 +116,25 @@ impl LprsCommand for Get {
print!("{index}"); print!("{index}");
return Ok(()); return Ok(());
} }
if field == VaultGetField::TotpCode {
if let Some(ref totp_secret) = vault.totp_secret {
let totp_code = cipher::totp_now(totp_secret, &vault.totp_hash)?.0;
print!("{totp_code}");
return Ok(());
} else {
return Err(LprsError::Other(
"There is no TOTP secret to get TOTP code".to_owned(),
));
}
}
if let Some(value) = field.get_from_vault(vault) { if let Some(value) = field.get_from_vault(vault) {
print!("{value}") print!("{value}")
} else { } else {
return Err(LprsError::Other(format!( return Err(LprsError::Other(format!(
"There is no value for `{}`", "There is no value for `{}` at \"{}\" vault",
field.as_str() field.as_str(),
vault.name
))); )));
} }
} else { } else {

View file

@ -17,7 +17,13 @@
use clap::Args; use clap::Args;
use inquire::{InquireError, Select}; use inquire::{InquireError, Select};
use crate::{vault::Vaults, LprsCommand, LprsError, LprsResult}; use crate::{
vault::{cipher, Vaults},
LprsCommand,
LprsError,
LprsResult,
RESERVED_FIELD_PREFIX,
};
#[derive(Debug, Args)] #[derive(Debug, Args)]
#[command(author, version, about, long_about = None)] #[command(author, version, about, long_about = None)]
@ -35,7 +41,7 @@ pub struct List {
} }
impl LprsCommand for List { impl LprsCommand for List {
fn run(self, vault_manager: Vaults) -> LprsResult<()> { fn run(self, mut vault_manager: Vaults) -> LprsResult<()> {
if vault_manager.vaults.is_empty() { if vault_manager.vaults.is_empty() {
return Err(LprsError::Other( return Err(LprsError::Other(
"Looks like there is no vaults to list".to_owned(), "Looks like there is no vaults to list".to_owned(),
@ -95,13 +101,20 @@ impl LprsCommand for List {
log::debug!("The user selected the vault at index: {vault_idx}"); log::debug!("The user selected the vault at index: {vault_idx}");
println!( let vault = vault_manager
"{}", .vaults
vault_manager .get_mut(vault_idx - 1)
.vaults .expect("The index is correct");
.get(vault_idx - 1)
.expect("The index is correct") if let Some(ref totp_secret) = vault.totp_secret {
); let (code, remaining) = cipher::totp_now(totp_secret, &vault.totp_hash)?;
vault.custom_fields.insert(
format!("{RESERVED_FIELD_PREFIX}TOTP Code"),
format!("{code} ({remaining}s remaining)"),
);
}
println!("{vault}",);
} }
Ok(()) Ok(())

View file

@ -20,7 +20,7 @@
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use super::{Vault, Vaults}; use super::{cipher::TotpHash, Vault, Vaults};
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]
pub struct BitWardenLoginData { pub struct BitWardenLoginData {
@ -84,6 +84,8 @@ impl From<BitWardenPassword> for Vault {
.into_iter() .into_iter()
.map(|nv| (nv.name, nv.value)) .map(|nv| (nv.name, nv.value))
.collect(), .collect(),
None::<String>,
TotpHash::default(),
) )
} }
} }

View file

@ -17,13 +17,63 @@
use std::time::{SystemTime, UNIX_EPOCH}; use std::time::{SystemTime, UNIX_EPOCH};
use aes::cipher::{block_padding::Pkcs7, BlockDecryptMut, BlockEncryptMut, KeyIvInit}; use aes::cipher::{block_padding::Pkcs7, BlockDecryptMut, BlockEncryptMut, KeyIvInit};
use base32::Alphabet as Base32Alphabet;
use clap::ValueEnum;
use rand::{rngs::StdRng, Rng, SeedableRng}; use rand::{rngs::StdRng, Rng, SeedableRng};
use serde::{Deserialize, Serialize};
use crate::{LprsError, LprsResult}; use crate::{LprsError, LprsResult};
type Aes256CbcEnc = cbc::Encryptor<aes::Aes256>; type Aes256CbcEnc = cbc::Encryptor<aes::Aes256>;
type Aes256CbcDec = cbc::Decryptor<aes::Aes256>; type Aes256CbcDec = cbc::Decryptor<aes::Aes256>;
#[derive(Default, Clone, Debug, ValueEnum, Eq, PartialEq, Deserialize, Serialize)]
/// The TOTP hash functions
pub enum TotpHash {
/// Sha1 hash function
#[default]
Sha1,
/// Sha256 hash function
Sha256,
/// Sha512 hash function
Sha512,
}
/// Create the TOTP code of the current time
///
/// ## Errors
/// - If the given `secret_base32` are vaild base32
pub fn totp_now(secret_base32: &str, hash_function: &TotpHash) -> LprsResult<(String, u8)> {
let now = SystemTime::now()
.duration_since(UNIX_EPOCH)
.expect("SystemTime before UNIX EPOCH!")
.as_secs();
let remaining = 30 - (now % 30) as u8;
let secret = base32::decode(Base32Alphabet::RFC4648 { padding: true }, secret_base32)
.ok_or_else(|| LprsError::Base32("Can't decode the TOTP secret".to_owned()))?;
Ok(match hash_function {
TotpHash::Sha1 => {
(
totp_lite::totp_custom::<totp_lite::Sha1>(30, 6, &secret, now),
remaining,
)
}
TotpHash::Sha256 => {
(
totp_lite::totp_custom::<totp_lite::Sha256>(30, 6, &secret, now),
remaining,
)
}
TotpHash::Sha512 => {
(
totp_lite::totp_custom::<totp_lite::Sha512>(30, 6, &secret, now),
remaining,
)
}
})
}
/// Encrypt the given data by the given key using AES-256 CBC /// Encrypt the given data by the given key using AES-256 CBC
/// ///
/// Note: The IV will be add it to the end of the ciphertext (Last 16 bytes) /// Note: The IV will be add it to the end of the ciphertext (Last 16 bytes)

View file

@ -29,6 +29,8 @@ mod bitwarden;
pub use bitwarden::*; pub use bitwarden::*;
use self::cipher::TotpHash;
#[derive(Clone, Debug, ValueEnum, Eq, PartialEq)] #[derive(Clone, Debug, ValueEnum, Eq, PartialEq)]
/// The vaults format /// The vaults format
pub enum Format { pub enum Format {
@ -61,6 +63,12 @@ pub struct Vault {
/// The vault custom fields /// The vault custom fields
#[arg(skip)] #[arg(skip)]
pub custom_fields: BTreeMap<String, String>, pub custom_fields: BTreeMap<String, String>,
/// The TOTP secret
#[arg(skip)]
pub totp_secret: Option<String>,
/// The TOTP hash function
#[arg(long, value_name = "HASH_FUNCTION", value_enum, default_value_t)]
pub totp_hash: TotpHash,
} }
/// The vaults manager /// The vaults manager
@ -76,6 +84,7 @@ pub struct Vaults {
impl Vault { impl Vault {
/// Create new [`Vault`] instance /// Create new [`Vault`] instance
#[allow(clippy::too_many_arguments)]
pub fn new( pub fn new(
name: impl Into<String>, name: impl Into<String>,
username: Option<impl Into<String>>, username: Option<impl Into<String>>,
@ -83,6 +92,8 @@ impl Vault {
service: Option<impl Into<String>>, service: Option<impl Into<String>>,
note: Option<impl Into<String>>, note: Option<impl Into<String>>,
custom_fields: BTreeMap<String, String>, custom_fields: BTreeMap<String, String>,
totp_secret: Option<impl Into<String>>,
totp_hash: TotpHash,
) -> Self { ) -> Self {
Self { Self {
name: name.into(), name: name.into(),
@ -91,6 +102,8 @@ impl Vault {
service: service.map(Into::into), service: service.map(Into::into),
note: note.map(Into::into), note: note.map(Into::into),
custom_fields, custom_fields,
totp_secret: totp_secret.map(Into::into),
totp_hash,
} }
} }
@ -163,6 +176,8 @@ impl Vaults {
.iter() .iter()
.map(|(key, value)| (encrypt(key), encrypt(value))) .map(|(key, value)| (encrypt(key), encrypt(value)))
.collect(), .collect(),
v.totp_secret.as_ref().map(|t| encrypt(t)),
v.totp_hash.clone(),
)) ))
}) })
.collect::<LprsResult<Vec<_>>>()?, .collect::<LprsResult<Vec<_>>>()?,
@ -199,6 +214,8 @@ impl Vaults {
.into_iter() .into_iter()
.map(|(key, value)| LprsResult::Ok((decrypt(&key)?, decrypt(&value)?))) .map(|(key, value)| LprsResult::Ok((decrypt(&key)?, decrypt(&value)?)))
.collect::<LprsResult<_>>()?, .collect::<LprsResult<_>>()?,
v.totp_secret.as_ref().and_then(|t| decrypt(t).ok()),
v.totp_hash,
)) ))
}) })
.collect() .collect()
@ -266,6 +283,9 @@ impl fmt::Display for Vault {
if let Some(ref note) = self.note { if let Some(ref note) = self.note {
write!(f, "\nNote:\n{note}")?; write!(f, "\nNote:\n{note}")?;
} }
if let Some(ref totp_secret) = self.totp_secret {
write!(f, "\nTOTP Secret: {totp_secret}")?;
}
for (key, value) in &self.custom_fields { for (key, value) in &self.custom_fields {
write!( write!(
f, f,