Problem Building/Using Library

[chgorman]

I've installed APSI using vcpgk by running

./vcpkg install apsi

I'm still unable to use APSI, though. How am I supposed to use this library to perform private set intersection?

[franciscobecerra97]

Compile the APSI Microsoft library with CMake and vcpkg

This guide provides a step-by-step process for compiling the C++ APSI library from Microsoft APSI using CMake and vcpkg.

Prerequisites

Ensure you have the following installed:

• Git
• A C++ compiler (MSVC, Clang, or GCC)

Note: If you have no knowledge of c++ projects using cmaker and vcpkg, I recommend you to watch some tutorials on how to compile and run a project using these technologies.

Step 1: Install vcpkg and CMake

1. Install vcpkg

If you haven't already, clone the vcpkg repository and bootstrap it:

git clone https://github.com/microsoft/vcpkg.git
cd vcpkg
.\bootstrap-vcpkg.bat  # On Windows

Note: It is advisable to clone the project into C:/vcpkg as most tutorials assume this location. If you use a different path, ensure you update it accordingly.

After running the bootstrap script, a vcpkg.exe file will be generated, which will be referenced in the following steps.

2. Make vcpkg available for Visual Studio Code and compilation

Run:

vcpkg integrate install

This will produce output similar to:

Applied user-wide integration for this vcpkg root.
CMake projects should use: "-DCMAKE_TOOLCHAIN_FILE=/Users/franciscobecerra/Library/vcpkg/scripts/buildsystems/vcpkg.cmake"

Note: The path will contain your system's username. Copy the CMAKE_TOOLCHAIN_FILE value, as it will be needed in the following steps.

3. Install CMake

Ensure CMake is installed and available in your system's PATH. If not, download and install it from cmake.org.

Step 2: Install APSI Dependencies using vcpkg

Navigate to your vcpkg directory and install the required dependencies:

.\vcpkg.exe install seal[no-throw-tran]:x64-windows-static-md
.\vcpkg.exe install kuku:x64-windows-static-md
.\vcpkg.exe install log4cplus:x64-windows-static-md
.\vcpkg.exe install cppzmq:x64-windows-static-md
.\vcpkg.exe install flatbuffers:x64-windows-static-md
.\vcpkg.exe install jsoncpp:x64-windows-static-md
.\vcpkg.exe install gtest:x64-windows-static-md
.\vcpkg.exe install tclap:x64-windows-static-md
.\vcpkg.exe install apsi:x64-windows-static-md

Step 3: Build the Project

1. Create a build directory

mkdir build
cd build

2. Configure the project using CMake

Run one of the following commands, depending on what you want to compile:

Option 1: Compile only the library

cmake -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static-md ..

Option 2: Compile the library and CLI

cmake -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static-md -DAPSI_BUILD_CLI=ON ..

Option 3: Compile the library, CLI, and tests

cmake -DCMAKE_TOOLCHAIN_FILE=C:/vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static-md -DAPSI_BUILD_CLI=ON -DAPSI_BUILD_TESTS=ON ..

3. Build the project

cmake --build .

Step 4: Run the Executable

After building, you will find:

• The library in: ./APSI/build/lib/Debug
• The sender and receiver executables in: ./APSI/build/bin/Debug

Notes

• If you need additional dependencies, update vcpkg.json, re-run vcpkg install, and rebuild the project.

[cyberhorse208]

i followed @franciscobecerra97 's directions on linux but failed:

1. use vcpkg install all Dependencies: vcpkg install apsi

Computing installation plan...
A suitable version of cmake was not found (required v3.30.1).
Downloading https://github.com/Kitware/CMake/releases/download/v3.30.1/cmake-3.30.1-linux-x86_64.tar.gz -> cmake-3.30.1-linux-x86_64.tar.gz
Successfully downloaded cmake-3.30.1-linux-x86_64.tar.gz
Extracting cmake...
The following packages will be built and installed:
apsi[core,log4cplus,zeromq]:x64-linux@0.11.0

• cppzmq:x64-linux@4.11.0
• flatbuffers:x64-linux@25.2.10
• jsoncpp:x64-linux@1.9.6
• kuku:x64-linux@2.1.0
• log4cplus:x64-linux@2.1.1
• ms-gsl:x64-linux@4.2.0
• seal[core,ms-gsl,no-throw-tran,zlib,zstd]:x64-linux@4.1.2
• vcpkg-cmake:x64-linux@2024-04-23
• vcpkg-cmake-config:x64-linux@2024-05-23
• zeromq:x64-linux@4.3.5#2
• zlib:x64-linux@1.3.1
• zstd:x64-linux@1.5.7
  ......
  Completed submission of seal[core,ms-gsl,no-throw-tran,zlib,zstd]:x64-linux@4.1.2 to 1 binary cache(s) in 965 ms
  Waiting for 1 remaining binary cache submissions...
  Completed submission of apsi[core,log4cplus,zeromq]:x64-linux@0.11.0 to 1 binary cache(s) in 1.5 s (1/1)
  All requested installations completed successfully in: 2.7 min

2. ./vcpkg integrate install
   CMake projects should use: "-DCMAKE_TOOLCHAIN_FILE=/home/xxx/workspace/vcpkg/scripts/buildsystems/vcpkg.cmake"

3. try to cmake
   cd apsi
   mkdir build
   cd build
   cmake -DCMAKE_TOOLCHAIN_FILE=/home/xxx/workspace/vcpkg/scripts/buildsystems/vcpkg.cmake -DAPSI_BUILD_CLI=ON -DAPSI_BUILD_TESTS=ON ..

-- Build type (CMAKE_BUILD_TYPE): Release
-- APSI debug mode: OFF
-- APSI_USE_CXX17: ON
-- Microsoft SEAL: found
CMake Error at CMakeLists.txt:136 (find_package):
By not providing "FindKuku.cmake" in CMAKE_MODULE_PATH this project has
asked CMake to find a package configuration file provided by "Kuku", but
CMake did not find one.

Could not find a package configuration file provided by "Kuku" (requested
version 2.1) with any of the following names:

KukuConfig.cmake
kuku-config.cmake

Add the installation prefix of "Kuku" to CMAKE_PREFIX_PATH or set
"Kuku_DIR" to a directory containing one of the above files. If "Kuku"
provides a separate development package or SDK, be sure it has been
installed.

-- Configuring incomplete, errors occurred!
See also "/home/xxx/workspace/APSI/CMakeFiles/CMakeOutput.log".

how can i fix this?