cn.hutool.crypto.digest.otp.TOTP Maven / Gradle / Ivy
package cn.hutool.crypto.digest.otp;
import cn.hutool.core.util.StrUtil;
import cn.hutool.crypto.digest.HmacAlgorithm;
import java.time.Duration;
import java.time.Instant;
/**
* time-based one-time passwords (TOTP) 基于时间戳算法的一次性密码生成器，
* 规范见：RFC 6238.
*
* 时间同步，基于客户端的动态口令和动态口令验证服务器的时间比对，一般每30秒产生一个新口令，
* 要求客户端和服务器能够十分精确的保持正确的时钟，客户端和服务端基于时间计算的动态口令才能一致。
*
* 参考：https://github.com/jchambers/java-otp
*
* @author Looly
*/
public class TOTP extends HOTP {
/**
* 默认步进 (30秒).
*/
public static final Duration DEFAULT_TIME_STEP = Duration.ofSeconds(30);
private final Duration timeStep;
/**
* 构造，使用默认HMAC算法(HmacSHA1)
*
* @param key 共享密码，RFC 4226要求最少128位
*/
public TOTP(byte[] key) {
this(DEFAULT_TIME_STEP, key);
}
/**
* 构造，使用默认HMAC算法(HmacSHA1)
*
* @param timeStep 日期步进，用于生成移动因子（moving factor）
* @param key 共享密码，RFC 4226要求最少128位
*/
public TOTP(Duration timeStep, byte[] key) {
this(timeStep, DEFAULT_PASSWORD_LENGTH, key);
}
/**
* 构造，使用默认HMAC算法(HmacSHA1)
*
* @param timeStep 日期步进，用于生成移动因子（moving factor）
* @param passwordLength 密码长度，可以是6,7,8
* @param key 共享密码，RFC 4226要求最少128位
*/
public TOTP(Duration timeStep, int passwordLength, byte[] key) {
this(timeStep, passwordLength, HOTP_HMAC_ALGORITHM, key);
}
/**
* 构造
*
* @param timeStep 日期步进，用于生成移动因子（moving factor）
* @param passwordLength 密码长度，可以是6,7,8
* @param algorithm HMAC算法枚举
* @param key 共享密码，RFC 4226要求最少128位
*/
public TOTP(Duration timeStep, int passwordLength, HmacAlgorithm algorithm, byte[] key) {
super(passwordLength, algorithm, key);
this.timeStep = timeStep;
}
/**
* 使用给定的时间戳生成一次性密码.
*
* @param timestamp 用于生成密码的时间戳
* @return 一次性密码的int形式
*/
public int generate(Instant timestamp) {
return this.generate(timestamp.toEpochMilli() / this.timeStep.toMillis());
}
/**
* 用于验证code是否正确
*
* @param timestamp 验证时间戳
* @param offsetSize 误差范围
* @param code code
* @return 是否通过
* @since 5.7.4
*/
public boolean validate(Instant timestamp, int offsetSize, int code) {
if (offsetSize == 0) {
return generate(timestamp) == code;
}
for (int i = -offsetSize; i <= offsetSize; i++) {
if (generate(timestamp.plus(getTimeStep().multipliedBy(i))) == code) {
return true;
}
}
return false;
}
/**
* 生成谷歌认证器的字符串（扫码字符串）
* 基于时间的，计数器不适合
*
* @param account 账户名。
* @param numBytes 将生成的种子字节数量。
* @return 共享密钥
* @since 5.7.4
*/
public static String generateGoogleSecretKey(String account, int numBytes) {
return StrUtil.format("otpauth://totp/{}?secret={}", account, generateSecretKey(numBytes));
}
/**
* 获取步进
*
* @return 步进
*/
public Duration getTimeStep() {
return this.timeStep;
}
}