Skip to content

README.md

Latest commit

 

History

History
111 lines (81 loc) · 3.91 KB

README.md

File metadata and controls

111 lines (81 loc) · 3.91 KB

emp-sh2pc

build CodeQL

Which version do I want?

  • Existing projects pinned to a published release: stay on 0.3.0 — branch v0.3.x. Bug fixes and security patches will be backported to v0.3.x.
  • New projects, or willing to migrate: track the development branch (this branch, main). It will become 1.0.0-alpha after a polish pass and then 1.0.0. Builds against emp-tool / emp-ot ≥ 1.0 (unified Backend execution layer, de-templated IO and OT) — but the API is not yet frozen and headers may move between alphas. Requires emp-tool ≥ 1.0.0-alpha and emp-ot ≥ 1.0.0-alpha.

Header-only semi-honest 2PC built on top of emp-tool and emp-ot: garbled-circuit evaluation (half-gates) for Bit / Integer / Float / BristolFormat over a NetIO channel, with batched IKNP COT for input wires.

Requirements

  • CMake ≥ 3.21
  • A C++17 compiler (Clang ≥ 12, GCC ≥ 9, AppleClang 14+)
  • emp-tool ≥ 1.0
  • emp-ot ≥ 1.0
  • pthreads

emp-sh2pc is header-only; the build produces test executables only.

Build and install

emp-sh2pc consumes emp-tool and emp-ot through their installed CMake packages. Install both first, then build emp-sh2pc the same way:

# emp-tool
git clone https://github.com/emp-toolkit/emp-tool.git
cmake -S emp-tool -B emp-tool/build -DCMAKE_BUILD_TYPE=Release
cmake --build emp-tool/build -j
cmake --install emp-tool/build       # respects CMAKE_INSTALL_PREFIX

# emp-ot
git clone https://github.com/emp-toolkit/emp-ot.git
cmake -S emp-ot -B emp-ot/build -DCMAKE_BUILD_TYPE=Release
cmake --build emp-ot/build -j
cmake --install emp-ot/build

# emp-sh2pc
git clone https://github.com/emp-toolkit/emp-sh2pc.git
cmake -S emp-sh2pc -B emp-sh2pc/build -DCMAKE_BUILD_TYPE=Release
cmake --build emp-sh2pc/build -j
cmake --install emp-sh2pc/build

If you don't want to install the dependencies, point emp-sh2pc directly at sibling build trees:

cmake -S emp-sh2pc -B emp-sh2pc/build \
      -DCMAKE_BUILD_TYPE=Release \
      -Demp-tool_DIR=$PWD/emp-tool/build \
      -Demp-ot_DIR=$PWD/emp-ot/build
cmake --build emp-sh2pc/build -j

Test

Tests live under test/ and ship as executables in build/. Both parties run on localhost for local testing, joined by the ./run wrapper script.

  • Local machine, both parties on localhost:

    ./run ./build/[binary] [more opts]

    e.g. ./run ./build/test_bit or ./run ./build/test_example 123.

  • Two machines (IP addresses hardcoded in the test source):

    ./build/[binary] 1 12345 [more opts] on one machine and ./build/[binary] 2 12345 [more opts] on the other.

  • test_example takes a per-party integer; the two parties must use different numbers:

    ./build/test_example 1 12345 123 & ./build/test_example 2 12345 124

ctest --test-dir build --output-on-failure runs the entire suite.

Library use

Downstream CMake projects link against the emp-sh2pc::emp-sh2pc INTERFACE target, which transitively brings in emp-ot::emp-ot and emp-tool::emp-tool:

find_package(emp-sh2pc 1.0 REQUIRED)
target_link_libraries(my-app PRIVATE emp-sh2pc::emp-sh2pc)

Question

Please send email to wangxiao@cs.northwestern.edu

Acknowledgement

This work was supported in part by the National Science Foundation under Awards #1111599 and #1563722.

License

Licensed under the Apache License, Version 2.0 — see LICENSE.