sdforge 0.3.1

Multi-protocol SDK framework with unified macro configuration
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

// Copyright (c) 2026 Kirky.X
// SPDX-License-Identifier: MIT
//! Trait definitions for the security module
//!
//! This module contains the feature layer trait interfaces that define
//! the contracts for authentication and audit logging.

use crate::security::types::AuditLog;

/// Feature layer trait for API key authentication.
///
/// Implement this trait to provide custom API key validation logic while
/// maintaining a consistent interface across the security module.
pub trait ApiKeyAuth: Send + Sync {
    /// Validate an API key and return permissions if valid.
    ///
    /// Returns `Some(Vec<String>)` with permissions if the key is valid,
    /// or `None` if the key is invalid or rate limited.
    ///
    /// # Arguments
    /// * `key` - The API key to validate
    /// * `client_ip` - The client IP address for rate limiting
    fn validate_key(&self, key: &str, client_ip: &str) -> Option<Vec<String>>;

    /// Add a valid API key with associated permissions.
    ///
    /// The key will be securely hashed before storage.
    ///
    /// # Arguments
    /// * `key` - The API key to add
    /// * `permissions` - List of permissions granted by this key
    fn add_key(&self, key: impl Into<String>, permissions: Vec<String>);
}

/// Feature layer trait for audit logging.
///
/// Implement this trait to provide custom audit logging logic while
/// maintaining a consistent interface across the security module.
pub trait AuditLogger: Send + Sync {
    /// Log an audit event.
    ///
    /// # Arguments
    /// * `log` - The audit log entry to record
    fn log(&self, log: AuditLog);
}