AMCL - Apache Milagro Crypto Library
Clone or download
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.
benchmark Add support for BLS48 in examples and benchmarks Aug 2, 2018
cmake Add curve BLS48 Aug 2, 2018
doc doc: give all file paths to DOxygen Mar 26, 2018
examples Add support for BLS48 in WCC Aug 3, 2018
include
resources Add Makefile that executes in container Nov 13, 2017
src Fix documentation for WCC Aug 30, 2018
test
testVectors add MPIN BLS383 test vector Oct 17, 2018
wrappers/python
.dockerignore Add personalized build image Nov 13, 2017
.gitignore Simplify CMake scripts and follow common conventions Mar 26, 2018
.travis.yml
AMCLConfig.cmake.in Simplify CMake scripts and follow common conventions Mar 26, 2018
CMakeLists.txt fix namespace Nov 6, 2018
CPackConfig.cmake Simplify CMake scripts and follow common conventions Mar 26, 2018
Dockerfile
LICENSE Initial commit Mar 10, 2016
Makefile Add BLS48 to coverage build Aug 3, 2018
Makefile.docker
README.md
RELEASE
VERSION
amcl.pc.in Removes -l from amcl.pc.in which results in a spurious flag generated… Sep 28, 2018
buildMulti.sh Simplify CMake scripts and follow common conventions Mar 26, 2018
cmake_uninstall.cmake.in Add src and a few tests. Jul 14, 2017
config.mk make: use BUILD_DOCS instead of BUILD_DOXYGEN Mar 26, 2018

README.md

AMCL - Apache Milagro Crypto Library

Branch Build Status Coverage Status

Description

AMCL - Apache Milagro Crypto Library

AMCL is a standards compliant C cryptographic library with no external dependencies, specifically designed to support the Internet of Things (IoT).

For a detailed explanation about this library please read: doc/AMCL.pdf

AMCL is provided in C language but includes a Python wrapper for some modules to aid development work.

NOTE: This product includes software developed at The Apache Software Foundation.

Software Dependencies

In order to build this library, the following packages are required:

  • CMake is required to build the source code.
  • CFFI, the C Foreign Function Interface for Python is required in order to execute tests.
  • Doxygen is required to build the source code documentation.
  • Python language is required to build the Python language wrapper.

The above packages can be installed in different ways, depending on the Operating System used:

  • Debian/Ubuntu Linux

    sudo apt-get install -y git cmake build-essential python python-dev python-pip libffi-dev doxygen doxygen-latex parallel sudo pip install cffi

  • RedHat/CentOS/Fedora Linux

    sudo yum groupinstall "Development Tools" "Development Libraries" sudo yum install -y git cmake python libpython-devel python-pip libffi-devel doxygen doxygen-latex parallel sudo pip install cffi

  • MacOS

    ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" brew install cmake brew install pkg-config libffi sudo pip install cffi brew install doxygen brew install parallel

  • Windows

    • Minimalist GNU for Windows MinGW provides the tool set used to build the library and should be installed
    • When the MinGW installer starts select the mingw32-base and mingw32-gcc-g++ components
    • From the menu select "Installation""Apply Changes", then click "Apply"
    • Finally add C:\MinGW\bin to the PATH variable
    • pip install cffi
    • install CMake following the instructions on http://www.cmake.org
    • install Doxygen following the instructions on http://www.doxygen.org

Build Instructions

Linux and Mac

Quick start

A Makefile is present at the project root that reads the options defined in config.mk. Change these options and then type the following to build and test the library.

make
Multiple curves and RSA security levels

The default build (see config.mk) uses multiple curves and RSA security levels. There is an example called testall.c in the examples directory that shows how to write a program to use the different curves etc in a single program. To build and run the example use this script;

buildMulti.sh
Manual build

NOTE: The default build is for 64 bit machines

git clone https://github.com/milagro-crypto/milagro-crypto-c
cd milagro-crypto-c
mkdir -p target/build
cd target/build
cmake -D CMAKE_INSTALL_PREFIX=/opt/amcl ../..
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:./
make
make test
make doc
sudo make install

On Debian/Ubuntu machine instead of executing the "sudo make install" command it is possible to execute "sudo checkinstall" to build and install a DEB package.

Now you can set the path to where libs and python package are installed:

export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:./:/opt/amcl/lib
export PYTHONPATH=/usr/lib/python2.7/dist-packages

NOTE: The build can be configured by setting flags on the command line, for example:

cmake -DAMCL_CHUNK=64 ../..
cmake -D CMAKE_INSTALL_PREFIX=/opt/amcl -D AMCL_CHUNK=64 -D BUILD_WCC=on ../..

It is possible also to build the library supporting more than one elliptic curve and more than one RSA security level, for example

cmake -DAMCL_CURVE=BN254CX,NIST254 -DAMCL_RSA=2048,3072 ../..

To list other available CMake options, use:

cmake -LH
Uninstall software
sudo make uninstall
Building an installer

After having built the libraries you can build a binary installer and a source distribution by running this command

make package

Windows

Start a command prompt as an administrator

git clone https://github.com/milagro-crypto/milagro-crypto-c
cd milagro-crypto-c
mkdir target\build
cd target\build
cmake -G "MinGW Makefiles" ..\..
mingw32-make
mingw32-make test
mingw32-make doc
mingw32-make install

Post install append the PATH system variable to point to the install ./lib:

My Computer -> Properties -> Advanced > Environment Variables

The build can be configured using by setting flags on the command line i.e.

cmake -G "MinGW Makefiles" -D BUILD_PYTHON=on ..
Uninstall software
mingw32-make uninstall
Building an installer

After having built the libraries you can build a Windows installer using this command

sudo mingw32-make package

In order for this to work NSSI has to have been installed

Contributions

This project includes a Makefile that allows you to test and build the project in a Linux-compatible system with simple commands. All the artifacts and reports produced using this Makefile are stored in the target folder.

All the packages listed in the Dockerfile are required in order to build and test all the library options in the current environment. Alternatively, everything can be built inside a Docker container using the command "make -f Makefile.docker buildall".

To see all available options:

make help

To build the builder Docker image:

make -f Makefile.docker

To build the project inside a Docker container (requires Docker) you need to build a builder image (once), and then build the project in its context:

make -f Makefile.docker buildall

To build a particular set of predefined makefile options inside a Docker container:

make -f Makefile.docker build TYPE=LINUX_64BIT_NIST256_RSA2048

To execute all the test builds and generate reports in the current environment:

make qa

To format the code (please use this command before submitting any pull request):

make format