From b6b910f0323216b86d32c3204a085f6ad22a4887 Mon Sep 17 00:00:00 2001 From: Daniel Micay Date: Sun, 18 Aug 2019 01:10:20 -0400 Subject: [PATCH] add table of contents to README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index e20877b..b408c0d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,26 @@ # Hardened malloc +* [Introduction](#introduction) +* [Dependencies](#dependencies) +* [Testing](#testing) +* [OS integration](#os-integration) + * [Android-based operating systems](#android-based-operating-systems) + * [Traditional Linux-based operating systems](#traditional-linux-based-operating-systems) +* [Configuration](#configuration) +* [Basic design](#basic-design) +* [Security properties](#security-properties) +* [Randomness](#randomness) +* [Size classes](#size-classes) +* [Scalability](#scalability) + * [Small (slab) allocations](#small-slab-allocations) + * [Thread caching (or lack thereof)](#thread-caching-or-lack-thereof) + * [Large allocations](#large-allocations) +* [Memory tagging](#memory-tagging) +* [API extensions](#api-extensions) +* [System calls](#system-calls) + +## Introduction + This is a security-focused general purpose memory allocator providing the malloc API along with various extensions. It provides substantial hardening against heap corruption vulnerabilities. The security-focused design also leads