feat: version 0.3.0

tiktok-privacy-innovation · Jun 27, 2024 · f4f47bf · f4f47bf
1 parent 89a68a8
commit f4f47bf
Show file tree

Hide file tree

Showing 23 changed files with 35 additions and 771 deletions.
diff --git a/.gitignore b/.gitignore
@@ -574,6 +574,9 @@ paket-files/
 __pycache__/
 *.pyc
 
+# pycharm
+.idea
+
 # Cake - Uncomment if you are using it
 # tools/**
 # !tools/packages.config

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,4 +12,10 @@
 ### Features
 
 - Added KKRT-PSI
-- Added Circuit-PSI
+- Added Circuit-PSI
+
+## Version 0.3.0
+
+### Feature
+
+- Migrated Python API to PETAce repository.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -30,7 +30,7 @@ if(NOT CMAKE_BUILD_TYPE)
 endif()
 message(STATUS "Build type (CMAKE_BUILD_TYPE): ${CMAKE_BUILD_TYPE}")
 
-project(SETOPS VERSION 0.2.0 LANGUAGES CXX C)
+project(SETOPS VERSION 0.3.0 LANGUAGES CXX C)
 
 ########################
 # Global configuration #
@@ -203,7 +203,7 @@ if(NOT TARGET OpenMP::OpenMP_CXX)
 endif()
 
 # PETAce-Network::network
-find_package(PETAce-Network 0.2 QUIET CONFIG)
+find_package(PETAce-Network 0.3 QUIET CONFIG)
 if(PETAce-Network_FOUND)
     message(STATUS "PETAce-Network: found")
     if(PETAce-Network_STATIC_FOUND)
@@ -227,7 +227,7 @@ else()
 endif()
 
 # PETAce-Solo::solo
-find_package(PETAce-Solo 0.2 QUIET CONFIG)
+find_package(PETAce-Solo 0.3 QUIET CONFIG)
 if(PETAce-Solo_FOUND)
     message(STATUS "PETAce-Solo: found")
     if(PETAce-Solo_STATIC_FOUND)
@@ -251,7 +251,7 @@ else()
 endif()
 
 # PETAce-Verse::verse
-find_package(PETAce-Verse 0.2 QUIET CONFIG)
+find_package(PETAce-Verse 0.3 QUIET CONFIG)
 if(PETAce-Verse_FOUND)
     message(STATUS "PETAce-Verse: found")
     if(PETAce-Verse_STATIC_FOUND)
@@ -275,7 +275,7 @@ else()
 endif()
 
 # PETAce-Duet::duet
-find_package(PETAce-Duet 0.2 QUIET CONFIG)
+find_package(PETAce-Duet 0.3 QUIET CONFIG)
 if(PETAce-Duet_FOUND)
     message(STATUS "PETAce-Duet: found")
     if(PETAce-Duet_STATIC_FOUND)
@@ -369,12 +369,9 @@ if(NOT SETOPS_BUILD_SHARED_LIBS)
         target_include_directories(setops PUBLIC
             $<BUILD_INTERFACE:$<TARGET_PROPERTY:${network},INTERFACE_INCLUDE_DIRECTORIES>>
             $<INSTALL_INTERFACE:${SETOPS_INCLUDES_INSTALL_DIR}>)
-        setops_combine_archives(setops ${network})
-        set(SETOPS_CARRY_NETWORK TRUE)
-    else()
-        target_link_libraries(setops PUBLIC ${network})
-        set(SETOPS_CARRY_NETWORK FALSE)
     endif()
+    target_link_libraries(setops PUBLIC ${network})
+    set(SETOPS_CARRY_NETWORK FALSE)
 
     if(SETOPS_BUILD_SOLO)
         add_dependencies(setops ${solo})
@@ -575,17 +572,3 @@ if(SETOPS_BUILD_TEST)
             WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR})
     endif()
 endif()
-
-##################
-# SETOPS python #
-##################
-
-# [OPTION] SETOPS_BUILD_PYTHON (DEFAULT: OFF)
-# Build a shared library if set to ON.
-set(SETOPS_BUILD_PYTHON_STR "Build python shared library")
-option(SETOPS_BUILD_PYTHON ${SETOPS_BUILD_PYTHON_STR} OFF)
-message(STATUS "SETOPS_BUILD_PYTHON: ${SETOPS_BUILD_PYTHON}")
-
-if(SETOPS_BUILD_PYTHON)
-    add_subdirectory(python)
-endif()
diff --git a/README.md b/README.md
@@ -16,10 +16,10 @@ Currently, PETAce-SetOps implements the ECDH-PSI protocol based on Elliptic-Curv
 
 | Required dependency                                                            | Tested version | Use                                  |
 |--------------------------------------------------------------------------------|----------------|--------------------------------------|
-| [PETAce-Solo](https://github.com/tiktok-privacy-innovation/PETAce-Solo)        | 0.2.0          | Cryptography primitives              |
-| [PETAce-Verse](https://github.com/tiktok-privacy-innovation/PETAce-Verse)      | 0.2.0          | Primitive cryptographic protocols    |
-| [PETAce-Duet](https://github.com/tiktok-privacy-innovation/PETAce-Duet)        | 0.2.0          | Two-party secure computing protocols |
-| [PETAce-Network](https://github.com/tiktok-privacy-innovation/PETAce-Network)  | 0.2.0          | Network communication protocols      |
+| [PETAce-Solo](https://github.com/tiktok-privacy-innovation/PETAce-Solo)        | 0.3.0          | Cryptography primitives              |
+| [PETAce-Verse](https://github.com/tiktok-privacy-innovation/PETAce-Verse)      | 0.3.0          | Primitive cryptographic protocols    |
+| [PETAce-Duet](https://github.com/tiktok-privacy-innovation/PETAce-Duet)        | 0.3.0          | Two-party secure computing protocols |
+| [PETAce-Network](https://github.com/tiktok-privacy-innovation/PETAce-Network)  | 0.3.0          | Network communication protocols      |
 | [Google Logging](https://github.com/google/glog)                               | 0.4.0          | Logging                              |
 | [JSON for Modern C++(JSON)](https://github.com/nlohmann/json)                  | 3.10.1         | PSI parameter configuration          |
 
@@ -57,18 +57,6 @@ Output binaries can be found in `build/lib/` and `build/bin/` directories.
 | `SETOPS_BUILD_TEST`        | ON/OFF        | ON      | Build C++ test if set to ON.                        |
 | `SETOPS_BUILD_DEPS`        | ON/OFF        | ON      | Download and build unmet dependencies if set to ON. |
 
-### Building python
-To build PETAce-Setops python package:
-
-```bash
-cmake -S . -B build -DDUET_BUILD_PYTHON=ON -Dnlohmann_json_DIR=${JSON}/build
-cmake --build build
-cd build
-make wheel
-cd python/wheel
-pip3 install petace_setops-0.2.0-py3-none-any.whl
-```
-
 Here we give a simple example to run protocols in PETAce-SetOps.
 
 To run as Party A (a sender):
@@ -83,13 +71,6 @@ To run as Party B (a receiver):
 bash build/example/scripts/ecdh_psi_receiver_example.sh
 ```
 
-To run python examples, execute the following in commands in separate terminal sessions.
-
-```bash
-python3 ./example/setops_example.py -p 0
-python3 ./example/setops_example.py -p 1
-```
-
 ## Contribution
 
 Please check [Contributing](CONTRIBUTING.md) for more details.
@@ -106,14 +87,14 @@ This project is licensed under the [Apache-2.0 License](LICENSE).
 
 To cite PETAce in academic papers, please use the following BibTeX entries.
 
-### Version 0.2.0
+### Version 0.3.0
 
 ```tex
     @misc{petace,
-        title = {PETAce (release 0.2.0)},
+        title = {PETAce (release 0.3.0)},
         howpublished = {\url{https://github.com/tiktok-privacy-innovation/PETAce}},
-        month = Oct,
-        year = 2023,
+        month = Jun,
+        year = 2024,
         note = {TikTok Pte. Ltd.},
         key = {PETAce}
     }

diff --git a/cmake/PETAce-Duet.cmake b/cmake/PETAce-Duet.cmake
@@ -15,7 +15,7 @@
 FetchContent_Declare(
     duet
     GIT_REPOSITORY https://github.com/tiktok-privacy-innovation/PETAce-Duet.git
-    GIT_TAG        be580aded7b037491d481cb6d03f52cc91d6554d # 0.2.0
+    GIT_TAG        35a121196c6702632d1659402d01290be813220c # 0.3.0
 )
 FetchContent_GetProperties(duet)
 

diff --git a/cmake/PETAce-Network.cmake b/cmake/PETAce-Network.cmake
@@ -15,7 +15,7 @@
 FetchContent_Declare(
     network
     GIT_REPOSITORY https://github.com/tiktok-privacy-innovation/PETAce-Network.git
-    GIT_TAG        92d1a6f079cd11e01bc8e610cb92126ede2964b1 # 0.2.0
+    GIT_TAG        1952a0e0b061c5b43a7fbe5b8d71365abc5382a4 # 0.3.0
 )
 FetchContent_GetProperties(network)
 

diff --git a/cmake/PETAce-Solo.cmake b/cmake/PETAce-Solo.cmake
@@ -15,7 +15,7 @@
 FetchContent_Declare(
     solo
     GIT_REPOSITORY https://github.com/tiktok-privacy-innovation/PETAce-Solo.git
-    GIT_TAG        ead22f615120a0cd9926cfc5d5787fe4bcda379c # 0.2.0
+    GIT_TAG        60c6301802040f622d30c148ab49ad42f5b0e3d2 # 0.3.0
 )
 FetchContent_GetProperties(solo)
 
@@ -26,7 +26,7 @@ if(NOT solo_POPULATED)
     set(SOLO_BUILD_TEST OFF CACHE BOOL "" FORCE)
     set(SOLO_BUILD_BENCH OFF CACHE BOOL "" FORCE)
     set(SOLO_BUILD_EXAMPLE OFF CACHE BOOL "" FORCE)
-    set(SOLO_USE_IPCL ON CACHE BOOL "" FORCE)
+    set(SOLO_USE_IPCL OFF CACHE BOOL "" FORCE)
 
     mark_as_advanced(FETCHCONTENT_SOURCE_DIR_SOLO)
     mark_as_advanced(FETCHCONTENT_UPDATES_DISCONNECTED_SOLO)

diff --git a/cmake/PETAce-Verse.cmake b/cmake/PETAce-Verse.cmake
@@ -15,7 +15,7 @@
 FetchContent_Declare(
     verse
     GIT_REPOSITORY https://github.com/tiktok-privacy-innovation/PETAce-Verse.git
-    GIT_TAG        f79ede7af704293de32aa44be8c967e1d0eaa3dc # 0.2.0
+    GIT_TAG        34ffb78e122805f5358cb77ae0ce2bb6f6241060 # 0.3.0
 )
 FetchContent_GetProperties(verse)
 
@@ -25,6 +25,7 @@ if(NOT verse_POPULATED)
     set(VERSE_BUILD_SHARED_LIBS ${SETOPS_BUILD_SHARED_LIBS} CACHE BOOL "" FORCE)
     set(VERSE_BUILD_TEST OFF CACHE BOOL "" FORCE)
     set(VERSE_BUILD_EXAMPLE OFF CACHE BOOL "" FORCE)
+    set(VERSE_BUILD_BENCH OFF CACHE BOOL "" FORCE)
 
     mark_as_advanced(FETCHCONTENT_SOURCE_DIR_VERSE)
     mark_as_advanced(FETCHCONTENT_UPDATES_DISCONNECTED_VERSE)

diff --git a/example/CMakeLists.txt b/example/CMakeLists.txt
@@ -14,14 +14,14 @@
 
 cmake_minimum_required(VERSION 3.14)
 
-project(SETOPSExamples VERSION 0.2.0 LANGUAGES CXX)
+project(SETOPSExamples VERSION 0.3.0 LANGUAGES CXX)
 
 # If not called from root CMakeLists.txt
 if(NOT DEFINED SETOPS_BUILD_EXAMPLE)
     set(SETOPS_BUILD_EXAMPLE ON)
 
     # Import PETAce SETOPS
-    find_package(PETAce-SetOps  0.2.0 EXACT REQUIRED)
+    find_package(PETAce-SetOps  0.3.0 EXACT REQUIRED)
 
     add_compile_options(-msse4.2 -Wno-ignored-attributes -mavx)
 

diff --git a/example/setops_example.py b/example/setops_example.py
diff --git a/python/CMakeLists.txt b/python/CMakeLists.txt