Apache Teaclave Java TEE SDK 使用指南

Apache Teaclave Java TEE SDK 是一个用于隐私敏感数据安全计算的开放源代码通用框架，它简化了在Java中处理保密计算任务的方式。本指南将带您了解如何开始使用这个框架，聚焦于项目的目录结构、启动文件以及配置文件。

1. 项目目录结构及介绍

Apache Teaclave Java TEE SDK 的典型目录结构展示了其模块化的组织方式，以下是一个简化的结构概览：

apache-teaclave-java-tee-sdk/
│
├── README.md         # 项目的主要说明文档，包括快速入门与关键概念。
├── NOTICE             # 许可相关的注意事项。
├── build.sh          # 构建脚本，用于编译和准备项目。
├── pom.xml            # Maven项目的构建配置文件。
│
├── host               # 主机（Host）模块，包含与外界交互的逻辑。
│   └── src/main/java  # 主机端Java代码。
│
├── enclave            # 隐蔽环境（Enclave）模块，定义服务接口并实现安全计算逻辑。
│   └── src/main/java  # 隐蔽环境中运行的Java代码，通过JNI与主机通信。
│
├── common             # 共享模块，定义服务接口和其他共用类库。
│   └── src/main/java  # 包含接口定义和用于两者间通信的基础类型。
│
├── docker             # 提供的Docker相关文件，用于构建和运行环境。
│
└── etc                # 可选，可能包含示例配置文件或环境设置。

2. 项目的启动文件介绍

在 Teaclave Java TEE SDK 中，并没有一个单一明确标记为“启动文件”的文件，而是依赖于Maven来管理构建和执行流程。启动项目通常通过Maven命令完成，比如：

• 主程序启动：如果你是在开发主机应用程序，通常会从host模块的主类开始，使用Maven命令启动，例如 mvn clean compile exec:java -Dexec.mainClass="com.example.TeaclaveApp"。
• 构建隐蔽环境：则需先构建Java Native Image，这可能涉及到特定的Maven插件和命令，具体步骤会在项目的文档或README.md中详细说明。

3. 项目的配置文件介绍

尽管项目核心部分更多依赖代码中的配置和Maven属性，但配置细节可能会分散在多个地方，如：

• Maven的pom.xml：是最主要的配置文件，包含了依赖关系、构建阶段、插件配置等。
• 应用级别的配置：特定的应用可能需要创建自己的配置文件，这些文件通常位于项目的根目录下或特定子模块中，比如config.properties或者.yaml文件，但该SDK本身并未强制要求有一个固定的全局配置文件。配置内容可能是连接到Teaclave服务的参数、密钥管理设置等。
• Dockerfile与docker-compose.yml：如果使用Docker进行部署，那么这些文件将是容器化配置的关键。

确保仔细阅读项目的README.md文件，因为那里会有详细的指令来引导你通过配置过程，特别是在初始化项目、环境搭建和构建隐蔽环境时。每个项目的实际配置需求可能会有所不同，因此具体配置文件的名称和位置应以官方文档或README.md为准。