arcanum-core 0.1.1

Core traits, types, and primitives for the Arcanum cryptographic engine
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

//! # Arcanum Core
//!
//! The foundational crate for the Arcanum cryptographic engine.
//!
//! This crate provides:
//! - Core traits for cryptographic operations
//! - Error types and result handling
//! - Secure memory types with automatic zeroization
//! - Cryptographically secure random number generation
//! - Key representations and type-safe wrappers
//! - Constant-time comparison utilities
//!
//! ## Design Principles
//!
//! 1. **Memory Safety**: All sensitive data is zeroized on drop
//! 2. **Type Safety**: Distinct types prevent mixing incompatible keys
//! 3. **Constant Time**: Side-channel resistant operations by default
//! 4. **Fail Secure**: Errors don't leak sensitive information
//! 5. **Composability**: Traits enable algorithm-agnostic code
//!
//! ## Example
//!
//! ```ignore
//! use arcanum_core::prelude::*;
//!
//! // Generate a secure random key
//! let key = SecretKey::<32>::generate();
//!
//! // Constant-time comparison
//! assert!(key.ct_eq(&key));
//! ```

#![cfg_attr(not(feature = "std"), no_std)]
#![deny(unsafe_code)]
#![warn(missing_docs, rust_2018_idioms, unreachable_pub)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

#[cfg(feature = "alloc")]
#[allow(unused_extern_crates)] // Used in no_std mode
extern crate alloc;

pub mod buffer;
pub mod encoding;
pub mod error;
pub mod key;
pub mod nonce;
pub mod random;
pub mod time;
pub mod traits;
pub mod version;

/// Re-exports of commonly used types
pub mod prelude {
    pub use crate::buffer::{SecretBuffer, SecretBytes, SecureVec};
    pub use crate::encoding::{Base64, Hex};
    pub use crate::error::{Error, Result};
    pub use crate::key::{KeyId, KeyMetadata, PublicKey, SecretKey};
    pub use crate::nonce::Nonce;
    pub use crate::random::{CryptoRng, OsRng};
    pub use crate::traits::*;
    pub use crate::version::Version;
}

// Re-export for convenience
pub use secrecy::{ExposeSecret, SecretBox, SecretString};
pub use zeroize::{Zeroize, ZeroizeOnDrop};
/// Type alias for backward compatibility with older secrecy API
pub type Secret<T> = SecretBox<T>;
pub use subtle::{Choice, ConstantTimeEq, CtOption};