FutORAMa

Welcome to the FutORAMa repository! This project allows you to test the functionality of the implementation of Oblivious RAM - FutORAMa. The code was tested on Windows 11 machine using Python version 3.10.5. To ensure the smooth execution of the test, please follow the instructions below.

Introduction
Prerequisites
Installation
Run Instructions
Usage
License

Introduction

Oblivious RAM (ORAM) is a general-purpose technique for hiding memory access patterns. This is a fundamental task underlying many secure computation applications.

This project is an implementation of FutORAMa, an ORAM that was published in ACM CCS 2023. FutORAMa implements hierarchical ORAM, optimizing the constructions of PanORAMa and OptORAMa.

Prerequisites

Windows 11 operating system.
Python version 3.10.5 installed on your machine.

Installations

Clone this repository to your local machine using the following command:

git clone https://github.com/cryptobiu/FutORAMa
Install the necessary libraries by executing the following command:

pip install pycryptodomex==3.15.0

pip install numpy==1.23.1

Run Instructions

Now that you have installed the required dependencies, you are all set to run the Oblivious RAM test. To execute the test, use the following command:

python main.py

You will see the two types of tests available:

Enter test type:
1) Real ORAM accesses.
2) Simulated accesses to calculate the approximate bandwidth and round-trips.

Real ORAM accesses: This test executes accesses to an Oblivious RAM implementation. However, please note the following considerations:

The test uses the local RAM as the server, but you can implement the local_RAM.py model differently to suit the client-server model. Note that the elements written on the RAM are not encrypted.
Some Python functions are used for research purposes, and you can replace them with more efficient code (e.g., utilizing the numpy library) to boost performance.

Simulated accesses: This test only simulates accesses and calculates the approximate bandwidth and round-trips without using all the memory. It provides faster performance results without executing real accesses. Please note that this test is an upper-bound approximation.

Acknowledgments

The implementation of FutORAMa in this repository is based on the paper of Gilad Asharov, Ilan Komargodski, Yehuda Michelson: FutORAMa: A Concretely Efficient Hierarchical Oblivious RAM In ACM CCS 2023. We thank Eylon Yogev for suggesting the name "FutORAMa." The code was written by Yehuda Michelson Yehuda.Michelson@gmail.com

Licence

FutORAMa is licensed under the MIT License.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

cryptobiu/FutORAMa