secmem-proc 0.1.1

Process hardening through system APIs
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

# secmem-proc ![License: MIT OR Apache-2.0](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue) [![secmem-proc on crates.io](https://img.shields.io/crates/v/secmem-proc)](https://crates.io/crates/secmem-proc) [![Source Code Repository](https://img.shields.io/badge/Code-On%20GitHub-blue?logo=GitHub)](https://github.com/niluxv/secmem-proc)

`secmem-proc` is a crate designed to harden a process against *low-privileged* attackers running on the same system trying to obtain secret memory contents of the current process. More specifically, the crate disables core dumps and tries to disable tracing on unix-like OSes.

**Note**: all the crate does is *hardening*, i.e. it tries to make attacks *harder*. It can by no means promise any security! In particular, when an attacker ptrace attaches to the process before `harden_process` is executed, it is game over for the process. This crate is no substitute for properly hardening your OS (configuration)!

Note that hardening the process also severely limits the ability to debug it. Therefore you are advised to only harden release builds, not debug builds.


## Examples

In the below example the main function of some application calls the main hardening function provided by this crate: `harden_process`. This will perform all available hardening steps on the target platform. If an error is returned then one of the hardening steps failed and the process is quits at the `return` after printing an error to stdout.


```rust
fn main() {
    // call `secmem_proc::harden_process` before doing anything else, to harden the process
    // against low-privileged attackers trying to obtain secret parts of memory which will
    // be handled by the process
    if secmem_proc::harden_process().is_err() {
        println!("ERROR: could not harden process, exiting");
        return;
    }
    // rest of your program
}
```

If you have the `std` feature enabled you can get more informative errors using [`harden_process_std_err`][__link0] instead of [`harden_process`][__link1].


## Cargo features

 - `std` (default): Enable functionality that requires `std`. Currently only required for `Error` implements and required for tests. This feature is enabled by default.
 - `rlimit`: Expose a minimal resource limit API in the `rlimit` module.
 - `dev`: This feature enables all features required to run the test-suite, and should only be enabled for that purpose.


## Implementation

 - Disable ptrace and core dumps on the process on linux using prctl
 - Disable ptrace and core dumps on the process on freebsd using procctl
 - Disable ptrace on macos using ptrace
 - Disable core dumps for the process on posix systems using rlimit
 - Set restricted DACL for the process on windows


## TODOs

 - add API allowing to set a custom DACL on windows
 - improve tests (how exactly?)


 [__link0]: https://docs.rs/secmem-proc/0.1.0/secmem_proc/?search=secmem_proc::harden::harden_process_std_err
 [__link1]: https://docs.rs/secmem-proc/0.1.0/secmem_proc/?search=secmem_proc::harden::harden_process