ABY 项目使用教程

1. 项目目录结构及介绍

ABY 项目的目录结构如下：

ABY/
├── bin/
│   └── circ/
├── cmake/
├── extern/
├── src/
│   ├── abycore/
│   ├── examples/
│   └── test/
├── .gitignore
├── .gitmodules
├── .travis.yml
├── CMakeLists.txt
├── Doxyfile
├── LICENSE
├── README.md
└── runtest_scr.sh

目录结构介绍

• bin/: 存放编译后的可执行文件和电路文件。

  • circ/: 存放电路文件。

• cmake/: 包含 CMake 的辅助文件。

• extern/: 存放外部依赖库的 Git 子模块。

• src/: 项目的源代码目录。

  • abycore/: ABY 核心功能的源代码。
  • examples/: 示例应用程序的源代码。
  • test/: 测试应用程序的源代码。

• .gitignore: Git 忽略文件列表。

• .gitmodules: Git 子模块配置文件。

• .travis.yml: Travis CI 配置文件。

• CMakeLists.txt: CMake 构建配置文件。

• Doxyfile: Doxygen 文档生成配置文件。

• LICENSE: 项目许可证文件。

• README.md: 项目介绍和使用说明。

• runtest_scr.sh: 测试脚本。

2. 项目启动文件介绍

ABY 项目的启动文件通常位于 src/examples/ 目录下。每个示例应用程序都有一个对应的启动文件，例如 millionaire_prob_test.cpp。

示例启动文件

以 millionaire_prob_test.cpp 为例：

// src/examples/millionaire_prob_test.cpp

#include <abycore/aby/ABYParty.h>
#include <abycore/circuit/booleancircuits.h>
#include <abycore/circuit/arithmeticcircuits.h>
#include <abycore/circuit/circuit.h>
#include <abycore/sharing/sharing.h>

int main(int argc, char** argv) {
    // 初始化 ABY 派对
    ABYParty party(argc, argv);

    // 创建电路
    share* s_alice = party.PutINGate(alice_input, bitlen, SERVER);
    share* s_bob = party.PutINGate(bob_input, bitlen, CLIENT);

    // 执行电路
    party.ExecCircuit();

    // 获取结果
    uint32_t result = s_alice->get_clear_value<uint32_t>();

    // 输出结果
    std::cout << "Result: " << result << std::endl;

    return 0;
}

启动步骤

1. 编译项目: 使用 CMake 配置并编译项目。
2. 运行示例: 在终端中运行编译后的可执行文件，例如 ./millionaire_prob_test -r 0。

3. 项目配置文件介绍

ABY 项目的配置文件主要包括 CMakeLists.txt 和 Doxyfile。

CMakeLists.txt

CMakeLists.txt 是 CMake 构建系统的配置文件，定义了项目的构建规则和依赖关系。

# CMakeLists.txt

cmake_minimum_required(VERSION 3.0)
project(ABY)

# 设置编译器选项
set(CMAKE_CXX_STANDARD 17)

# 添加源文件目录
add_subdirectory(src)

# 添加外部依赖
add_subdirectory(extern)

# 生成可执行文件
add_executable(millionaire_prob_test src/examples/millionaire_prob_test.cpp)

# 链接库
target_link_libraries(millionaire_prob_test abycore)

Doxyfile

Doxyfile 是 Doxygen 文档生成工具的配置文件，用于生成项目的 API 文档。

# Doxyfile

PROJECT_NAME           = "ABY"
OUTPUT_DIRECTORY       = docs
INPUT                  = src
RECURSIVE              = YES
GENERATE_LATEX         = NO
GENERATE_HTML          = YES

配置步骤

1. CMake 配置: 在项目根目录下运行 cmake . 进行配置。
2. 编译项目: 运行 make 编译项目。
3. 生成文档: 运行 doxygen Doxyfile 生成 API 文档。

通过以上步骤，您可以成功配置、编译和运行 ABY 项目，并生成项目的 API 文档。