XCA - X证书与密钥管理工具技术文档

1. 安装指南

1.1 依赖项

在构建XCA之前，您需要安装以下依赖项：

• 工具链
• CMake: https://cmake.org
• Qt5 或 Qt6: https://www.qt.io
• OpenSSL: https://www.openssl.org (1.1.1 或更高版本) 或 libressl-3.6.x
• Sphinx-Build: https://www.sphinx-doc.org

1.2 Linux / Unix 安装步骤

1. 安装依赖项：

   sudo apt install build-essential libssl-dev pkg-config cmake qttools5-dev python3-sphinxcontrib.qthelp
   

2. 克隆代码库：

   git clone https://github.com/chris2511/xca.git
   

3. 配置项目：

   cmake -B build xca
   

4. 编译项目：

   cmake --build build -j5
   

5. 安装项目：

   sudo cmake --install build
   

1.3 Apple macOS 安装步骤

1. 安装依赖项：

   xcode-select --install
   brew install openssl@3 qt6 python3 cmake
   pip3 install sphinx
   

2. 克隆代码库：

   git clone https://github.com/chris2511/xca.git
   

3. 配置项目：

   cmake -B build xca
   

4. 编译项目：

   cmake --build build -j5
   

5. 构建DMG包：

   cd build && cpack
   

1.4 Windows 安装步骤

1. 安装依赖项：
   • 安装Python：从商店或 https://www.python.org/downloads/windows/
   • 安装OpenSSL：从 https://slproweb.com/download/Win64OpenSSL-3_1_5.msi 下载并验证sha256
   • 安装Qt、CMake和MinGW工具链：

     pip3 install sphinx aqtinstall
     aqt install-qt windows desktop 6.6.3 win64_mingw
     aqt install-tool windows desktop tools_mingw90 qt.tools.win64_mingw900
     aqt install-tool windows desktop tools_vcredist qt.tools.vcredist_64
     

2. 克隆代码库：

   git clone https://github.com/chris2511/xca.git
   

3. 配置项目：

   cmake -B build -G "MinGW Makefiles" xca
   

4. 编译项目：

   cmake --build build -j5
   

5. 创建便携应用：

   cmake --build build -t install
   

2. 项目使用说明

XCA是一个用于管理证书和密钥的工具。它支持多种数据库类型，包括SQLite、MySQL、PostgreSQL等。用户可以通过图形界面或命令行来管理证书、密钥和CSR（证书签名请求）。

2.1 启动XCA

在安装完成后，您可以通过命令行或桌面快捷方式启动XCA。启动后，您将看到一个图形界面，允许您创建、导入和管理证书和密钥。

2.2 创建新数据库

首次启动时，您需要创建一个新的数据库。点击“文件”菜单中的“新建数据库”选项，选择数据库类型并设置密码。

2.3 导入证书和密钥

您可以通过“文件”菜单中的“导入”选项导入现有的证书和密钥。支持的格式包括PEM、DER和PKCS#12。

2.4 生成CSR

在“证书”菜单中，选择“生成CSR”选项，填写必要的信息并生成CSR。生成的CSR可以用于向CA申请证书。

3. 项目API使用文档

XCA提供了一些API接口，允许开发者通过编程方式管理证书和密钥。以下是一些常用的API接口：

3.1 创建新数据库

from xca import XcaDatabase

db = XcaDatabase('my_database.db', password='my_password')
db.create()

3.2 导入证书

db.import_certificate('certificate.pem')

3.3 生成CSR

csr = db.generate_csr(common_name='example.com', organization='Example Inc.')
print(csr)

4. 项目安装方式

XCA可以通过源码编译安装，也可以通过预编译的二进制包进行安装。以下是两种安装方式的简要说明：

4.1 源码编译安装

按照上述“安装指南”中的步骤，通过克隆代码库并编译安装。

4.2 预编译二进制包安装

对于Windows和macOS用户，可以从项目的GitHub发布页面下载预编译的二进制包进行安装。