Installation

Before you start

tlspuffin relies on Nix to set up an environment with all the necessary dependencies and to provide a consistent development experience. This guide will leverage Nix to simplify the installation process and we strongly encourage you to set up Nix on your machine as a pre-requisite. If you are new to Nix, we recommend using the Zero to Nix install guide.

Otherwise, you can manually install the dependencies listed in the repository's README file as well as the dependencies for building the OpenSSL fuzz target used in this guide.

Install

Download the latest sources of tlspuffin:

git clone https://github.com/tlspuffin/tlspuffin

Note that all the subsequent commands in this guide should be run from the root tlspuffin folder that was just downloaded through git:

cd tlspuffin

The provided nix shell environment will provide all the dependencies and tools necessary for this guide:

nix-shell