Skip to content

pbkdf2: use Base64::Pbkdf2 #815

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tarcieri merged 1 commit into from
Jan 12, 2026
Merged

pbkdf2: use Base64::Pbkdf2 #815

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ opt-level = 2
argon2 = { path = "./argon2" }
pbkdf2 = { path = "./pbkdf2" }
scrypt = { path = "./scrypt" }

mcf = { git = "https://github.com/RustCrypto/formats", branch = "base64ct/pbkdf2-alphabet" }
3 changes: 0 additions & 3 deletions pbkdf2/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,6 @@
//! # }
//! ```

#[cfg(feature = "mcf")]
extern crate alloc;

#[cfg(feature = "mcf")]
pub mod mcf;
#[cfg(feature = "phc")]
Expand Down
46 changes: 14 additions & 32 deletions pbkdf2/src/mcf.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
pub use mcf::{PasswordHash, PasswordHashRef};

use crate::{Algorithm, Params, Pbkdf2, pbkdf2_hmac};
use alloc::{string::String, vec::Vec};
use mcf::Base64;
use password_hash::{
CustomizedPasswordHasher, Error, PasswordHasher, PasswordVerifier, Result, Version,
Expand Down Expand Up @@ -55,19 +54,11 @@ impl CustomizedPasswordHasher<PasswordHash> for Pbkdf2 {
f(password, salt, params.rounds(), out);

let mut mcf_hash = PasswordHash::from_id(algorithm.to_str()).expect("should have valid ID");

mcf_hash
.push_displayable(params)
.map_err(|_| Error::EncodingInvalid)?;

mcf_hash
.push_str(&base64_encode(salt))
.map_err(|_| Error::EncodingInvalid)?;

mcf_hash
.push_str(&base64_encode(out))
.map_err(|_| Error::EncodingInvalid)?;

mcf_hash.push_base64(salt, Base64::Pbkdf2);
mcf_hash.push_base64(out, Base64::Pbkdf2);
Ok(mcf_hash)
}
}
Expand Down Expand Up @@ -97,13 +88,17 @@ impl PasswordVerifier<PasswordHashRef> for Pbkdf2 {
next = fields.next().ok_or(Error::EncodingInvalid)?;
}

let salt = base64_decode(next.as_str())?;
// decode salt
let salt = next
.decode_base64(Base64::Pbkdf2)
.map_err(|_| Error::EncodingInvalid)?;

// decode expected password hash
let expected = fields
.next()
.ok_or(Error::EncodingInvalid)
.and_then(|field| base64_decode(field.as_str()))?;
.ok_or(Error::EncodingInvalid)?
.decode_base64(Base64::Pbkdf2)
.map_err(|_| Error::EncodingInvalid)?;

// should be the last field
if fields.next().is_some() {
Expand Down Expand Up @@ -136,25 +131,12 @@ impl PasswordVerifier<PasswordHashRef> for Pbkdf2 {
}
}

// Base64 support: PBKDF2 uses a variant of standard unpadded Base64 which substitutes the `+`
// character for `.` and this is a distinct encoding from the bcrypt and crypt Base64 variants.

fn base64_decode(base64: &str) -> Result<Vec<u8>> {
Base64::B64
.decode_vec(&base64.replace('.', "+"))
.map_err(|_| Error::EncodingInvalid)
}

fn base64_encode(bytes: &[u8]) -> String {
Base64::B64.encode_string(bytes).replace('+', ".")
}

// TODO(tarcieri): tests for SHA-1 and SHA-512
// TODO(tarcieri): tests for SHA-1
#[cfg(test)]
mod tests {
use super::{Error, base64_decode};
use super::Error;
use crate::{Params, Pbkdf2};
use mcf::PasswordHash;
use mcf::{Base64, PasswordHash};
use password_hash::{CustomizedPasswordHasher, PasswordVerifier};

// Example adapted from:
Expand All @@ -167,7 +149,7 @@ mod tests {
const EXAMPLE_HASH: &str =
"$pbkdf2-sha256$8000$XAuBMIYQQogxRg$tRRlz8hYn63B9LYiCd6PRo6FMiunY9ozmMMI3srxeRE";

let salt = base64_decode(EXAMPLE_SALT).unwrap();
let salt = Base64::Pbkdf2.decode_vec(EXAMPLE_SALT).unwrap();
let params = Params::new(EXAMPLE_ROUNDS).unwrap();

let actual_hash: PasswordHash = Pbkdf2::SHA256
Expand Down Expand Up @@ -197,7 +179,7 @@ mod tests {
const EXAMPLE_SALT: &str = "O4fwPmdMyRmDUIrx/h9jTA";
const EXAMPLE_HASH: &str = "$pbkdf2-sha512$25000$O4fwPmdMyRmDUIrx/h9jTA$Xlp267ZwEbG4aOpN3Bve/ATo3rFA7WH8iMdS16Xbe9rc6P5welk1yiXEMPy7.BFp0qsncipHumaW1trCWVvq/A";

let salt = base64_decode(EXAMPLE_SALT).unwrap();
let salt = Base64::Pbkdf2.decode_vec(EXAMPLE_SALT).unwrap();
let params = Params::new_with_output_len(EXAMPLE_ROUNDS, 64).unwrap();

let actual_hash: PasswordHash = Pbkdf2::SHA512
Expand Down