oxirs-vec 0.2.4

Vector index abstractions for semantic similarity and AI-augmented querying
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
//! Access control and RBAC for multi-tenancy

use crate::multi_tenancy::types::{MultiTenancyError, MultiTenancyResult};
use serde::{Deserialize, Serialize};
use std::collections::{HashMap, HashSet};
use std::sync::{Arc, RwLock};

/// Permission for an operation
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum Permission {
    /// Read vectors
    Read,
    /// Write/insert vectors
    Write,
    /// Delete vectors
    Delete,
    /// Build indices
    BuildIndex,
    /// Administer tenant
    Admin,
    /// View metrics and analytics
    ViewMetrics,
    /// Manage billing
    ManageBilling,
    /// Custom permission
    Custom(u32),
}

impl Permission {
    /// Check if this permission includes another
    pub fn includes(&self, other: &Permission) -> bool {
        match self {
            Self::Admin => true, // Admin has all permissions
            _ => self == other,
        }
    }

    /// Get permission name
    pub fn name(&self) -> &'static str {
        match self {
            Self::Read => "read",
            Self::Write => "write",
            Self::Delete => "delete",
            Self::BuildIndex => "build_index",
            Self::Admin => "admin",
            Self::ViewMetrics => "view_metrics",
            Self::ManageBilling => "manage_billing",
            Self::Custom(_) => "custom",
        }
    }
}

/// Role with a set of permissions
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Role {
    /// Role name
    pub name: String,
    /// Permissions granted by this role
    pub permissions: HashSet<Permission>,
    /// Role description
    pub description: Option<String>,
}

impl Role {
    /// Create new role
    pub fn new(name: impl Into<String>) -> Self {
        Self {
            name: name.into(),
            permissions: HashSet::new(),
            description: None,
        }
    }

    /// Create read-only role
    pub fn readonly() -> Self {
        let mut role = Self::new("readonly");
        role.permissions.insert(Permission::Read);
        role.permissions.insert(Permission::ViewMetrics);
        role.description = Some("Read-only access to vectors and metrics".to_string());
        role
    }

    /// Create read-write role
    pub fn readwrite() -> Self {
        let mut role = Self::new("readwrite");
        role.permissions.insert(Permission::Read);
        role.permissions.insert(Permission::Write);
        role.permissions.insert(Permission::ViewMetrics);
        role.description = Some("Read and write access to vectors".to_string());
        role
    }

    /// Create admin role
    pub fn admin() -> Self {
        let mut role = Self::new("admin");
        role.permissions.insert(Permission::Admin);
        role.description = Some("Full administrative access".to_string());
        role
    }

    /// Add permission to role
    pub fn add_permission(&mut self, permission: Permission) {
        self.permissions.insert(permission);
    }

    /// Check if role has permission
    pub fn has_permission(&self, permission: Permission) -> bool {
        self.permissions.iter().any(|p| p.includes(&permission))
    }
}

/// Access policy for a tenant
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccessPolicy {
    /// Tenant ID
    pub tenant_id: String,
    /// User/API key to role mapping
    pub user_roles: HashMap<String, Vec<String>>,
    /// Available roles
    pub roles: HashMap<String, Role>,
    /// IP whitelist (empty = no restriction)
    pub ip_whitelist: Vec<String>,
    /// IP blacklist
    pub ip_blacklist: Vec<String>,
}

impl AccessPolicy {
    /// Create new access policy
    pub fn new(tenant_id: impl Into<String>) -> Self {
        let mut policy = Self {
            tenant_id: tenant_id.into(),
            user_roles: HashMap::new(),
            roles: HashMap::new(),
            ip_whitelist: Vec::new(),
            ip_blacklist: Vec::new(),
        };

        // Add default roles
        policy.add_role(Role::readonly());
        policy.add_role(Role::readwrite());
        policy.add_role(Role::admin());

        policy
    }

    /// Add a role definition
    pub fn add_role(&mut self, role: Role) {
        self.roles.insert(role.name.clone(), role);
    }

    /// Assign role to user
    pub fn assign_role(&mut self, user_id: impl Into<String>, role_name: impl Into<String>) {
        self.user_roles
            .entry(user_id.into())
            .or_default()
            .push(role_name.into());
    }

    /// Check if user has permission
    pub fn has_permission(&self, user_id: &str, permission: Permission) -> bool {
        if let Some(role_names) = self.user_roles.get(user_id) {
            for role_name in role_names {
                if let Some(role) = self.roles.get(role_name) {
                    if role.has_permission(permission) {
                        return true;
                    }
                }
            }
        }
        false
    }

    /// Check if IP is allowed
    pub fn is_ip_allowed(&self, ip: &str) -> bool {
        // Check blacklist first
        if self.ip_blacklist.contains(&ip.to_string()) {
            return false;
        }

        // If whitelist is empty, allow all (except blacklisted)
        if self.ip_whitelist.is_empty() {
            return true;
        }

        // Check whitelist
        self.ip_whitelist.contains(&ip.to_string())
    }
}

/// Access control manager
pub struct AccessControl {
    /// Policies by tenant
    policies: Arc<RwLock<HashMap<String, AccessPolicy>>>,
}

impl AccessControl {
    /// Create new access control manager
    pub fn new() -> Self {
        Self {
            policies: Arc::new(RwLock::new(HashMap::new())),
        }
    }

    /// Set policy for tenant
    pub fn set_policy(&self, policy: AccessPolicy) -> MultiTenancyResult<()> {
        self.policies
            .write()
            .map_err(|e| MultiTenancyError::InternalError {
                message: format!("Lock error: {}", e),
            })?
            .insert(policy.tenant_id.clone(), policy);
        Ok(())
    }

    /// Get policy for tenant
    pub fn get_policy(&self, tenant_id: &str) -> MultiTenancyResult<AccessPolicy> {
        self.policies
            .read()
            .map_err(|e| MultiTenancyError::InternalError {
                message: format!("Lock error: {}", e),
            })?
            .get(tenant_id)
            .cloned()
            .ok_or_else(|| MultiTenancyError::TenantNotFound {
                tenant_id: tenant_id.to_string(),
            })
    }

    /// Check if user has permission
    pub fn check_permission(
        &self,
        tenant_id: &str,
        user_id: &str,
        permission: Permission,
    ) -> MultiTenancyResult<bool> {
        let policy = self.get_policy(tenant_id)?;
        Ok(policy.has_permission(user_id, permission))
    }

    /// Authorize operation
    pub fn authorize(
        &self,
        tenant_id: &str,
        user_id: &str,
        permission: Permission,
        client_ip: Option<&str>,
    ) -> MultiTenancyResult<()> {
        let policy = self.get_policy(tenant_id)?;

        // Check IP restrictions
        if let Some(ip) = client_ip {
            if !policy.is_ip_allowed(ip) {
                return Err(MultiTenancyError::AccessDenied {
                    tenant_id: tenant_id.to_string(),
                    reason: format!("IP {} not allowed", ip),
                });
            }
        }

        // Check permissions
        if !policy.has_permission(user_id, permission) {
            return Err(MultiTenancyError::AccessDenied {
                tenant_id: tenant_id.to_string(),
                reason: format!("User {} lacks permission {:?}", user_id, permission),
            });
        }

        Ok(())
    }

    /// Create default policy for tenant
    pub fn create_default_policy(&self, tenant_id: impl Into<String>) -> MultiTenancyResult<()> {
        let policy = AccessPolicy::new(tenant_id);
        self.set_policy(policy)
    }
}

impl Default for AccessControl {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    type Result<T> = std::result::Result<T, Box<dyn std::error::Error>>;
    use super::*;

    #[test]
    fn test_permissions() {
        assert!(Permission::Admin.includes(&Permission::Read));
        assert!(Permission::Admin.includes(&Permission::Write));
        assert!(!Permission::Read.includes(&Permission::Write));
        assert!(Permission::Read.includes(&Permission::Read));
    }

    #[test]
    fn test_role_creation() {
        let role = Role::readonly();
        assert!(role.has_permission(Permission::Read));
        assert!(!role.has_permission(Permission::Write));
        assert!(!role.has_permission(Permission::Delete));

        let role = Role::readwrite();
        assert!(role.has_permission(Permission::Read));
        assert!(role.has_permission(Permission::Write));
        assert!(!role.has_permission(Permission::Delete));

        let role = Role::admin();
        assert!(role.has_permission(Permission::Read));
        assert!(role.has_permission(Permission::Write));
        assert!(role.has_permission(Permission::Delete));
        assert!(role.has_permission(Permission::Admin));
    }

    #[test]
    fn test_access_policy() {
        let mut policy = AccessPolicy::new("tenant1");

        // Assign roles
        policy.assign_role("user1", "readonly");
        policy.assign_role("user2", "readwrite");
        policy.assign_role("user3", "admin");

        // Check permissions
        assert!(policy.has_permission("user1", Permission::Read));
        assert!(!policy.has_permission("user1", Permission::Write));

        assert!(policy.has_permission("user2", Permission::Read));
        assert!(policy.has_permission("user2", Permission::Write));
        assert!(!policy.has_permission("user2", Permission::Delete));

        assert!(policy.has_permission("user3", Permission::Read));
        assert!(policy.has_permission("user3", Permission::Write));
        assert!(policy.has_permission("user3", Permission::Delete));
        assert!(policy.has_permission("user3", Permission::Admin));
    }

    #[test]
    fn test_ip_restrictions() {
        let mut policy = AccessPolicy::new("tenant1");

        // No restrictions by default
        assert!(policy.is_ip_allowed("192.168.1.1"));
        assert!(policy.is_ip_allowed("10.0.0.1"));

        // Add to blacklist
        policy.ip_blacklist.push("192.168.1.100".to_string());
        assert!(!policy.is_ip_allowed("192.168.1.100"));
        assert!(policy.is_ip_allowed("192.168.1.1"));

        // Add whitelist (restricts to only those IPs)
        policy.ip_whitelist.push("192.168.1.1".to_string());
        policy.ip_whitelist.push("192.168.1.2".to_string());
        assert!(policy.is_ip_allowed("192.168.1.1"));
        assert!(policy.is_ip_allowed("192.168.1.2"));
        assert!(!policy.is_ip_allowed("10.0.0.1"));
        assert!(!policy.is_ip_allowed("192.168.1.100")); // Blacklist takes precedence
    }

    #[test]
    fn test_access_control_manager() -> Result<()> {
        let ac = AccessControl::new();

        // Create default policy
        ac.create_default_policy("tenant1")?;

        // Get policy and modify
        let mut policy = ac.get_policy("tenant1")?;
        policy.assign_role("user1", "readonly");
        policy.assign_role("user2", "admin");
        ac.set_policy(policy)?;

        // Check permissions
        assert!(ac.check_permission("tenant1", "user1", Permission::Read)?);
        assert!(!ac.check_permission("tenant1", "user1", Permission::Write)?);

        assert!(ac.check_permission("tenant1", "user2", Permission::Admin)?);

        // Authorize operations
        assert!(ac
            .authorize("tenant1", "user1", Permission::Read, None)
            .is_ok());
        assert!(ac
            .authorize("tenant1", "user1", Permission::Write, None)
            .is_err());
        assert!(ac
            .authorize("tenant1", "user2", Permission::Write, None)
            .is_ok());
        Ok(())
    }

    #[test]
    fn test_authorize_with_ip() -> Result<()> {
        let ac = AccessControl::new();
        let mut policy = AccessPolicy::new("tenant1");
        policy.assign_role("user1", "readonly");
        policy.ip_whitelist.push("192.168.1.1".to_string());
        ac.set_policy(policy)?;

        // Should succeed with allowed IP
        assert!(ac
            .authorize("tenant1", "user1", Permission::Read, Some("192.168.1.1"))
            .is_ok());

        // Should fail with disallowed IP
        assert!(ac
            .authorize("tenant1", "user1", Permission::Read, Some("10.0.0.1"))
            .is_err());
        Ok(())
    }

    #[test]
    fn test_custom_roles() {
        let mut role = Role::new("custom");
        role.add_permission(Permission::Read);
        role.add_permission(Permission::ViewMetrics);
        role.add_permission(Permission::Custom(100));

        assert!(role.has_permission(Permission::Read));
        assert!(role.has_permission(Permission::ViewMetrics));
        assert!(role.has_permission(Permission::Custom(100)));
        assert!(!role.has_permission(Permission::Write));
    }
}