secrets 0.9.1

Protected-access memory for cryptographic secrets
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

[![Build Status][travis-badge]][travis-url]

secrets
=======

A library to help safely hold cryptographic secrets in memory.

Buffers allocated through this library:

* restrict themselves from being read from and written to by default
* allow access to their contents in explicit, limited scopes
* are never included in core dumps
* are never swapped to permanent storage (using `mlock`)
* are protected from overflows and underflows by inaccessible guard pages (using `mprotect`)
* are protected from underflows by a random canary
* immediately sanitize the contents of the memory used to initialize them
* immediately sanitize the contents of their own memory when they leave scope

Example
-------

```rust
extern crate secrets;

use secrets::Secret;

fn main() {
  let secret = Secret.new( /* &mut [u8] */);
  let slice  = secret.read();

  println!("{}", &*slice);
}
```

License
-------

`secrets` is distributed under the [MIT license](./LICENSE).

Links
-----

* [crate](https://crates.io/crates/secrets)
* [docs](https://stouset.github.io/secrets)

[travis-badge]: https://travis-ci.org/stouset/secrets.svg?branch=master
[travis-url]:   https://travis-ci.org/stouset/secrets