phc 0.6.1

Pure Rust implementation of the Password Hashing Competition (PHC) string format which is used for storing password hashes
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use crate::{Error, Result};
use core::{
    fmt,
    ops::Deref,
    str::{self, FromStr},
};

/// Buffer for storing short stack-allocated strings.
#[derive(Clone, Copy, Eq, Hash, PartialEq, PartialOrd, Ord)]
pub(super) struct StringBuf<const N: usize> {
    /// Length of the string in ASCII characters (i.e. bytes).
    pub(super) length: u8,

    /// Byte array containing an ASCII-encoded string.
    pub(super) bytes: [u8; N],
}

impl<const N: usize> StringBuf<N> {
    /// Create a new string buffer containing the given string
    pub(super) const fn new(s: &str) -> Result<Self> {
        if s.len() > N || s.len() > u8::MAX as usize {
            return Err(Error::ValueTooLong);
        }

        let mut bytes = [0u8; N];
        let mut i = 0;

        while i < s.len() {
            bytes[i] = s.as_bytes()[i];
            i += 1;
        }

        Ok(Self {
            bytes,
            length: s.len() as u8,
        })
    }
}

impl<const N: usize> AsRef<str> for StringBuf<N> {
    fn as_ref(&self) -> &str {
        str::from_utf8(&self.bytes[..(self.length as usize)]).expect("should be valid UTF-8")
    }
}

impl<const N: usize> Default for StringBuf<N> {
    fn default() -> Self {
        StringBuf {
            bytes: [0u8; N],
            length: 0,
        }
    }
}

impl<const N: usize> Deref for StringBuf<N> {
    type Target = str;

    fn deref(&self) -> &str {
        self.as_ref()
    }
}

impl<const N: usize> FromStr for StringBuf<N> {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        Self::new(s)
    }
}

impl<const N: usize> TryFrom<&str> for StringBuf<N> {
    type Error = Error;

    fn try_from(s: &str) -> Result<Self> {
        Self::new(s)
    }
}

impl<const N: usize> fmt::Debug for StringBuf<N> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_ref())
    }
}

impl<const N: usize> fmt::Display for StringBuf<N> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.as_ref())
    }
}

impl<const N: usize> fmt::Write for StringBuf<N> {
    fn write_str(&mut self, input: &str) -> fmt::Result {
        const { debug_assert!(N <= u8::MAX as usize) }

        let bytes = input.as_bytes();
        let length = self.length as usize;
        let new_length = length.checked_add(bytes.len()).ok_or(fmt::Error)?;

        if new_length > N {
            return Err(fmt::Error);
        }

        self.bytes[length..new_length].copy_from_slice(bytes);
        self.length = new_length.try_into().map_err(|_| fmt::Error)?;

        Ok(())
    }
}