Python-bna 项目技术文档

1. 安装指南

系统要求

• Python 3.6 或更高版本

安装步骤

首先，确保您的系统中已经安装了 Python 3.6 或更高版本。然后通过以下命令安装 python-bna：

pip install python-bna

2. 项目使用说明

命令行使用

bna 是一个命令行界面，用于管理 python-bna 库。它可以存储和管理多个认证器，还可以创建新的认证器。

• 注意：在与登录设备相同的设备上使用认证器比将设备分开使用安全性低。请自行承担风险。

配置信息存储在 ~/.config/bna/bna.conf。您可以通过 bna --config=~/.bna.conf 等方式指定不同的配置路径。

创建新的认证器

$ bna new

如果没有现有的认证器，它将被设置为默认认证器。您也可以使用 --set-default 参数。

获取认证令牌

$ bna
01234567
$ bna EU-1234-1234-1234
76543210

获取认证器的恢复码

$ bna show-restore-code
Z45Q9CVXRR
$ bna restore EU-1234-1234-1234 ABCDE98765
Restored EU-1234-1234-1234

获取 OTPAuth URL

要显示 OTPAuth URL（用于设置 QR 码），使用以下命令：

$ bna show-url
otpauth://totp/Blizzard:EU123412341234:?secret=ASFAS75ASDF75889G9AD7S69AS7697AS&issuer=Blizzard&digits=8

然后将此 URL 粘贴到您的 OTP 应用程序中，或转换为 QR 码并扫描，或手动输入密钥。

此 URL 与标准 TOTP 客户端和密码管理器兼容，例如：

• andOTP (Android)
• KeepassXC (跨平台)
• 1Password (跨平台)

获取 QR 码

要在本地系统上生成 QR 码，请安装 qrencode。

保存为磁盘上的 PNG 文件：

$ bna show-url | qrencode -o ~/BNA-qrcode.png
# 扫描 QR 码
$ rm ~/BNA-qrcode.png

或者在终端尝试以文本形式显示 QR 码：

$ bna --otpauth-url | qrencode -t ANSI

3. 项目API使用文档

以下示例展示了如何使用 python-bna 库中的 API。

请求新的认证器

import bna
try:
    # 区域是 EU 或 US
    # 注意 EU 的认证器在美国有效，反之亦然
    serial, secret = bna.request_new_serial("US")
except bna.HTTPError as e:
    print("无法连接：", e)

获取令牌

    # 使用 PyOTP 获取并打印令牌
    from pyotp import TOTP
    totp = TOTP(secret, digits=8)
    print(totp.now())

4. 项目安装方式

如上所述，您可以通过 pip install python-bna 命令安装本项目。确保遵循系统要求和安装步骤以确保项目的顺利运行。