Skip to main content

capy_auth/
secret.rs

1use rand_core::{OsRng, RngCore};
2use serde::Deserialize;
3use sha2::{Digest, Sha256};
4use std::fmt;
5use zeroize::ZeroizeOnDrop;
6
7/// An input secret: deserializable, deliberately not serializable, redacted in Debug.
8#[derive(Clone, Deserialize, ZeroizeOnDrop)]
9#[serde(transparent)]
10pub struct Secret(String);
11
12impl Secret {
13    /// Wrap a secret owned by the application.
14    pub fn new(value: impl Into<String>) -> Self {
15        Self(value.into())
16    }
17    /// Explicitly access secret bytes, e.g. for an application-owned mail adapter.
18    pub fn expose(&self) -> &str {
19        &self.0
20    }
21}
22impl fmt::Debug for Secret {
23    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
24        f.write_str("Secret([REDACTED])")
25    }
26}
27pub(crate) fn random() -> capy_core::Result<Secret> {
28    let mut bytes = [0u8; 32];
29    OsRng.try_fill_bytes(&mut bytes).map_err(|_| {
30        capy_core::AppError::Configuration("Operating-system randomness unavailable".into())
31    })?;
32    Ok(Secret::new(hex(&bytes)))
33}
34pub(crate) fn digest(value: &str) -> String {
35    hex(&Sha256::digest(value.as_bytes()))
36}
37pub(crate) fn valid_token(value: &str) -> bool {
38    value.len() == 64
39        && value
40            .bytes()
41            .all(|c| c.is_ascii_digit() || (b'a'..=b'f').contains(&c))
42}
43fn hex(bytes: &[u8]) -> String {
44    bytes.iter().map(|byte| format!("{byte:02x}")).collect()
45}
46
47#[cfg(test)]
48mod tests {
49    use super::*;
50    #[test]
51    fn randomness_and_debug_boundaries() {
52        let a = random().unwrap();
53        let b = random().unwrap();
54        assert!(valid_token(a.expose()));
55        assert_ne!(a.expose(), b.expose());
56        assert!(!format!("{a:?}").contains(a.expose()));
57        let model = crate::models::session::ActiveModel {
58            csrf_token: sea_orm::Set(crate::models::DbSecret(a.expose().into())),
59            ..Default::default()
60        };
61        assert!(!format!("{model:?}").contains(a.expose()));
62    }
63}