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

// Copyright (c) 2025 Kirky.X
//
// Licensed under the MIT License
// See LICENSE file in the project root for full license information.

//! Plugin system for ciphern library.
//!
//! This module provides plugin loading and management capabilities.
//! Plugins can extend ciphern with custom cipher implementations.
//!
//! # Example
//!
//! ```ignore
//! use ciphern::plugin::{PluginManager, PluginMetadata};
//!
//! let manager = PluginManager::new();
//! let plugins = manager.list_plugins();
//! ```

#[cfg(feature = "plugin")]
pub mod loader;

#[cfg(feature = "plugin")]
pub use manager::PluginManager;

pub mod manager;

use crate::cipher::provider::SymmetricCipher;
use crate::error::Result;
use crate::types::Algorithm;
use lazy_static::lazy_static;
use std::any::Any;
use std::sync::Arc;

lazy_static! {
    pub static ref PLUGIN_MANAGER: PluginManager = PluginManager::new();
}

/// Plugin trait that all plugins must implement.
///
/// This trait defines the core interface for plugins.
/// Implement this trait to create custom plugins for ciphern.
#[cfg(feature = "plugin")]
pub trait Plugin: Send + Sync {
    fn name(&self) -> &str;
    fn version(&self) -> &str;
    fn initialize(&mut self) -> Result<()>;
    fn shutdown(&mut self) -> Result<()>;
    fn health_check(&self) -> Result<bool>;
    fn as_any(&self) -> &dyn Any;
}

/// Cipher plugin trait for custom cipher implementations.
///
/// Plugins implementing this trait can provide custom cipher algorithms
/// that integrate with ciphern's plugin system.
#[cfg(feature = "plugin")]
pub trait CipherPlugin: Plugin {
    fn as_symmetric_cipher(&self) -> Arc<dyn SymmetricCipher>;
    fn supported_algorithms(&self) -> Vec<Algorithm>;
}

use serde::{Deserialize, Serialize};

/// Metadata describing a plugin.
///
/// This struct contains information about a plugin loaded from disk.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[cfg(feature = "plugin")]
pub struct PluginMetadata {
    pub name: String,
    pub version: String,
    pub author: String,
    pub description: String,
    pub dependencies: Vec<String>,
    pub checksum: String,
}

/// Error that can occur when loading a plugin.
#[derive(Debug)]
#[cfg(feature = "plugin")]
pub struct PluginLoadError {
    pub plugin_name: String,
    pub reason: String,
    pub recoverable: bool,
}

impl std::fmt::Display for PluginLoadError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "Plugin load error: {} - {}",
            self.plugin_name, self.reason
        )
    }
}

impl std::error::Error for PluginLoadError {}