ciphern 0.2.1

Enterprise-grade cryptographic library
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
// Copyright (c) 2025 Kirky.X
//
// Licensed under the MIT License
// See LICENSE file in the project root for full license information.

#[cfg(feature = "kdf")]
pub mod derivation;
#[cfg(feature = "kdf")]
pub mod kdf_counter;
pub mod lifecycle;
pub mod manager;
pub mod openssl_rsa;
#[cfg(feature = "post_quantum")]
pub mod post_quantum;
pub mod rotation;
pub mod usage_limit;

#[cfg(test)]
mod tests;

use crate::error::Result;
use crate::memory::{ProtectedKey, SecretBytes};
use crate::types::Algorithm;
use chrono::{DateTime, Utc};
use uuid::Uuid;

/// 密钥管理操作trait,用于抽象KeyManager和TenantKeyManager的操作
pub trait KeyManagerOperations {
    /// 生成密钥并返回密钥ID
    fn generate_key_operation(&self, algorithm: Algorithm) -> Result<String>;

    /// 根据密钥ID获取密钥
    fn get_key_operation(&self, key_id: &str) -> Result<Key>;

    /// 销毁密钥
    fn destroy_key_operation(&self, key_id: &str) -> Result<()>;

    /// 获取所有密钥ID
    fn list_keys_operation(&self) -> Result<Vec<String>>;
}

#[cfg(feature = "kdf")]
#[allow(unused)]
pub use kdf_counter::{KdfUsageCounter, KdfUsagePolicy, KdfUsageType};
#[allow(unused)]
pub use lifecycle::{KeyLifecycleManager, KeyLifecyclePolicy, KeyManagerLifecycleExt};
#[allow(unused)]
pub use manager::KeyManager;
#[cfg(feature = "post_quantum")]
#[allow(unused)]
pub use post_quantum::{PqcAlgorithm, PqcKey, PqcKeyManager, PqcOperations};
#[allow(unused)]
pub use rotation::{KeyRotationManager, RotationConfig, RotationTrigger};
#[allow(unused)]
pub use usage_limit::{
    KeyUsageLimit, ResetStrategy, UsageLimitManager, UsageLimitPolicy, UsageLimitType,
    UsageReportEntry,
};

/// 密钥状态转换器
pub struct KeyStateManager;

impl KeyStateManager {
    /// 检查状态转换是否有效
    pub fn is_valid_transition(from: KeyState, to: KeyState) -> bool {
        match (from, to) {
            // 从生成状态可以转换到激活状态
            (KeyState::Generated, KeyState::Active) => true,

            // 从激活状态可以转换到暂停或销毁状态
            (KeyState::Active, KeyState::Suspended) => true,
            (KeyState::Active, KeyState::Destroyed) => true,

            // 从暂停状态可以转换回激活状态或销毁状态
            (KeyState::Suspended, KeyState::Active) => true,
            (KeyState::Suspended, KeyState::Destroyed) => true,

            // 销毁状态是最终状态,不能再转换
            (KeyState::Destroyed, _) => false,

            // 其他转换都是无效的
            _ => false,
        }
    }

    /// 获取状态描述
    #[allow(dead_code)]
    pub fn get_state_description(state: KeyState) -> &'static str {
        match state {
            KeyState::Generated => "密钥已生成,等待激活",
            KeyState::Active => "密钥已激活,可以使用",
            KeyState::Suspended => "密钥已暂停,不能使用",
            KeyState::Destroyed => "密钥已销毁,不能再使用",
        }
    }
}

/// 密钥结构,包含完整的生命周期信息
///
/// ## 线程安全说明
///
/// `Key` 类型**不是**线程安全的(`!Send + !Sync`),因为:
/// - `ProtectedKey` 内部包含可变状态,需要外部同步
/// - `usage_count`、`state` 等字段在并发访问时可能导致数据竞争
///
/// 在多线程环境中使用时,必须通过 `Arc<Mutex<Key>>` 或 `Arc<RwLock<Key>>`
/// 进行保护,确保同一时间只有一个线程可以修改密钥状态。
///
/// ## 使用示例
///
/// ```ignore
/// use std::sync::{Arc, Mutex};
/// use crate::key::{Key, KeyManager};
///
/// let key = Arc::new(Mutex::new(Key::new(algorithm, key_data)?));
/// // 在多个线程中使用
/// ```
#[derive(Clone)]
pub struct Key {
    id: String,
    algorithm: Algorithm,
    data: ProtectedKey,
    state: KeyState,
    created_at: DateTime<Utc>,
    activated_at: Option<DateTime<Utc>>,
    suspended_at: Option<DateTime<Utc>>,
    destroyed_at: Option<DateTime<Utc>>,
    expires_at: Option<DateTime<Utc>>,
    usage_count: usize,
    max_usage: Option<usize>,
    metadata: std::collections::HashMap<String, String>,
}

impl Key {
    /// 创建新的密钥
    pub fn new(algorithm: Algorithm, data: Vec<u8>) -> Result<Self> {
        let secret = SecretBytes::new(data)?;
        Ok(Self {
            id: Uuid::new_v4().to_string(),
            algorithm,
            data: ProtectedKey::new(secret)?,
            state: KeyState::Generated,
            created_at: Utc::now(),
            activated_at: None,
            suspended_at: None,
            destroyed_at: None,
            expires_at: None,
            usage_count: 0,
            max_usage: None,
            metadata: std::collections::HashMap::new(),
        })
    }

    /// 创建新的激活状态密钥(用于密钥派生)
    pub fn new_active(algorithm: Algorithm, data: Vec<u8>) -> Result<Self> {
        let secret = SecretBytes::new(data)?;
        let now = Utc::now();
        Ok(Self {
            id: Uuid::new_v4().to_string(),
            algorithm,
            data: ProtectedKey::new(secret)?,
            state: KeyState::Active,
            created_at: now,
            activated_at: Some(now),
            suspended_at: None,
            destroyed_at: None,
            expires_at: None,
            usage_count: 0,
            max_usage: None,
            metadata: std::collections::HashMap::new(),
        })
    }

    /// 使用指定ID创建新的密钥(用于多租户隔离)
    pub fn new_with_id(algorithm: Algorithm, data: Vec<u8>, id: &str) -> Result<Self> {
        let secret = SecretBytes::new(data)?;
        Ok(Self {
            id: id.to_string(),
            algorithm,
            data: ProtectedKey::new(secret)?,
            state: KeyState::Generated,
            created_at: Utc::now(),
            activated_at: None,
            suspended_at: None,
            destroyed_at: None,
            expires_at: None,
            usage_count: 0,
            max_usage: None,
            metadata: std::collections::HashMap::new(),
        })
    }

    /// 激活密钥
    pub fn activate(&mut self, tenant_id: Option<&str>) -> Result<()> {
        if !KeyStateManager::is_valid_transition(self.state, KeyState::Active) {
            return Err(crate::error::CryptoError::KeyError(format!(
                "Invalid state transition from {:?} to Active",
                self.state
            )));
        }

        self.state = KeyState::Active;
        self.activated_at = Some(Utc::now());

        if let Some(tenant) = tenant_id {
            crate::audit::AuditLogger::log_with_tenant(
                "KEY_ACTIVATED",
                Some(self.algorithm),
                Some(&self.id),
                Some(tenant),
                Ok(()),
                "authorized",
            );
        } else {
            crate::audit::AuditLogger::log(
                "KEY_ACTIVATED",
                Some(self.algorithm),
                Some(&self.id),
                Ok(()),
            );
        }

        Ok(())
    }

    /// 暂停密钥
    pub fn suspend(&mut self) -> Result<()> {
        if !KeyStateManager::is_valid_transition(self.state, KeyState::Suspended) {
            return Err(crate::error::CryptoError::KeyError(format!(
                "Invalid state transition from {:?} to Suspended",
                self.state
            )));
        }

        self.state = KeyState::Suspended;
        self.suspended_at = Some(Utc::now());

        crate::audit::AuditLogger::log(
            "KEY_SUSPENDED",
            Some(self.algorithm),
            Some(&self.id),
            Ok(()),
        );

        Ok(())
    }

    /// 恢复密钥
    pub fn resume(&mut self) -> Result<()> {
        if !KeyStateManager::is_valid_transition(self.state, KeyState::Active) {
            return Err(crate::error::CryptoError::KeyError(format!(
                "Invalid state transition from {:?} to Active",
                self.state
            )));
        }

        self.state = KeyState::Active;
        self.suspended_at = None;

        crate::audit::AuditLogger::log("KEY_RESUMED", Some(self.algorithm), Some(&self.id), Ok(()));

        Ok(())
    }

    /// 销毁密钥
    pub fn destroy(&mut self) -> Result<()> {
        if !KeyStateManager::is_valid_transition(self.state, KeyState::Destroyed) {
            return Err(crate::error::CryptoError::KeyError(format!(
                "Invalid state transition from {:?} to Destroyed",
                self.state
            )));
        }

        self.state = KeyState::Destroyed;
        self.destroyed_at = Some(Utc::now());

        // 清除密钥数据 - we can't access mutable, so we'll create a new zeroized key
        let zeroized_key =
            crate::memory::SecretBytes::new(vec![0u8; self.data.access()?.as_bytes().len()])?;
        self.data = crate::memory::ProtectedKey::new(zeroized_key)?;

        crate::audit::AuditLogger::log(
            "KEY_DESTROYED",
            Some(self.algorithm),
            Some(&self.id),
            Ok(()),
        );

        Ok(())
    }

    /// 检查密钥是否过期
    pub fn is_expired(&self) -> bool {
        if let Some(expires_at) = self.expires_at {
            Utc::now() >= expires_at
        } else {
            false
        }
    }

    /// 检查密钥是否有效
    pub fn is_valid(&self) -> bool {
        self.state == KeyState::Active && !self.is_expired() && !self.is_usage_exceeded()
    }

    /// 检查使用次数是否超限
    pub fn is_usage_exceeded(&self) -> bool {
        if let Some(max_usage) = self.max_usage {
            self.usage_count >= max_usage
        } else {
            false
        }
    }

    /// 增加使用计数
    pub fn increment_usage(&mut self) -> Result<()> {
        if !self.is_valid() {
            return Err(crate::error::CryptoError::KeyError(
                "Key is not valid for use".into(),
            ));
        }

        self.usage_count += 1;
        Ok(())
    }

    /// 设置最大使用次数
    pub(crate) fn set_max_usage(&mut self, max_usage: Option<usize>) {
        self.max_usage = max_usage;
    }

    /// 获取密钥生命周期状态
    pub fn get_lifecycle_status(&self) -> String {
        format!(
            "Key {}: {} (created: {}, state: {:?}, usage: {}, expired: {})",
            self.id,
            if self.is_valid() { "VALID" } else { "INVALID" },
            self.created_at.format("%Y-%m-%d %H:%M:%S"),
            self.state,
            self.usage_count,
            self.is_expired()
        )
    }

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

    pub fn algorithm(&self) -> Algorithm {
        self.algorithm
    }

    pub fn state(&self) -> KeyState {
        self.state
    }

    pub fn secret_bytes(&self) -> Result<&SecretBytes> {
        if !self.is_valid() {
            return Err(crate::error::CryptoError::KeyError(
                "Key is not valid for use".into(),
            ));
        }

        self.data.access()
    }

    pub fn public_bytes(&self) -> Result<Vec<u8>> {
        if !self.is_valid() {
            return Err(crate::error::CryptoError::KeyError(
                "Key is not valid for use".into(),
            ));
        }

        let key_bytes = self.data.access()?;
        let bytes = key_bytes.as_bytes();

        match self.algorithm {
            Algorithm::Ed25519 => {
                if bytes.len() == 32 {
                    Ok(bytes.to_vec())
                } else if bytes.len() >= 32 {
                    Ok(bytes[..32].to_vec())
                } else {
                    Err(crate::error::CryptoError::KeyError(
                        "Invalid Ed25519 key length for public key extraction".into(),
                    ))
                }
            }
            _ => Err(crate::error::CryptoError::KeyError(format!(
                "Public key extraction not implemented for algorithm {:?}",
                self.algorithm
            ))),
        }
    }

    pub fn created_at(&self) -> DateTime<Utc> {
        self.created_at
    }

    pub fn activated_at(&self) -> Option<DateTime<Utc>> {
        self.activated_at
    }

    pub fn expires_at(&self) -> Option<DateTime<Utc>> {
        self.expires_at
    }

    pub fn set_expires_at(&mut self, expires_at: DateTime<Utc>) {
        self.expires_at = Some(expires_at);
    }

    pub fn usage_count(&self) -> usize {
        self.usage_count
    }

    pub fn metadata(&self) -> &std::collections::HashMap<String, String> {
        &self.metadata
    }

    pub fn metadata_mut(&mut self) -> &mut std::collections::HashMap<String, String> {
        &mut self.metadata
    }
}

impl Drop for Key {
    fn drop(&mut self) {
        if let Ok(_secret) = self.data.access() {
            if let Ok(zeroized_key) =
                crate::memory::SecretBytes::new(vec![0u8; _secret.as_bytes().len()])
            {
                // 忽略错误,因为此时正在销毁
                let _ = crate::memory::ProtectedKey::new(zeroized_key);
            }
        }
    }
}

/// 密钥状态枚举
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum KeyState {
    Generated,
    Active,
    Suspended,
    Destroyed,
}