pqAuth 项目使用教程

1、项目的目录结构及介绍

pqauth/
├── LICENSE
├── README.md
├── pqauth/
│   ├── __init__.py
│   ├── client.py
│   ├── crypto.py
│   └── server.py
└── setup.py

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• pqauth/: 项目主目录，包含核心代码文件。
  • __init__.py: 初始化文件。
  • client.py: 客户端认证相关代码。
  • crypto.py: 加密相关代码。
  • server.py: 服务器端认证相关代码。
• setup.py: 项目安装脚本。

2、项目的启动文件介绍

项目的启动文件主要是 pqauth/client.py 和 pqauth/server.py。

• client.py: 包含客户端认证的主要逻辑，负责与服务器进行认证交互。
• server.py: 包含服务器端认证的主要逻辑，负责处理客户端的认证请求。

3、项目的配置文件介绍

项目没有明确的配置文件，但可以通过代码中的参数进行配置。例如，在 client.py 中，可以通过以下方式加载密钥和设置认证端点：

from pqauth import crypto
from pqauth.client import ClientAuthenticator

# 加载RSA密钥，可选地解密它们（如果它们是加密的）
client_key = crypto.load_key_file("/path/to/id_rsa", password="bosco")
server_public_key = crypto.load_key_file("/path/to/server/id_rsa.pub")

# pqAuth端点在API服务器上
server_hello_url = "https://api.example.com/pqauth/hello"
server_confirm_url = "https://api.example.com/pqauth/confirm"

authenticator = ClientAuthenticator(client_key, server_public_key, server_hello_url, server_confirm_url)

# 用于进一步请求的认证令牌字符串
# 服务器知道相同的session_key
session_key = authenticator.authenticate()

以上代码展示了如何配置客户端的密钥和认证端点。服务器端的配置类似，需要根据实际情况进行调整。