im-core 0.1.0

Rust IM SDK for Awiki clients built on Agent Network Protocol (ANP)
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use std::fmt;
use std::sync::Mutex;

use serde_json::Value;

pub(crate) struct HostedKeyMaterialProvider {
    did_document: Value,
    default_signing_private_pem: String,
    e2ee_agreement_private_pem: String,
    auth_state: Mutex<crate::internal::auth::state::AuthStateSnapshot>,
}

impl HostedKeyMaterialProvider {
    pub(crate) fn new(material: &crate::identity::HostedIdentityMaterial) -> crate::ImResult<Self> {
        Ok(Self {
            did_document: material.did_document.clone(),
            default_signing_private_pem: require_non_empty_secret(
                "default_signing_private_key_pem",
                &material.default_signing_private_key_pem,
            )?,
            e2ee_agreement_private_pem: require_non_empty_secret(
                "e2ee_agreement_private_key_pem",
                &material.e2ee_agreement_private_key_pem,
            )?,
            auth_state: Mutex::new(auth_state_from_token(material.auth_token.as_deref())?),
        })
    }
}

impl fmt::Debug for HostedKeyMaterialProvider {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("HostedKeyMaterialProvider")
            .field("backend", &"hosted-memory")
            .field("did_document", &"<redacted-hosted-did-document>")
            .field("default_signing_private_pem", &"<redacted-private-key>")
            .field("e2ee_agreement_private_pem", &"<redacted-private-key>")
            .field("auth_state", &"<redacted-auth-state>")
            .finish_non_exhaustive()
    }
}

impl super::KeyMaterialProvider for HostedKeyMaterialProvider {
    fn did_document(&self) -> crate::ImResult<Value> {
        Ok(self.did_document.clone())
    }

    fn optional_did_document(&self) -> crate::ImResult<Option<Value>> {
        Ok(Some(self.did_document.clone()))
    }

    fn default_signing_private_pem(&self) -> crate::ImResult<String> {
        Ok(self.default_signing_private_pem.clone())
    }

    fn e2ee_agreement_private_pem(&self) -> crate::ImResult<String> {
        Ok(self.e2ee_agreement_private_pem.clone())
    }

    fn auth_state(&self) -> crate::ImResult<crate::internal::auth::state::AuthStateSnapshot> {
        self.auth_state
            .lock()
            .map_err(|_| crate::ImError::Internal {
                message: "hosted auth state lock poisoned".to_owned(),
            })
            .map(|snapshot| snapshot.clone())
    }

    fn valid_auth_token(&self) -> crate::ImResult<Option<String>> {
        Ok(self.auth_state()?.bearer_token)
    }

    fn persist_auth_token(&self, token: &str) -> crate::ImResult<()> {
        let next = auth_state_from_token(Some(token))?;
        let mut guard = self
            .auth_state
            .lock()
            .map_err(|_| crate::ImError::Internal {
                message: "hosted auth state lock poisoned".to_owned(),
            })?;
        *guard = next;
        Ok(())
    }
}

fn require_non_empty_secret(field: &'static str, value: &str) -> crate::ImResult<String> {
    let trimmed = value.trim();
    if trimmed.is_empty() {
        return Err(crate::ImError::invalid_input(
            Some(field.to_owned()),
            format!("{field} must not be empty"),
        ));
    }
    Ok(trimmed.to_owned())
}

fn auth_state_from_token(
    token: Option<&str>,
) -> crate::ImResult<crate::internal::auth::state::AuthStateSnapshot> {
    let Some(token) = token.map(str::trim).filter(|value| !value.is_empty()) else {
        return Ok(crate::internal::auth::state::AuthStateSnapshot::default());
    };
    let raw = crate::internal::auth::state::auth_state_json_for_token(token)?;
    crate::internal::auth::state::parse_auth_state(&raw)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::internal::key_provider::KeyMaterialProvider;
    use serde_json::json;

    #[test]
    fn hosted_key_provider_keeps_secret_material_in_memory_without_debug_leak() {
        let provider = HostedKeyMaterialProvider::new(&crate::identity::HostedIdentityMaterial {
            identity_id: "daemon-agent".to_owned(),
            did: "did:example:daemon".to_owned(),
            handle: Some("daemon.example".to_owned()),
            display_name: None,
            did_document: json!({"id": "did:example:daemon"}),
            default_signing_private_key_pem: "signing-secret".to_owned(),
            e2ee_agreement_private_key_pem: "agreement-secret".to_owned(),
            auth_token: Some("token-secret".to_owned()),
        })
        .unwrap();

        assert_eq!(
            provider.default_signing_private_pem().unwrap(),
            "signing-secret"
        );
        assert_eq!(
            provider.e2ee_agreement_private_pem().unwrap(),
            "agreement-secret"
        );
        assert_eq!(
            provider.valid_auth_token().unwrap().as_deref(),
            Some("token-secret")
        );
        provider.persist_auth_token("fresh-secret").unwrap();
        assert_eq!(
            provider.valid_auth_token().unwrap().as_deref(),
            Some("fresh-secret")
        );
        let debug = format!("{provider:?}");
        assert!(!debug.contains("signing-secret"));
        assert!(!debug.contains("agreement-secret"));
        assert!(!debug.contains("token-secret"));
        assert!(!debug.contains("fresh-secret"));
    }
}