认证与授权
API 文档

OTP 认证提供程序

我们提供了一个 AuthenticationProvider 的实现，它使用一次性密码进行身份验证。该模块支持 Google Authenticator，您可以选择任何方便的库来创建带有密钥的二维码，或者简单地以 base32 格式传输密钥。

要使用此项目，请将以下依赖项添加到您的构建描述符的依赖项部分

  • Maven（在您的 pom.xml 中）

<dependency>
  <groupId>io.vertx</groupId>
  <artifactId>vertx-auth-otp</artifactId>
  <version>5.0.1</version>
</dependency>

  • Gradle（在您的 build.gradle 文件中）

compile 'io.vertx:vertx-auth-otp:5.0.1'

HOTP 认证

要创建 Hotp 认证提供程序的实例，请使用 HotpAuth.create，如下所示

HOTP 配置

HotpAuthOptions 类用于配置 Hotp 认证提供程序

passwordLength

设置的 OTP 密码长度，有效值介于 6 到 8 之间，默认值为 6。

authAttemptsLimit

认证尝试限制。

lookAheadWindow

再同步机制的使用。

注意事项

请注意，当使用此实现进行身份验证时，它假定身份验证信息中存在 identifier、key 和 counter 字段

TOTP 认证

要创建 Totp 认证提供程序的实例，请使用 TotpAuth.create，如下所示

TOTP 配置

TotpAuthOptions 类用于配置 Totp 认证提供程序

passwordLength

设置的 OTP 密码长度，有效值介于 6 到 8 之间，默认值为 6。

authAttemptsLimit

认证尝试限制。

period

认证代码有效的秒数时间段，默认值为 30。

注意事项

请注意，当使用此实现进行身份验证时，它假定身份验证信息中存在 identifier 和 key 字段