ABY 3 and Applications

Introduction

This library provides the semi-honest implementation of ABY 3 and Fast Database Joins for Secret Shared Data.

The repo includes the following application:

Linear Regression (training/inference)
Logistic Regression (training/inference)
Database Inner, Left and Full Joins
Database Union
Set Cardinality
Threat Log Comparison (see Section 5)
ERIC Application (see Section 5)

Note that this is not the same implementation provided in the publication ABY3: A Mixed Protocol Framework for Machine Learning, however it is very similar. Basicly a less optimized but more usable reimplementation by that was done for the database paper. If you wish to have the original ABY3 implementation, please contact the authors.

Warning

This codebase should NOT be considered fully secure. It has not had a security review and there are still several security related issues that have not been fully implemented. Only use this casebase as a proof-of-concept or to benchmark the perfromance. Future work is required for this implementation to be considered secure.

Moreover, some features have not been fully developed and contains bugs. For example, the task scheduler sometime fails. This is a known issue.

Install

The library is cross platform and has been tested on Windows and Linux. The dependencies are:

libOTe
Boost (networking)
function2
Eigen

Windows

Clone and build libOTe.
Edit libOTe/cryptoTools/cryptoTools/Common/config.h to contain #define ENABLE_CIRCUITS ON.
git clone https://github.com/ladnir/aby3.git
cd C:\
mkdir libs
Download Eigen to C:\libs\eigen.
git clone https://github.com/Naios/function2.git to C:\libs\function2.

Open aby3.sln in visual studio and build it. Note, you can place Eigen and function2 in a different location and update the aby3 project files to reference this location.

To see all the command line options, execute the program

frontend.exe

Linux / Mac

In short, this will build the project

git clone --recursive https://github.com/osu-crypto/libOTe.git
cd libOTe/cryptoTools/thirdparty/linux
bash boost.get
cd ../../..
cmake . -DENABLE_CIRCUITS=ON
make -j
cd ../
git clone https://github.com/ladnir/aby3.git
cd thirdparty/linux
bash eigen.get
bash function2.get
cd ../..
cmake .
make -j

To see all the command line options, execute the program

./bin/frontend

Linking

To use the library in your project, you will need to link the following:

.../libOTe
.../libOTe/cryptoTools
.../libOTe/cryptoTools/thirdparty/linux/boost
.../aby3

and link:

.../libOTe/bin/liblibOTe.a
.../libOTe/bin/libcryptoTools.a
.../aby3/bin/libaby3.a
.../libOTe/cryptoTools/thirdparty/linux/boost/stage/lib/libboost_system.a
.../libOTe/cryptoTools/thirdparty/linux/boost/stage/lib/libboost_thread.a

Note: On windows the linking paths follow a similar pattern.

Help

Contact Peter Rindal peterrindal@gmail.com for any assistance on building or running the library.

Citing

Spread the word!

@misc{aby3,
    author = {Peter Rindal},
    title = {{The ABY3 Framework for Machine Learning and Database Operations.}},
    howpublished = {\url{https://github.com/ladnir/aby3}},
}

vincehong / aby3