Lib.rs

oram

This library implements an Oblivious RAM (ORAM) for secure enclave applications.

This crate assumes that ORAM clients are running inside a secure enclave architecture that provides memory encryption. It does not perform encryption-on-write and thus is not secure without memory encryption.

⚠️ Warning: This implementation has not been audited. Use at your own risk!

Documentation

The API can be found here along with an example for usage.

Installation

Add the following line to the dependencies of your Cargo.toml:

oram = "0.1"

Minimum Supported Rust Version

Rust 1.74 or higher.

Resources

• Original Path ORAM paper, which introduced the standard "vanilla" variant of Path ORAM on which this library is based.
• Path ORAM retrospective paper, containing a high-level overview of developments related to Path ORAM.
• Oblix paper, which describes the oblivious stash data structure this library implements.

Contributors

The authors of this code are Spencer Peters (@spencerpeters) and Kevin Lewi (@kevinlewi). To learn more about contributing to this project, see this document.

Code Organization

Within src/:

• lib.rs defines the Oram trait and public API.
• path_oram.rs defines the main ORAM implementation.
• position_map.rs and stash.rs define the oblivious position map and stash respectively.
• bucket.rs defines low-level block and bucket structs.
• linear_time_oram.rs contains a trivial linear-time ORAM implementation used as a base case.
• database.rs defines a simple RAM abstraction (to be removed).
• utils.rs contains utilities related to oblivious sorting and tree index calculations.
• test_utils.rs contains code shared between tests.

License

This project is dual-licensed under either the MIT license or the Apache License, Version 2.0. You may select, at your option, one of the above-listed licenses.