Skip to content

password-hash: deprecate toplevel PasswordHash(String) #2112

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
Dec 7, 2025
Merged

password-hash: deprecate toplevel PasswordHash(String) #2112

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
4 changes: 2 additions & 2 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.

23 changes: 17 additions & 6 deletions password-hash/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,21 @@ pub mod phc;

pub use crate::errors::{Error, Result};

/// DEPRECATED: import this as `password_hash::phc::PasswordHash`.
#[cfg(feature = "phc")]
pub use phc::PasswordHash;
#[deprecated(
since = "0.6.0",
note = "import as `password_hash::phc::PasswordHash` instead"
)]
pub type PasswordHash = phc::PasswordHash;

/// DEPRECATED: import this as `password_hash::phc::PasswordHashString`.
#[cfg(all(feature = "alloc", feature = "phc"))]
pub use phc::PasswordHashString;
#[deprecated(
since = "0.6.0",
note = "import as `password_hash::phc::PasswordHashString` instead"
)]
pub type PasswordHashString = phc::PasswordHashString;

use core::{
fmt::{Debug, Display},
Expand Down Expand Up @@ -101,8 +112,8 @@ pub trait PasswordVerifier<H> {
}

#[cfg(feature = "phc")]
impl<T: CustomizedPasswordHasher<PasswordHash>> PasswordVerifier<PasswordHash> for T {
fn verify_password(&self, password: &[u8], hash: &PasswordHash) -> Result<()> {
impl<T: CustomizedPasswordHasher<phc::PasswordHash>> PasswordVerifier<phc::PasswordHash> for T {
fn verify_password(&self, password: &[u8], hash: &phc::PasswordHash) -> Result<()> {
#[allow(clippy::single_match)]
match (&hash.salt, &hash.hash) {
(Some(salt), Some(expected_output)) => {
Expand Down Expand Up @@ -142,12 +153,12 @@ pub trait McfHasher {
///
/// MCF hashes are otherwise largely unstructured and parsed according to
/// algorithm-specific rules so hashers must parse a raw string themselves.
fn upgrade_mcf_hash(&self, hash: &str) -> Result<PasswordHash>;
fn upgrade_mcf_hash(&self, hash: &str) -> Result<phc::PasswordHash>;

/// Verify a password hash in MCF format against the provided password.
fn verify_mcf_hash(&self, password: &[u8], mcf_hash: &str) -> Result<()>
where
Self: PasswordVerifier<PasswordHash>,
Self: PasswordVerifier<phc::PasswordHash>,
{
self.verify_password(password, &self.upgrade_mcf_hash(mcf_hash)?)
}
Expand Down