Skip to content
HACL*, a formally verified cryptographic library written in F*
Branch: master
Clone or download
Pull request Compare This branch is 7 commits ahead, 1073 commits behind project-everest:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.ci
apps
code
dependencies
doc
other_providers
secure_api
snapshots
specs
test
.gitattributes
.gitignore
.gitmodules
.travis.yml
CMakeLists.txt
Dockerfile
INSTALL.md
Makefile
README.md
ROADMAP.md

README.md

HaCl-star

HaCl* is a formally verified cryptographic library in F*, developed as part of Project Everest.

Build Status

HACL stands for High-Assurance Cryptographic Library and its design is inspired by discussions at the HACS series of workshops. The goal of this library is to develop reference implementations for popular cryptographic primitives and to verify them for memory safety, side-channel resistance, and (where applicable) functional correctness.

All code is written and verified in F* and then compiled to C or to OCaml for execution.

The primitives and constructions supported currently are:

  • Stream ciphers: Chacha20, Salsa20, XSalsa20
  • MACs: Poly1305
  • Elliptic Curves: Curve25519
  • Elliptic Curves Signatures: Ed25519
  • Hash functions: SHA2 (256,384,512)
  • MAC: HMAC
  • NaCl API: secret_box, box

HACL* can be used in two ways. The verified primitives can be directly used in larger verification projects. For example, HACL* code is used as the basis for cryptographic proofs of the TLS record layer in miTLS. Alternatively, developers can use HACL* through the NaCl API. In particular, we implement the same C API as libsodium for the Box and SecretBox primitives, so any application that runs on libsodium can be immediately ported to use the verified code in HACL* instead.

Warning

This library is experimental and only at the pre-production stage.

Do not use it in production systems without consulting the authors.

Build and Installation

See INSTALL.md.

For convenience, C code for our verified primitives has already been extracted and is available in snapshots/hacl-c. To build the library, you need a modern C compiler (preferably GCC-6) and CMake.

To build a static and shared versions of this library:

make build

Verification and Extraction

See INSTALL.md.

To verify the F* code, you need to install the F* typechecker. To extract F* code to C, you need to install the KreMLin compiler.

Performance

HACL* primitives, when compiled to C, are as fast as state-of-the-art C implementations. You can see the numbers for your platform and C compiler by running make test in the snapshot folder.

To compare its performance with the C reference code in libsodium and openssl, download and compile libsodium with the --disable-asm flag and openssl with the -no-asm flag.

While the raw performance is quite good, HaCl is not as fast as hand-written assembly code. Linking HACL* to verified assembly language components is a long-term goal.

Experimental features

The code/experimental directory includes other (partially verified) cryptographic primitives that will become part of the library in the near future:

  • Elliptic Curves: NIST P-256, Curve448
  • Encryption: AES-128, AES-256
  • MACs: GCM
  • Key Derivation: HKDF

To build a static and shared versions of the experimental library:

make build-experimental

We are also working on a JavaScript backend to F* that would enable us to extract HACL* as a JavaScript library.

Maintainers

  • Jean-Karim Zinzindohoué
  • Karthikeyan Bhargavan
  • Benjamin Beurdouche
You can’t perform that action at this time.