Apache Pirk 项目技术文档

1. 安装指南

环境要求

• Java 8 或更高版本
• Maven 3.x
• 依赖项：Apache Hadoop、Apache Spark、Apache Storm、Elasticsearch

安装步骤

1. 克隆项目仓库：

   git clone https://github.com/apache/incubator-pirk.git
   cd incubator-pirk
   

2. 构建项目：

   • 使用默认的 pom.xml 文件构建项目：

     mvn package
     

   • 如果需要运行 Paillier 基准测试，可以使用 pom-with-benchmarks.xml 文件：

     mvn package -f pom-with-benchmarks.xml
     

3. 检查构建结果：

   • 构建成功后，生成的 JAR 文件将位于 target 目录下。

2. 项目的使用说明

基本概念

Apache Pirk 是一个用于可扩展私有信息检索（PIR）的框架。PIR 允许用户在不泄露查询内容的情况下，从数据集中检索信息。Pirk 使用同态加密技术，使得数据集可以在其原生位置进行查询，而无需移动数据。

主要角色

• Querier（查询者）：负责生成加密的查询向量、解密查询结果。
• Responder（响应者）：负责在目标数据集上执行加密查询，并生成加密的查询结果。

使用流程

1. Querier 生成加密的查询向量，并将其发送给 Responder。
2. Responder 使用加密的查询向量在数据集上执行查询，并将加密的查询结果发送回 Querier。
3. Querier 解密查询结果，获取所需信息。

3. 项目API使用文档

数据和查询模式

Pirk 使用 XML 文件定义数据和查询模式，这些模式在 Querier 和 Responder 之间共享，以支持灵活和多样的数据和查询类型。

API 示例

• 生成加密查询向量：

  QueryVector queryVector = new QueryVector(querySchema);
  queryVector.generateEncryptedQuery();
  

• 执行加密查询：

  EncryptedQueryResult result = responder.performEncryptedQuery(queryVector);
  

• 解密查询结果：

  DecryptedResult decryptedResult = querier.decryptQueryResult(result);
  

4. 项目安装方式

通过 Maven 安装

1. 在项目的 pom.xml 文件中添加 Pirk 依赖：

   <dependency>
       <groupId>org.apache.pirk</groupId>
       <artifactId>pirk-core</artifactId>
       <version>1.0.0</version>
   </dependency>
   

2. 使用 Maven 构建项目：

   mvn clean install
   

通过源码安装

1. 克隆项目仓库并进入项目目录：

   git clone https://github.com/apache/incubator-pirk.git
   cd incubator-pirk
   

2. 使用 Maven 构建项目：

   mvn package
   

3. 构建成功后，生成的 JAR 文件将位于 target 目录下，可以直接使用。

总结

Apache Pirk 是一个强大的 PIR 框架，适用于需要在分布式环境中进行私有信息检索的场景。通过本文档，您可以了解如何安装、使用 Pirk，并掌握其 API 的基本用法。