OneTimePass 技术文档

1. 安装指南

OneTimePass（以下简称 OTP）可以通过 pip 安装或者单独下载。使用 pip 安装是最简单的方式。如果您想全局安装，可以使用以下命令：

$ sudo pip install onetimepass

如果您正在虚拟环境中安装，您不需要 sudo 部分。

另外，您也可以通过上面提供的下载链接下载并解压到您的 sys.path 中的某个目录，或者将其作为 Git 子模块克隆到您的目录中。

2. 项目使用说明

OTP 模块可以用来生成一次性密码，具体包括基于HMAC的一次性密码（HOTP）和基于时间的一次性密码（TOTP）。它们可以用于如 Android 或 iPhone 上的 Google 认证器应用程序。

以下是使用 OTP 模块的方法：

1. 安装模块（将其下载到应用程序的目录或模块目录中）

2. 获取基于时间的一次性令牌的方式如下：

   import onetimepass as otp
   my_secret = 'MFRGGZDFMZTWQ2LK'
   my_token = otp.get_totp(my_secret)
   

   注意：my_secret 不区分大小写，同时会忽略空格。这意味着您可以提供给用户更易读的秘密表示（例如，使用 mfrg gzdf mztw q2lk 而不是 MFRGGZDFMZTWQ2LK），并将其不变地传递给库。对于库中接受秘密的其他函数也是如此。

3. 获取基于HMAC的一次性令牌的方式如下：

   import onetimepass as otp
   my_secret = 'MFRGGZDFMZTWQ2LK'
   my_token = otp.get_hotp(my_secret, intervals_no=3)
   

   其中，intervals_no 是当前尝试的编号（如果服务器上检查，则必须检查几个值，这些值高于上一个成功认证的最后一个成功值）。

4. 检查基于时间的一次性令牌的方式如下：

   import onetimepass as otp
   my_secret = 'MFRGGZDFMZTWQ2LK'
   my_token = 123456 # 应该是从用户的输入中获取
   is_valid = otp.valid_totp(token=my_token, secret=my_secret)
   

5. 检查基于HMAC的一次性令牌的方式如下：

   import onetimepass as otp
   my_secret = 'MFRGGZDFMZTWQ2LK'
   my_token = 123456 # 应该是从用户的输入中获取
   last_used = 5 # 在别处存储最后有效的间隔
   is_valid = otp.valid_hotp(token=my_token, secret=my_secret, last=last_used)
   

   其中：

   • last 参数（在此情况下分配给 last_used）是上次成功检查的间隔编号（因为 valid_totp() 会跳过它并从下一个间隔编号开始检查）
   • 如果 my_token 没有被识别为给定秘密（my_secret）和检查间隔范围内的有效OTP，is_valid 被赋值为 False。如果成功，is_valid 被赋予有效间隔编号的值（它应该被保存到数据库中，并在下次检查密码时作为 last 参数供应，这样您就不能再次使用相同的令牌）。

3. 项目API使用文档

OTP 模块提供了以下几个主要的API接口：

• get_totp(secret, digits=6, interval=30, algorithm='sha1'): 生成基于时间的一次性密码。
• get_hotp(secret, intervals_no, digits=6, algorithm='sha1'): 生成基于HMAC的一次性密码。
• valid_totp(token, secret, last, digits=6, interval=30, algorithm='sha1'): 验证基于时间的一次性密码。
• valid_hotp(token, secret, last, digits=6, algorithm='sha1'): 验证基于HMAC的一次性密码。

4. 项目安装方式

项目可以通过以下几种方式安装：

• 通过 pip 命令：

  $ pip install onetimepass
  

• 下载源码包并解压，然后运行以下命令安装：

  $ python setup.py install
  

• 将项目作为 Git 子模块克隆到本地，然后安装：

  $ git clone https://github.com/tadeck/onetimepass.git
  $ cd onetimepass
  $ python setup.py install