sha_crypt/
algorithm.rs

1use core::{fmt, str::FromStr};
2use password_hash::Error;
3
4/// SHA-crypt algorithm variants: SHA-256 or SHA-512.
5#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
6#[non_exhaustive]
7pub enum Algorithm {
8    /// SHA-256-crypt: SHA-crypt instantiated with SHA-256.
9    Sha256Crypt,
10
11    /// SHA-512-crypt: SHA-crypt instantiated with SHA-512.
12    Sha512Crypt,
13}
14
15impl Default for Algorithm {
16    /// Recommended default algorithm: SHA-512.
17    fn default() -> Self {
18        Self::RECOMMENDED
19    }
20}
21
22impl Algorithm {
23    /// SHA-256-crypt Modular Crypt Format algorithm identifier
24    pub const SHA256_CRYPT_IDENT: &str = "5";
25
26    /// SHA-512-crypt Modular Crypt Format algorithm identifier
27    pub const SHA512_CRYPT_IDENT: &str = "6";
28
29    /// Recommended default algorithm: SHA-512.
30    const RECOMMENDED: Self = Self::Sha512Crypt;
31
32    /// Parse an [`Algorithm`] from the provided string.
33    pub fn new(id: impl AsRef<str>) -> password_hash::Result<Self> {
34        id.as_ref().parse()
35    }
36
37    /// Get the Modular Crypt Format algorithm identifier for this algorithm.
38    pub const fn to_str(self) -> &'static str {
39        match self {
40            Algorithm::Sha256Crypt => Self::SHA256_CRYPT_IDENT,
41            Algorithm::Sha512Crypt => Self::SHA512_CRYPT_IDENT,
42        }
43    }
44}
45
46impl AsRef<str> for Algorithm {
47    fn as_ref(&self) -> &str {
48        self.to_str()
49    }
50}
51
52impl fmt::Display for Algorithm {
53    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
54        f.write_str(self.to_str())
55    }
56}
57
58impl FromStr for Algorithm {
59    type Err = Error;
60
61    fn from_str(s: &str) -> password_hash::Result<Algorithm> {
62        s.try_into()
63    }
64}
65
66impl<'a> TryFrom<&'a str> for Algorithm {
67    type Error = Error;
68
69    fn try_from(name: &'a str) -> password_hash::Result<Algorithm> {
70        match name {
71            Self::SHA256_CRYPT_IDENT => Ok(Algorithm::Sha256Crypt),
72            Self::SHA512_CRYPT_IDENT => Ok(Algorithm::Sha512Crypt),
73            _ => Err(Error::Algorithm),
74        }
75    }
76}
sha_crypt/algorithm.rs

sha_crypt/
algorithm.rs
