Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PrivyHarbor authored Sep 11, 2024
1 parent f4f47bf commit 77936a3
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,20 @@

## Introduction

<!-- start-petace-setops-overview -->

PETAce-SetOps is a collection of protocols that perform private set operations.
It is one of the many components in [the framework PETAce](https://github.com/tiktok-privacy-innovation/PETAce).

Private set operations generally include private set intersection (PSI), private join and compute (PJC), and private information retrieval (PIR) protocols.
Currently, PETAce-SetOps implements the ECDH-PSI protocol based on Elliptic-Curve Diffie-Hellman, the [KKRT-PSI](https://dl.acm.org/doi/abs/10.1145/2976749.2978381) protocol based on Oblivious Pseudorandom Functions (OPRF), and the PJC protocol based on [Circuit-PSI](https://www.researchgate.net/publication/356421123_Circuit-PSI_With_Linear_Complexity_via_Relaxed_Batch_OPPRF).

<!-- end-petace-setops-overview -->

## Requirements

<!-- start-petace-setops-getting-started -->

| System | Toolchain |
|--------|-------------------------------------------------------|
| Linux | Clang++ (>= 5.0) or GNU G++ (>= 5.5), CMake (>= 3.15) |
Expand Down Expand Up @@ -71,6 +77,8 @@ To run as Party B (a receiver):
bash build/example/scripts/ecdh_psi_receiver_example.sh
```

<!-- end-petace-setops-getting-started -->

## Contribution

Please check [Contributing](CONTRIBUTING.md) for more details.
Expand Down

0 comments on commit 77936a3

Please sign in to comment.