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

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

//! Ciphern Crypto Library - Complete Usage Examples
//!
//! This module demonstrates how to use all major features of Ciphern.
//!
//! # Examples
//!
//! - Symmetric encryption with AES and SM4
//! - Digital signatures with ECDSA, SM2, Ed25519, and RSA
//! - Key management and lifecycle
//! - Key derivation functions
//! - Hash operations
//! - Secure random number generation
//! - Streaming encryption for large files
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use ciphern::{Cipher, Algorithm, KeyManager, init};
//!
//! fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     // Initialize the library
//!     init()?;
//!
//!     // Create a key manager
//!     let key_manager = KeyManager::new()?;
//!
//!     // Generate a key
//!     let key_id = key_manager.generate_key(Algorithm::AES256GCM)?;
//!
//!     // Create a cipher and encrypt data
//!     let cipher = Cipher::new(Algorithm::AES256GCM)?;
//!     let plaintext = b"Hello, Ciphern!";
//!     let ciphertext = cipher.encrypt(&key_manager, &key_id, plaintext)?;
//!
//!     // Decrypt the data
//!     let decrypted = cipher.decrypt(&key_manager, &key_id, &ciphertext)?;
//!
//!     assert_eq!(plaintext, decrypted.as_slice());
//!     println!("Encryption/decryption successful!");
//!
//!     Ok(())
//! }
//! ```

mod common;

pub mod digital_signatures;
pub mod fips_compliance;
pub mod hashing;
pub mod java_api;
pub mod key_derivation;
pub mod key_management;
pub mod python_api;
pub mod random_generation;
pub mod streaming_encryption;
pub mod symmetric_encryption;

#[cfg(test)]
mod tests {
    use crate::common::setup;
    use crate::{
        digital_signatures, fips_compliance, hashing, key_derivation, key_management,
        random_generation, streaming_encryption, symmetric_encryption,
    };

    #[test]
    fn test_symmetric_encryption_examples() {
        println!("\n=== Testing Symmetric Encryption Examples ===");
        symmetric_encryption::run_all().expect("Symmetric encryption examples failed");
    }

    #[test]
    fn test_key_derivation_examples() {
        println!("\n=== Testing Key Derivation Examples ===");
        key_derivation::run_all().expect("Key derivation examples failed");
    }

    #[test]
    fn test_random_generation_examples() {
        println!("\n=== Testing Random Generation Examples ===");
        random_generation::run_all().expect("Random generation examples failed");
    }
}