PSI Cardinality

Private Set Intersection Cardinality protocol based on ECDH and Bloom Filters.

Requirements

There are requirements for the entire project which each language shares. There also could be requirements for each target language:

Global Requirements

These are the common requirements across all target languages of this project.

• A compiler such as clang, gcc, or msvc
• Bazel

Compiling and Running

The repository uses a folder structure to isolate the supported targets from one another:

psi_cardinality/<target language>/<sources>

C++

See the C++ README.md

JavaScript

See the JavaScript README.md

Go

See the Go README.md

Using the Library

To use this library in another Bazel project, add the following in your WORKSPACE file:

load("@bazel_tools//tools/build_defs/repo:git.bzl", "git_repository")

git_repository(
   name = "org_openmined_psi_cardinality",
   remote = "https://github.com/OpenMined/PSI",
   branch = "master",
   init_submodules = True,
)

load("@org_openmined_psi_cardinality//psi_cardinality:preload.bzl", "psi_cardinality_preload")

psi_cardinality_preload()

load("@org_openmined_psi_cardinality//psi_cardinality:deps.bzl", "psi_cardinality_deps")

psi_cardinality_deps()

A full description of the protocol can be found in the documentation of the PSICardinalityClient class. The corresponding server class is PSICardinalityServer. An example of how to interleave the different phases of the protocol can be found in psi_cardinality_server_test.cpp.