Package org.miaixz.bus.crypto.center

Class TOTP

java.lang.Object
org.miaixz.bus.crypto.center.HOTP
org.miaixz.bus.crypto.center.TOTP
public class TOTP extends HOTP
time-based one-time passwords (TOTP) 基于时间戳算法的一次性密码生成器

规范见：RFC 6238

时间同步，基于客户端的动态口令和动态口令验证服务器的时间比对，一般每30秒产生一个新口令， 要求客户端和服务器能够十分精确的保持正确的时钟，客户端和服务端基于时间计算的动态口令才能一致。

参考：https://github.com/jchambers/java-otp

OTP基于具有时间戳计数器的OTP。 通过定义纪元（T0）的开始并以时间间隔（TI）为单位计数，将当前时间戳变为整数时间计数器（TC）。 例如： TC = floor, TOTP = HOTP（SecretKey，TC）， TOTP-Value = TOTP mod 10d，其中d是一次性密码的所需位数。 像google auth的二步认证使用了这种方式。

认证过程 生成二维码,带有otpauth链接的google地址 生成公用密钥 返回给app，同时用户户和服务名也会返回,这时密钥是被base32加密过的,app存储,以后用这个密钥来生成6位校验码 服务端同时存储这个密钥和用户名，你可以把用户名当key，把密钥当value进行存储 app每30秒生成一个6位校验码,用户使用这个码来网站进行登陆 服务器使用存储的密钥+fmac算法生成6位随机数,与客户端传来的数进行对比 两个码相等,授权成功,反之,失败.（注意，服务端可以根据当前登陆的用户名拿到它的密钥，有了密钥，再进行totp的算法生成校验码）

登陆的过程整理 用户和密码先登陆 session里存储了用户名等信息 产生二维码及密钥，密钥存储到服务器的k/v介质里，k使用session里的用户名，v使用刚才的密钥 客户使用app扫二维码，产生新的6位数字 客户在用户名和密码登陆后，进行验证码页面，输入刚才的6位数字 提交到服务端，服务端根据用户名取出对应的密钥，然后使用totp算法生成6位数字 如果服务端与客户端数字相同，表示登陆成功！

Since:
Java 17+
Author:
Kimi Liu

  • Constructor Details

    • TOTP

      public TOTP(byte[] key)
      构造，使用默认HMAC算法(HmacSHA1)
      Parameters:
      key - 共享密码，RFC 4226要求最少128位

    • TOTP

      public TOTP(Duration timeStep, byte[] key)
      构造，使用默认HMAC算法(HmacSHA1)
      Parameters:
      timeStep - 日期步进 用于生成移动因子（moving factor）,默认步进 (30秒)
      key - 共享密码，RFC 4226要求最少128位

    • TOTP

      public TOTP(Duration timeStep, int passwordLength, byte[] key)
      构造，使用默认HMAC算法(HmacSHA1)
      Parameters:
      timeStep - 日期步进，用于生成移动因子（moving factor）
      passwordLength - 密码长度，可以是6,7,8
      key - 共享密码，RFC 4226要求最少128位

    • TOTP

      public TOTP(Duration timeStep, int passwordLength, org.miaixz.bus.core.lang.Algorithm algorithm, byte[] key)
      构造
      Parameters:
      timeStep - 日期步进，用于生成移动因子（moving factor）
      passwordLength - 密码长度，可以是6,7,8
      algorithm - HMAC算法枚举
      key - 共享密码，RFC 4226要求最少128位

  • Method Details

    • generateGoogleSecretKey

      public static String generateGoogleSecretKey(String account, int numBytes)
      生成谷歌认证器的字符串（扫码字符串） 基于时间的，计数器不适合
      Parameters:
      account - 账户名。
      numBytes - 将生成的种子字节数量。
      Returns:
      共享密钥

    • generate

      public int generate(Instant timestamp)
      使用给定的时间戳生成一次性密码.
      Parameters:
      timestamp - 用于生成密码的时间戳
      Returns:
      一次性密码的int形式

    • validate

      public boolean validate(Instant timestamp, int offsetSize, int code)
      用于验证code是否正确
      Parameters:
      timestamp - 验证时间戳
      offsetSize - 误差范围
      code - code
      Returns:
      是否通过

    • getTimeStep

      public Duration getTimeStep()
      获取步进
      Returns:
      步进