Overview

We recommend using the Docker based setup to play around with CryptOpt. If you want to actually use CryptOpt for production, the results can typically be improved by running it bare metal. See below install instructions.

The main entry point is the ./CryptOpt script, the --help option gives options. You can sudo make install-zsh, if you want to get zsh completion.

Docker Super Jump Start

curl -L https://raw.githubusercontent.com/0xADE1A1DE/CryptOpt/main/Dockerfile > Dockerfile
docker build . -t cryptopt 
docker run --name CryptOpt -ti cryptopt zsh
# shell changes to 123456# 
./CryptOpt --help

With Docker (A Bit More Detailed)

  1. Install Docker or in the Install Docker.md.
  2. Clone this repository, then change into the directory containing the Dockerfile.

  3. Build Container
    Build the container with docker build . -t cryptopt. (. is the build context. It’s the path containing the Dockerfile) This can take a while. (Maybe around 20 minutes, depending on Internet bandwidth and machine) (Note: Depending on your Docker version, it is expected that the some output is red. This is warnings of the build process piped to stderr). The build was successful if it ends naming to docker.io/library/cryptopt (or Sucessfully tagged cryptopt:latest) The build command will create a container image tagged cryptopt, where all the dependencies are installed and the projects are built, ready to go.

  4. Run the container image with docker run --name CryptOpt -ti cryptopt zsh -> you are now in the built project, your terminal should change to something like abcdef1234#

Bare Metal

CryptOpt itself will only write files in the operating systems’ temp directory (/tmp/ on Linux) and in its own subdirectories. It will require internet access to download the (Node.js) runtime and dependencies

  1. Install dependencies (will install globally) (c.f. Dockerfile apt install command(s))
  2. Install AssemblyLine (will install globally)
  3. Clone the repo with --recurse-submodules to also clone submodules for a bunch of useful scripts.
  4. Enable performance counters echo "1" | sudo tee /proc/sys/kernel/perf_event_paranoid (MeasureSuite will otherwise fall back to use RDTSCP to count cycles)
  5. Build CryptOpt with make all. (or DEBUG=1 make all if you want debug info and --verbose Will slow down execution by around 50%) CryptOpt already contains pre-built binaries for fiat-crypto. If you want to build them fresh, too, follow the build instructions in the Dockerfile or on Fiat-Cryptography’s GitHub. Then copy the standalone-ocaml binaries from ./src/ExtractionOCaml/{dettman_multiplication,solinas_reduction,unsaturated_solinas,word_by_word_montgomery} to ./src/bridge/fiat-bridge/data