I have merged this repo to the original S3ORAM repo under the new branch. Check it out here. This repository will not be updated any more.

libS3ORAM

Implementation of libS3ORAM framework, an extension of S3ORAM scheme in CCS'17 that supports k-ary tree and Circuit-ORAM layout. The full paper is currently under review, which will be available soon.

This repository is just open for review purpose. We will merge this with our original S3ORAM repo (http://github.com/thanghoang/S3ORAM) after the review is complete! The code is not fully well-organized, we will update it soon.

This project is built on CodeLite IDE (link: http://codelite.org). It is recommended to install CodeLite to load the full libS3ORAM workspace.

Updates

2018-12-30: S3ORAM now has a new scheme that leverages the eviction paradigm in Circuit-ORAM. S3ORAM now also supports k-ary tree layout.
2017-12-25: S3ORAM now supports more than 3 servers with higher privacy levels.

Required Libraries

NTL v9.10.0 (download link: http://www.shoup.net/ntl/download.html)
ZeroMQ (download link: http://zeromq.org/intro:get-the-software)

Configuration

All libS3ORAM Framework configurations are located in libS3ORAM/config.h.

To use Circuit-ORAM eviction paradigm

Enable the macro #define CORAM_LAYOUT in libS3ORAM/config.h.

To use k-ary tree Layout

Modify the value in the macro #define K_ARY in libS3ORAM/config.h.

To use the default S3ORAM in CCS'17

Disable the macro #define CORAM_LAYOUT and enable the macro #define TRIPLET_EVICTION in libS3ORAM/config.h.

Highlighted Parameters:


#define BLOCK_SIZE 128                                -> Block size (in bytes)

#define HEIGHT 4                                      -> Height of S3ORAM Tree

static const unsigned long long P = 1073742353;       -> Prime field (size should be equal to the defined TYPE_DATA)

#define NUM_SERVERS 7                                 -> Number of servers \ell.
#define PRIVACY_LEVEL 3                               -> Privacy level t. 

const long long int vandermonde[NUM_SERVERS]          -> The first row of inverse of vandermonde matrix (should be defined according to SERVER_ID from 1....n)

const std::string SERVER_ADDR[NUM_SERVERS]            -> Server IP addresses
#define SERVER_PORT 5555                              -> Define the first port for incremental to generate other ports for client-server / server-server communications

Notes

It is recommended to select EVICT_RATE = BUCKET_SIZE/2, and BUCKET_SIZE>73 to avoid bucket overflow.

The folder libS3ORAM/data is required to store generated S3ORAM data structure.

Build & Compile

Goto folder libS3ORAM/ and execute

make

, which produces the binary executable file named libS3ORAM in libS3ORAM/Debug/.

Usage

Run the binary executable file libS3ORAM, which will ask for either Client or Server mode. The S3ORAM implementation can be tested using either single machine or multiple machines:

Local Testing:

Set SERVER_ADDR in libS3ORAM/config.h to be localhost.
Choose unique SERVER_PORT and SERVER_RECV_PORT for each server entity.
Compile the code with make in the libS3ORAM/ folder.
Go to libS3ORAM/Debug and run the compiled libS3ORAM file in different Terminals, each playing the client/server role.

Real Network Testing:

Copy the binary file libS3ORAM compiled under the same configuration to running machines.
For first time usage, run the libS3ORAM/Debug/libS3ORAM file on the client machine to initialize the S3ORAM structure first.
Copy the folder libS3ORAM/data/i/ to server i, or follow the instruction on the client machine to transmit all data to corresponding server (It is recommend to manually copy the folder to avoid interuption during tranmission).
For each server i, run the compiled file libS3ORAM and select the server role (option 2) and the corresponding ID i.

Android Build

(to be updated)

Further Information

For any inquiries, bugs, and assistance on building and running the code, please contact me athoangm@mail.usf.edu.

thanghoang/libS3ORAM