a new specification language for crypto primitives
Clone or download
Latest commit 6c65708 Nov 27, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
archive clean-up and small re-org Oct 23, 2018
build
compiler
doc paper update Nov 27, 2018
docker/travis-compiler
lib hotfix ocaml checker and enable on travis for passing specs Nov 6, 2018
specs
tests
tools update Jun 18, 2018
.gitignore
.travis.yml clean-up and small re-org Oct 23, 2018
LANGUAGE.md some vlybtes clean-up May 19, 2018
Makefile add basic import support to compiler; make aead pass checker Nov 7, 2018
README.md

README.md

hacspec

hacspec is a proposal for a new specification language for crypto primitives that is succinct, that is easy to read and implement, and that lends itself to formal verification.

hacspec aims to formalize the pseudocode used in crypto standards by proposing a formal syntax that can be checked for simple errors. hacspec specifications can then be tested against test vectors specified in a common syntax.

hacspec specifications can also be compiled to cryptol, coq, F*, easycrypt, and hence can be used as the basis for formal proofs of functional correctness, cryptographic security, and side-channel resistance.

status

Build Status

This project is still in the early stages. We invite submissions of crypto specs in various formal languages and comments and suggestions for the specification syntax. This repository currently holds some preliminary examples collected at the HACS workshop in January 2018.

compiler

See compilers for details.

How to use

To use hacspec in your project install the hacspec python package as follows.

Installation via pip

hacspec is distributed as a pip package

pip install hacspec

To install the hacspec package from its source clone this repository and run

make -C build install

Now you can use the speclib in your python code with

from hacspec.speclib import *

The package further provides a tool to check hacpsec files for its correctness

hacspec-check <your-hacspec>

See the example directory for a spec using the hacspec python package.

Development

When working on hacspec itself installation is not necessary. The makefile has three main targets

make run     // disabled type checker
make check   // check hacspec compliance
make test    // run tests with type checker enabled

to run or check specs.

contact

Discussions are happening on the mailing list.

Chat with us on gitter.