memsafe 0.1.1

A cross-platform Rust library for securely wrapping data in memory
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


# memsafe
A cross-platform Rust library for securely wrapping data in memory.

[![Crates.io](https://img.shields.io/crates/v/memsafe.svg)](https://crates.io/crates/memsafe)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)


`memsafe` locks sensitive data in memory, restricts access, and ensures secure cleanup—built from the ground up with simplicity and security in mind.

## Usage
```rust
use memsafe::MemSafe;
let mut secret = MemSafe::new(String::from("secret")).unwrap();
secret.push_str(" data");
println!("Secure data: {}", secret);
```
## Features
- **Memory Locking**: Prevents swapping to disk using `mlock` (Unix) or `VirtualLock` (Windows).
- **Access Restriction**: Defaults to no-access mode, with temporary read/write windows.
- **Secure Cleanup**: Zeroes memory on drop.
- **Cross-Platform**: Supports Unix (via `libc`) and Windows (via `winapi`) with optional dependencies.

## Installation
Add to your `Cargo.toml`:
```toml
[dependencies]
memsafe = "0.1.0"
```

For Windows support only:
```toml
[dependencies]
memsafe = { version = "0.1.0", default-features = false, features = ["windows"] }
```

## Milestones
The journey to create `memsafe` involved several key steps:
1. **Secure Memory Wrapper**: Developed a Rust struct (`MemSafe`) using `mprotect`, `mlock`, and `madvise` on Unix, and `VirtualProtect`, `VirtualLock` on Windows, ensuring data stays locked and inaccessible by default.
2. **Naming the Crate**: Brainstormed names like `MemVault`, `LockMem`, and settled on `memsafe` for its simplicity and clarity.
3. **Cross-Platform Support**: Made `libc` and `winapi` optional dependencies with `unix` and `windows` features, defaulting to Unix for broad compatibility.
4. **Licensing**: Chose the MIT License to require attribution (`Copyright (c) 2025 Pouyan`) while keeping it permissive.
5. **SSH Configuration**: Set up an SSH config using `pouyan.key` for GitHub (`github.com/po0uyan/memsafe`), with a catch-all for other connections.
6. **Publishing**: Created the crate, initialized a Git repo, and published to crates.io with a streamlined workflow.

See the full story in the [GitHub repository](https://github.com/po0uyan/memsafe).

## Repository
- **Source**: [https://github.com/po0uyan/memsafe](https://github.com/po0uyan/memsafe)

## License
Licensed under the MIT License. See [LICENSE](LICENSE) for details.

## Contributing
Issues and pull requests are welcome at [https://github.com/po0uyan/memsafe](https://github.com/po0uyan/memsafe).
I'll be more than happy to merge enhancements! security updates and any steps towards making software world a better place for everyone.
---