origin-crypto-sdk 0.5.1

Standalone cryptographic SDK with classical (Ed25519) and post-quantum (Falcon, SLH-DSA, ML-DSA, NTRU Prime, Curve41417) primitives. Hybrid signing by default.
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

// SPDX-License-Identifier: Apache-2.0

//! Secure memory zeroing — replacement for the `zeroize` crate.
//!
//! Uses `core::ptr::write_volatile` and `core::sync::atomic::compiler_fence`
//! to prevent the compiler from optimizing away the zeroing operation.

use core::sync::atomic::{compiler_fence, Ordering};

/// Securely zero memory using volatile writes and compiler fences.
///
/// This prevents the compiler from optimizing away the zeroing
/// operation, even when the memory is about to be dropped.
pub fn secure_zero_memory(data: &mut [u8]) {
    for byte in data.iter_mut() {
        // Volatile write ensures the compiler cannot elide this store
        unsafe {
            core::ptr::write_volatile(byte, 0);
        }
    }
    // Prevent reordering of memory operations across this point
    compiler_fence(Ordering::SeqCst);
}

/// Trait for types that can be securely zeroized.
///
/// Replacement for `zeroize::Zeroize`.
pub trait Zeroize {
    /// Zero out all sensitive data in this value.
    fn zeroize(&mut self);
}

impl Zeroize for [u8] {
    fn zeroize(&mut self) {
        secure_zero_memory(self);
    }
}

impl Zeroize for Vec<u8> {
    fn zeroize(&mut self) {
        secure_zero_memory(self.as_mut_slice());
    }
}

impl<const N: usize> Zeroize for [u8; N] {
    fn zeroize(&mut self) {
        secure_zero_memory(self.as_mut_slice());
    }
}

impl<const N: usize> Zeroize for [i64; N] {
    fn zeroize(&mut self) {
        let ptr = self.as_mut_ptr() as *mut u8;
        let bytes =
            unsafe { core::slice::from_raw_parts_mut(ptr, N * core::mem::size_of::<i64>()) };
        secure_zero_memory(bytes);
    }
}

impl<const N: usize> Zeroize for [i8; N] {
    fn zeroize(&mut self) {
        let ptr = self.as_mut_ptr() as *mut u8;
        let bytes = unsafe { core::slice::from_raw_parts_mut(ptr, N * core::mem::size_of::<i8>()) };
        secure_zero_memory(bytes);
    }
}

impl<const N: usize> Zeroize for [u32; N] {
    fn zeroize(&mut self) {
        let ptr = self.as_mut_ptr() as *mut u8;
        let bytes =
            unsafe { core::slice::from_raw_parts_mut(ptr, N * core::mem::size_of::<u32>()) };
        secure_zero_memory(bytes);
    }
}

impl Zeroize for String {
    fn zeroize(&mut self) {
        unsafe {
            for byte in self.as_mut_vec().iter_mut() {
                core::ptr::write_volatile(byte, 0);
            }
        }
        compiler_fence(Ordering::SeqCst);
    }
}

/// A wrapper that zeroizes its contents on drop.
///
/// Replacement for `zeroize::Zeroizing`.
pub struct Zeroizing<T: Zeroize>(pub T);

impl<T: Zeroize> Zeroizing<T> {
    /// Create a new `Zeroizing` wrapper.
    pub fn new(data: T) -> Self {
        Self(data)
    }
}

impl<T: Zeroize> core::ops::Deref for Zeroizing<T> {
    type Target = T;
    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<T: Zeroize> core::ops::DerefMut for Zeroizing<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<T: Zeroize> Drop for Zeroizing<T> {
    fn drop(&mut self) {
        self.0.zeroize();
    }
}

impl<T: Zeroize + Clone> Clone for Zeroizing<T> {
    fn clone(&self) -> Self {
        Self(self.0.clone())
    }
}