memguard-rs 0.1.0

Secure memory handling primitives for Rust — zeroization on drop, mlock-protected regions, constant-time comparison, and compile-time enforced memory safety boundaries
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

//! Example: Using memguard-rs in a `no_std` embedded context.
//!
//! This example demonstrates the API patterns for using core primitives
//! (zeroization, constant-time comparison) without an allocator.
//!
//! In a real `no_std` project, add this to Cargo.toml:
//! ```toml
//! [dependencies]
//! memguard-rs = { version = "0.1", default-features = false, features = ["lock"] }
//! ```
//!
//! And use `#![no_std]` at the crate root.

use memguard_rs::{ct_eq, Secret};

fn verify_key(stored: &[u8; 32], received: &[u8; 32]) -> bool {
    let secret = Secret::new(*stored);
    let mut result = false;
    secret.expose(|s| {
        result = ct_eq(s, received);
    });
    // `secret` is zeroized when it goes out of scope
    result
}

fn main() {
    let stored = [0x42u8; 32];
    let received = [0x42u8; 32];
    let wrong = [0x43u8; 32];

    assert!(verify_key(&stored, &received));
    assert!(!verify_key(&stored, &wrong));

    println!("no_std pattern verified");
}