Inferencium/website
1
0
Fork 0
Code Issues Activity

Update webpage "Documentation - hardened_malloc" from version "1.1.0-beta.1" to "2.0.0-beta.1"

Browse Source
This commit is contained in:
inference 2024-01-14 04:54:42 +00:00
parent 57218ea093
commit c5550113fe
Signed by: inference
SSH Key Fingerprint: SHA256:FtEVfx1CmTKMy40VwZvF4k+3TC+QhCWy+EmPRg50Nnc
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
documentation/hardened_malloc.html → documentation/hardened_malloc.xhtml
View File

@ -1,13 +1,13 @@
<!DOCTYPE html>
<!-- Inferencium - Website - Documentation - GrapheneOS hardened_malloc -->
<!-- Version: 1.1.0-beta.1 -->
<!-- Version: 2.0.0-beta.1 -->
<!-- Copyright 2023 Jake Winters -->
<!-- SPDX-License-Identifier: BSD-3-Clause -->
<html lang="en">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
@ -16,16 +16,16 @@
</head>
<body>
<nav class="navbar">
<div><a href="../index.html"><img src="../asset/img/logo-inferencium-no_text.png" width="110px" height="110px"/></a></div>
<div><a href="../index.html" class="title">Inferencium</a></div>
<div><a href="../about.html">About</a></div>
<div><a href="../contact.html">Contact</a></div>
<div><a href="../blog.html">Blog</a></div>
<div><a href="../documentation.html">Documentation</a></div>
<div><a href="../source.html">Source</a></div>
<div><a href="../key.html">Key</a></div>
<div><a href="../changelog.html">Changelog</a></div>
<div><a href="../directory.html">Directory</a></div>
<div><a href="../index.xhtml"><img src="../asset/img/logo-inferencium-no_text.png" width="110px" height="110px"/></a></div>
<div><a href="../index.xhtml" class="title">Inferencium</a></div>
<div><a href="../about.xhtml">About</a></div>
<div><a href="../contact.xhtml">Contact</a></div>
<div><a href="../blog.xhtml">Blog</a></div>
<div><a href="../documentation.xhtml">Documentation</a></div>
<div><a href="../source.xhtml">Source</a></div>
<div><a href="../key.xhtml">Key</a></div>
<div><a href="../changelog.xhtml">Changelog</a></div>
<div><a href="../directory.xhtml">Directory</a></div>
</nav>
<section id="introduction">
<h1 id="introduction"><a href="#introduction">Documentation - GrapheneOS hardened_malloc</a></h1>
@ -40,10 +40,10 @@
<p>For the complete hardened_malloc documentation, visit its
<a href="https://github.com/GrapheneOS/hardened_malloc#hardened_malloc">official documentation</a>.</p>
<p>This documentation is also available in portable AsciiDoc format in my
<a href="https://src.inferencium.net/Inferencium/doc/src/branch/stable/security/hardened_malloc.adoc">documentation source code repository</a>.
<a href="https://src.inferencium.net/Inferencium/doc/src/branch/stable/security/hardened_malloc.adoc">documentation source code repository</a></p>.
</section>
<nav id="toc">
<h2 id="toc"><a href="#toc">Table of Contents<a/></h2>
<h2 id="toc"><a href="#toc">Table of Contents</a></h2>
<ul>
<li><a href="#memory_pages">Increase Permitted Amount of Memory Pages</a></li>
<li><a href="#clone_source_code">Clone hardened_malloc Source Code</a></li>
@ -69,13 +69,13 @@
</section>
<section id="compile">
<h2 id="compile"><a href="#compile">Compile hardened_malloc</a></h2>
<p><p><code>$ make <var>&lt;arguments&gt;</var></code></p>
<p><code>$ make <var>&lt;arguments&gt;</var></code></p>
<p><code>CONFIG_N_ARENA=<var>n</var></code> can be adjusted to increase parallel
performance at the expense of memory usage, or decrease memory usage at the expense of
parallel performance, where <var>n</var> is an integer. Higher values prefer parallel
performance, lower values prefer lower memory usage. The number of arenas has no impact
on the security properties of hardened_malloc.<br>
<b>Minimum number of arenas:</b> 1<br>
on the security properties of hardened_malloc.<br/>
<b>Minimum number of arenas:</b> 1<br/>
<b>Maximum number of arenas:</b> 256</p>
<p>For extra security, <code>CONFIG_SEAL_METADATA=true</code> can be used in order to
control whether Memory Protection Keys are used to disable access to all writable
@ -98,8 +98,8 @@
<h2 id="preload_on_boot"><a href="#preload_on_boot">Set System to Preload hardened_malloc on Boot</a></h2>
<p><b>musl-based systems:</b> Add
<code>export LD_PRELOAD="<var>&lt;hardened_malloc path&gt;</var>"</code> to
<code>/etc/environment</code><br>
<b>glibc-based systems:</b> Add <code><var>&lt;hardened_malloc path&gt;</var></code> to
<code>/etc/environment</code></p>
<p><b>glibc-based systems:</b> Add <code><var>&lt;hardened_malloc path&gt;</var></code> to
<code>/etc/ld.so.preload</code></p>
</section>
</body>