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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

#[doc(inline)]
pub use keyring_native as native;
use log::{debug, trace};
use std::{ops::Deref, result};
use thiserror::Error;

#[derive(Debug, Error)]
pub enum Error {
    #[error("cannot get keyring entry {1}")]
    GetEntryError(#[source] keyring_native::Error, String),
    #[error("cannot get keyring entry secret for key {1}")]
    GetSecretError(#[source] keyring_native::Error, String),
    #[error("cannot find keyring entry secret for key {1}")]
    FindSecretError(#[source] keyring_native::Error, String),
    #[error("cannot set keyring entry secret for key {1}")]
    SetSecretError(#[source] keyring_native::Error, String),
    #[error("cannot delete keyring entry secret for key {1}")]
    DeleteSecretError(#[source] keyring_native::Error, String),
}

pub type Result<T> = result::Result<T, Error>;

const KEYRING_SERVICE: &str = "pimalaya";

/// Alias for the keyring entry key.
pub type Key = String;

/// Keyring entry. It is a simple wrapper around [`keyring::Entry`]
/// that holds a keyring entry key.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Entry(Key);

impl Entry {
    fn get_entry(&self) -> Result<keyring_native::Entry> {
        keyring_native::Entry::new(KEYRING_SERVICE, &self)
            .map_err(|err| Error::GetEntryError(err, self.0.clone()))
    }

    /// Create a new keyring entry with a keyring entry key.
    pub fn new(key: impl ToString) -> Self {
        Self(key.to_string())
    }

    /// Return the inner key of the keyring entry.
    pub fn get_key(&self) -> &str {
        debug!("getting keyring entry key");
        trace!("keyring entry key: {:?}", self.0);
        self.as_str()
    }

    /// Get the secret of the keyring entry.
    pub fn get_secret(&self) -> Result<String> {
        debug!("getting keyring entry secret for key {:?}", self.0);
        self.get_entry()?
            .get_password()
            .map_err(|err| Error::GetSecretError(err, self.0.clone()))
    }

    /// Find the secret of the keyring entry. Return None in case the
    /// secret is not found.
    pub fn find_secret(&self) -> Result<Option<String>> {
        debug!("finding keyring entry secret for key {:?}", self.0);
        match self.get_entry()?.get_password() {
            Err(keyring_native::Error::NoEntry) => Ok(None),
            Err(err) => Err(Error::FindSecretError(err, self.0.clone())),
            Ok(secret) => Ok(Some(secret)),
        }
    }

    /// (Re)set the secret of the keyring entry.
    pub fn set_secret(&self, secret: impl AsRef<str>) -> Result<()> {
        debug!("setting keyring entry secret for key {:?}", self.0);
        self.get_entry()?
            .set_password(secret.as_ref())
            .map_err(|err| Error::SetSecretError(err, self.0.clone()))
    }

    /// Delete the secret of the keyring entry.
    pub fn delete_secret(&self) -> Result<()> {
        debug!("deleting keyring entry secret for key {:?}", self.0);
        self.get_entry()?
            .delete_password()
            .map_err(|err| Error::DeleteSecretError(err, self.0.clone()))
    }
}

impl Deref for Entry {
    type Target = Key;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl From<String> for Entry {
    fn from(key: String) -> Self {
        Self::new(key)
    }
}

impl From<&String> for Entry {
    fn from(key: &String) -> Self {
        Self::new(key)
    }
}

impl From<&str> for Entry {
    fn from(key: &str) -> Self {
        Self::new(key)
    }
}

impl Into<String> for Entry {
    fn into(self) -> String {
        self.0
    }
}

impl ToString for Entry {
    fn to_string(&self) -> String {
        self.0.clone()
    }
}