Python OATH 技术文档

1. 安装指南

首先，确保您的环境已经安装了Python 3。接着，可以使用pip包管理工具进行安装：

pip install oath

确保您的pip版本是最新的，以避免安装过程中遇到不必要的兼容性问题。

2. 项目的使用说明

python-oath 包实现了三个主要的OATH规范：

• HOTP（基于事件的一次性密码标准，使用HMAC签名）
• TOTP（基于时间的一次性密码）
• OCRA（结合OTP和签名的系统，基于HOTP，适用于复杂的场景）

以下是主要API的简要说明：

• hotp：生成一次性密码。
• accept_hotp：验证接收到的密码。
• totp 和 accept_totp：分别用于生成和验证TOTP标准的一次性密码。
• GoogleAuthenticator：解析Google Authenticator URI。
• from_b32key：从简单的base32密钥创建GoogleAuthenticator对象。

3. 项目API使用文档

以下是具体API的使用方法：

HOTP

生成一次性密码：

import oath

# 创建HOTP对象
hotp = oath.hotp("your-secret-key", digits=6)

# 生成密码
password = hotp.generate()

验证接收到的密码：

# 验证密码
is_valid = hotp.accept(password)

TOTP

生成TOTP密码：

# 创建TOTP对象
totp = oath.totp("your-secret-key", digits=6, interval=30)

# 生成密码
password = totp.generate()

验证TOTP密码：

# 验证密码
is_valid = totp.accept(password)

Google Authenticator

从Google Authenticator URI创建对象：

# 解析URI
ga = oath.GoogleAuthenticator.from_uri("otpauth://totp/Example:[e-mail]?secret=JBSWY3DPEHPK3PXP&issuer=Example")

# 生成密码
password = ga.generate_password()

从base32密钥创建对象：

# 从base32密钥创建
ga = oath.from_b32key("JBSWY3DPEHPK3PXP")

# 生成密码
password = ga.generate_password()

4. 项目安装方式

项目的安装方式已在“安装指南”一节中详细说明，这里再次总结如下：

使用pip进行安装：

pip install oath

请确保遵循以上步骤，以顺利安装并使用python-oath包。