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

use std::fmt;
use std::path::PathBuf;
use std::sync::Arc;

use serde::{Deserialize, Serialize};

use crate::vault::{DeviceVaultRootKey, FileSecretVault, FileSecretVaultStore, SecretVault};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum IdentitySecretStoragePolicy {
    FileCompat,
    VaultPreferred,
    VaultRequired,
}

impl Default for IdentitySecretStoragePolicy {
    fn default() -> Self {
        Self::FileCompat
    }
}

pub struct ImCoreSecretVaultOptions {
    pub root_key: DeviceVaultRootKey,
    pub vault_dir: PathBuf,
    pub workspace_id: String,
    pub device_id: String,
}

impl ImCoreSecretVaultOptions {
    pub fn new(
        root_key: DeviceVaultRootKey,
        vault_dir: impl Into<PathBuf>,
        workspace_id: impl Into<String>,
        device_id: impl Into<String>,
    ) -> Self {
        Self {
            root_key,
            vault_dir: vault_dir.into(),
            workspace_id: workspace_id.into(),
            device_id: device_id.into(),
        }
    }
}

impl fmt::Debug for ImCoreSecretVaultOptions {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("ImCoreSecretVaultOptions")
            .field("root_key", &"<redacted-root-key>")
            .field("vault_dir", &self.vault_dir)
            .field("workspace_id", &self.workspace_id)
            .field("device_id", &self.device_id)
            .finish()
    }
}

#[derive(Debug, Default)]
pub struct ImCoreOpenOptions {
    pub identity_secret_storage_policy: IdentitySecretStoragePolicy,
    pub identity_secret_vault: Option<ImCoreSecretVaultOptions>,
}

impl ImCoreOpenOptions {
    pub fn file_compat() -> Self {
        Self::default()
    }

    pub fn with_identity_secret_vault(
        mut self,
        identity_secret_storage_policy: IdentitySecretStoragePolicy,
        identity_secret_vault: ImCoreSecretVaultOptions,
    ) -> Self {
        self.identity_secret_storage_policy = identity_secret_storage_policy;
        self.identity_secret_vault = Some(identity_secret_vault);
        self
    }
}

#[derive(Clone)]
pub(crate) struct IdentityVaultContext {
    policy: IdentitySecretStoragePolicy,
    vault: Arc<dyn SecretVault + Send + Sync>,
    workspace_id: String,
    device_id: String,
}

impl IdentityVaultContext {
    pub(crate) fn from_options(options: ImCoreSecretVaultOptions) -> crate::ImResult<Self> {
        let workspace_id = required_non_empty("workspace_id", options.workspace_id)?;
        let device_id = required_non_empty("device_id", options.device_id)?;
        if options.vault_dir.as_os_str().is_empty() {
            return Err(crate::ImError::invalid_input(
                Some("vault_dir".to_owned()),
                "vault directory must not be empty",
            ));
        }
        let vault = Arc::new(FileSecretVault::new(
            options.root_key,
            FileSecretVaultStore::new(options.vault_dir),
        ));
        Ok(Self {
            policy: IdentitySecretStoragePolicy::FileCompat,
            vault,
            workspace_id,
            device_id,
        })
    }

    pub(crate) fn with_policy(mut self, policy: IdentitySecretStoragePolicy) -> Self {
        self.policy = policy;
        self
    }

    pub(crate) fn vault(&self) -> Arc<dyn SecretVault + Send + Sync> {
        self.vault.clone()
    }

    pub(crate) fn workspace_id(&self) -> &str {
        &self.workspace_id
    }

    pub(crate) fn device_id(&self) -> &str {
        &self.device_id
    }
}

impl fmt::Debug for IdentityVaultContext {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("IdentityVaultContext")
            .field("policy", &self.policy)
            .field("vault", &"<redacted-secret-vault>")
            .field("workspace_id", &self.workspace_id)
            .field("device_id", &self.device_id)
            .finish()
    }
}

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