sha-crypt 0.6.0

Pure Rust implementation of the SHA-crypt password hashing algorithm based on SHA-256/SHA-512 as implemented by the POSIX crypt C library, including support for generating and verifying password hash strings in the Modular Crypt Format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

use core::{fmt, str::FromStr};
use password_hash::Error;

/// SHA-crypt algorithm variants: SHA-256 or SHA-512.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
#[non_exhaustive]
pub enum Algorithm {
    /// SHA-256-crypt: SHA-crypt instantiated with SHA-256.
    Sha256Crypt,

    /// SHA-512-crypt: SHA-crypt instantiated with SHA-512.
    Sha512Crypt,
}

impl Default for Algorithm {
    /// Recommended default algorithm: SHA-512.
    fn default() -> Self {
        Self::RECOMMENDED
    }
}

impl Algorithm {
    /// SHA-256-crypt Modular Crypt Format algorithm identifier
    pub const SHA256_CRYPT_IDENT: &str = "5";

    /// SHA-512-crypt Modular Crypt Format algorithm identifier
    pub const SHA512_CRYPT_IDENT: &str = "6";

    /// Recommended default algorithm: SHA-512.
    const RECOMMENDED: Self = Self::Sha512Crypt;

    /// Parse an [`Algorithm`] from the provided string.
    ///
    /// # Errors
    /// Returns [`Error::Algorithm`] if `id` is not `5` (SHA-256) or `6` (SHA-512).
    pub fn new(id: impl AsRef<str>) -> password_hash::Result<Self> {
        id.as_ref().parse()
    }

    /// Get the Modular Crypt Format algorithm identifier for this algorithm.
    #[must_use]
    pub const fn to_str(self) -> &'static str {
        match self {
            Algorithm::Sha256Crypt => Self::SHA256_CRYPT_IDENT,
            Algorithm::Sha512Crypt => Self::SHA512_CRYPT_IDENT,
        }
    }
}

impl AsRef<str> for Algorithm {
    fn as_ref(&self) -> &str {
        self.to_str()
    }
}

impl fmt::Display for Algorithm {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.to_str())
    }
}

impl FromStr for Algorithm {
    type Err = Error;

    fn from_str(s: &str) -> password_hash::Result<Algorithm> {
        s.try_into()
    }
}

impl<'a> TryFrom<&'a str> for Algorithm {
    type Error = Error;

    fn try_from(name: &'a str) -> password_hash::Result<Algorithm> {
        match name {
            Self::SHA256_CRYPT_IDENT => Ok(Algorithm::Sha256Crypt),
            Self::SHA512_CRYPT_IDENT => Ok(Algorithm::Sha512Crypt),
            _ => Err(Error::Algorithm),
        }
    }
}