do_memory_core/security/mod.rs
1// ============================================================================
2// Security Module
3// ============================================================================
4//!
5//! Security-related functionality for the memory system.
6//!
7//! This module provides security features including:
8//! - **Audit logging**: Comprehensive tracking of all operations
9//! - **Access control**: Future support for authorization
10//! - **Encryption**: Future support for data encryption
11//!
12//! ## Audit Logging
13//!
14//! The audit logging system tracks all critical operations for security
15//! compliance and incident investigation. See the [`audit`] module for
16//! detailed documentation.
17//!
18//! ## Usage
19//!
20//! ```no_run
21//! use do_memory_core::security::audit::{AuditLogger, AuditConfig, AuditContext, AuditOutput, episode_created};
22//! use uuid::Uuid;
23//!
24//! // Create a logger
25//! let config = AuditConfig::from_env();
26//! let logger = AuditLogger::new(config);
27//!
28//! // Log operations
29//! let context = AuditContext::system();
30//! let episode_id = Uuid::new_v4();
31//! let entry = episode_created(&context, episode_id, "Task", "code_generation");
32//! logger.log(entry);
33//! ```
34
35pub mod audit;
36
37// Re-export commonly used audit types
38pub use audit::{
39 ActorType, AuditConfig, AuditContext, AuditEntry, AuditEventType, AuditLogLevel, AuditLogger,
40 AuditOutput, AuditResult, access_denied, config_changed, episode_completed, episode_created,
41 episode_deleted, relationship_added, relationship_removed, tags_modified,
42};