add table of contents to README

This commit is contained in:
Daniel Micay 2019-08-18 01:10:20 -04:00
parent 24de5aab05
commit b6b910f032

View File

@ -1,5 +1,26 @@
# Hardened malloc # 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 This is a security-focused general purpose memory allocator providing the
malloc API along with various extensions. It provides substantial hardening malloc API along with various extensions. It provides substantial hardening
against heap corruption vulnerabilities. The security-focused design also leads against heap corruption vulnerabilities. The security-focused design also leads