Add privilege requirements.

This commit is contained in:
inference 2023-06-13 12:31:35 +01:00
parent e1e946211f
commit 9529ff5823
Signed by: inference
SSH Key Fingerprint: SHA256:9Pl0nZ2UJacgm+IeEtLSZ4FOESgP1eKCtRflfPfdX9M

View File

@ -1,12 +1,14 @@
= GrapheneOS hardened_malloc
Version: 0.1.0.8
Version: 0.1.0.9
This documentation contains instructions to use
https://github.com/GrapheneOS/hardened_malloc[GrapheneOS hardened_malloc] memory allocator as the
system's default memory allocator. These instructions apply to both musl and glibc C libraries on
Unix-based and Unix-like systems.
Unix-based and Unix-like systems. hardened_malloc can also be used per-application and/or per-user,
in which case root permissions are not required, but this documentation focuses on system-wide usage
of hardened_malloc.
== Increase Permitted Amount of Memory Pages
@ -16,15 +18,15 @@ of guard pages.
== Clone hardened_malloc Source Code
`git clone https://github.com/GrapheneOS/hardened_malloc.git`
`$ git clone https://github.com/GrapheneOS/hardened_malloc.git`
== Enter hardened_malloc Local Git Repository
`cd hardened_malloc/`
`$ cd hardened_malloc/`
== Compile hardened_malloc
`make <arguments>`
`$ make <arguments>`
`CONFIG_N_ARENA=n` can be adjusted to increase parallel performance at the expense of memory usage,
or decrease memory usage at the expense of parallel performance, where `n` is an integer; higher
@ -34,7 +36,7 @@ security for much less memory usage.
== Copy Compiled hardened_malloc Library
`cp out/libhardened_malloc.so <target_path>`
`# cp out/libhardened_malloc.so <target_path>`
== Set System to Preload hardened_malloc on Boot