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

//! This module is related to loading remote.it credentials from the user's home directory.
//! This is of course not the most secure way to store credentials, but it is the most convenient and recommended by remote.it.
//! If you store your credentials in a different way, you can pass them to the functions in this module directly instead of using this module to load them.

use base64::prelude::BASE64_STANDARD;
use base64::Engine;
use bon::bon;

/// Credentials for the remote.it API.
/// Remote.it credentials consist of an access key ID and a base64 encoded secret access key.
///
/// # Example
/// You can directly create a new [`Credentials`] struct using the builder pattern:
/// ```
/// # use remoteit_api::Credentials;
/// let credentials = Credentials::builder()
///     .r3_access_key_id("foo")
///     .r3_secret_access_key("YmFy")
///     .build();
/// ```
/// If you enable the `credentials_loader` feature, you can also load the credentials from the default, or a custom file:
/// ```
/// # use remoteit_api::Credentials;
/// let creds_from_default_loc = Credentials::load_from_disk().call().unwrap();
/// let creds_from_custom_loc = Credentials::load_from_disk().custom_credentials_path(".env.remoteit").call().unwrap();
/// ```
#[derive(
    Debug, Clone, PartialOrd, PartialEq, Eq, Ord, Hash, serde::Deserialize, serde::Serialize,
)]
pub struct Credentials {
    pub(crate) r3_access_key_id: String,
    pub(crate) r3_secret_access_key: String,
    #[serde(skip)] // Don't want to serialize this one
    pub(crate) key: Vec<u8>,
}



#[bon]
impl Credentials {
    /// Validated the given secret access key and creates a new [`Credentials`] struct.
    ///
    /// # Errors
    /// - [`base64::DecodeError`] if the secret access key is not base64 encoded.
    ///
    /// # Example
    /// ```
    /// # use remoteit_api::Credentials;
    /// let credentials = Credentials::builder()
    ///     .r3_access_key_id("foo")
    ///     .r3_secret_access_key("YmFy")
    ///     .build();
    /// ```
    #[builder]
    pub fn new(
        r3_access_key_id: String,
        r3_secret_access_key: String,
    ) -> Result<Self, base64::DecodeError> {
        let key = BASE64_STANDARD.decode(&r3_secret_access_key)?;
        Ok(Self {
            r3_access_key_id,
            r3_secret_access_key,
            key,
        })
    }

    /// # Returns
    /// The base64 decoded secret access key.
    #[must_use]
    pub fn key(&self) -> &[u8] {
        &self.key
    }

    /// # Returns
    /// A reference to the r3_access_key_id
    pub fn access_key_id(&self) -> &str {
        &self.r3_access_key_id
    }

    /// # Returns
    /// The base64 encoded r3_secret_access_key
    pub fn secret_access_key(&self) -> &str {
        &self.r3_secret_access_key
    }
}

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

    #[test]
    fn test_credentials_builder() {
        let credentials = Credentials::builder()
            .r3_access_key_id("foo")
            .r3_secret_access_key("YmFy")
            .build()
            .unwrap();

        assert_eq!(credentials.r3_access_key_id, "foo");
        assert_eq!(credentials.r3_secret_access_key, "YmFy");
    }
}