10 releases
Uses new Rust 2024
| 0.3.3 | Jun 23, 2025 |
|---|---|
| 0.3.2 | Jun 16, 2025 |
| 0.2.0 | Jun 6, 2025 |
| 0.1.4 | Jun 6, 2025 |
| 0.1.3 | May 5, 2025 |
#179 in Memory management
673 downloads per month
28KB
632 lines
SecBits
A Rust library for secure memory handling with enhanced protection against common vulnerabilities and memory inspection attacks.
Features
- ๐ Secure memory allocation with page alignment
- ๐งน Automatic secure zeroing before deallocation
- ๐ Memory locking to prevent swapping to disk
- ๐ก๏ธ Fork protection (Linux) to wipe memory on fork
- ๐ซ Core dump exclusion to prevent sensitive data leaks
- ๐ Fine-grained access control with read/write guards
Security Properties
- Confidentiality: Memory is locked and wiped on release
- Integrity: Write access is controlled via guards
- Availability: Prevents accidental exposure via core dumps
- Least Privilege: Memory starts as no-access, transitions only when needed
Use Case: Sensitive data handling (cryptographic keys, passwords, PII)
Installation
Add to Cargo.toml:
[dependencies]
secbits = "0.3.0"
Quick Start
use secbits::SecBytes;
fn main() -> Result<(), Box<dyn std::error::Error>> {
// Create secure storage
let mut secret = SecBytes::from_bytes("my_secret".as_bytes().to_vec())?;
// Store sensitive data (source gets zeroed)
secret.edit()?.append(b"extra data".to_vec())?;
// Read access
{
let view = secret.view()?;
assert_eq!(view.as_slice(), b"my_secretextra data");
} // drop view
// Write access (exclusive)
{
let mut edit = secret.edit()?;
edit.as_slice()[..3].copy_from_slice(b"NEW");
} // drop edit
println!("{:?}", std::str::from_utf8(secret.view()?.as_slice()));
assert_eq!(secret.view()?.as_slice(), b"NEWsecretextra data");
Ok(())
} // Memory automatically unlocked and zeroed here
Major Components
1. SecSpace Core
pub struct SecSpace {
ptr: NonNull<u8>, // Non-null pointer to memory region
cap: usize, // Capacity in bytes (always page-aligned)
pkey: Option<i32>,
}
Key Features:
- ๐ Page-Aligned Allocations: Always uses system page size multiples
- ๐ก๏ธ Protection Modes:
ProtectionMode::None- No access (default)ProtectionMode::Read- Read-onlyProtectionMode::ReadWrite- Read-write
- โ ๏ธ Secure Drop:
- Set memory to RW mode
- Zero using platform-secure methods
- Unlock and deallocate
2. SecBytes Buffer
pub struct SecBytes {
mem: SecSpace,
len: usize,
reader_count: AtomicUsize,
}
Key Features:
- ๐ Dynamic Resizing: Maintains 2x growth factor
- ๐ Access Views:
SecReadBytes: Shared read access (RO mode)SecWriteBytes: Exclusive write access (RW mode)
- ๐งต Concurrency Safety:
- Multiple readers allowed
- Writers get exclusive access via &mut
Key Tricks
1. Safe Memory Management
// Always use RAII guards
{
let view = secret.read()?; // Auto sets RO
// use view...
} // Auto resets to NOACCESS
2. Secure Data Handling
// Source data gets zeroed automatically
secret.edit()?.append(&mut sensitive_data)?;
๐ Security Considerations
Guarantees
- ๐ก๏ธ Memory never swapped to disk (mlock)
- ๐ซ Sensitive data excluded from core dumps
- ๐ต๏ธ Defeats heap inspection attacks
- ๐ง Prevents compiler optimizations from skipping zeroing
Limitations
- โ ๏ธ Requires CAP_IPC_LOCK on Linux (or root)
- ๐พ Physical memory still potentially recoverable
- ๐ Doesn't protect against hardware attacks
Dependencies
~2.7โ4MB
~69K SLoC