nextcloud-auth 0.1.3

Credential types for the Nextcloud Rust SDK
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

use std::fmt;

use crate::SecretString;

/// An OAuth2 access token issued by a Nextcloud instance.
///
/// The token is kept behind [`SecretString`] so no `Debug` or log line can
/// reveal it; request the plaintext through [`BearerToken::expose`].
#[derive(Clone)]
pub struct BearerToken {
    secret: SecretString,
}

impl BearerToken {
    /// Wraps a token string.
    pub fn new(token: impl Into<String>) -> Self {
        Self {
            secret: SecretString::new(token),
        }
    }

    /// Borrows the token plaintext.
    pub fn expose(&self) -> &str {
        self.secret.expose()
    }
}

impl fmt::Debug for BearerToken {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_tuple("BearerToken").field(&self.secret).finish()
    }
}

#[cfg(test)]
mod tests {
    use super::BearerToken;

    #[test]
    fn debug_redacts_the_token() {
        let token = BearerToken::new("ghp-s3cr3t-access-token");
        let rendered = format!("{token:?}");
        assert!(!rendered.contains("ghp-s3cr3t-access-token"));
        assert!(rendered.contains("<redacted>"));
    }

    #[test]
    fn expose_returns_the_token() {
        assert_eq!(BearerToken::new("abc").expose(), "abc");
    }
}