Flutter一次性密码（OTP）认证插件totp_authenticator的使用

Flutter一次性密码（OTP）认证插件totp_authenticator的使用

特性

  • 🔑 创建密钥：生成用于TOTP生成的密钥。
  • ✔️ 验证TOTP代码：验证用户输入的代码与生成的代码是否匹配。
  • 🚀 生成TOTP代码：根据提供的密钥和当前时间生成TOTP代码。
  • 📸 获取二维码或扫描用的URI：生成一个可用于Google Authenticator或Microsoft Authenticator等应用扫描的URI或二维码。

测试过的身份验证应用程序

Logo 服务名称 状态
Google Authenticator ✅ 支持
Microsoft Authenticator ✅ 支持

使用方法

generateSecret()

  • 生成一个Base32格式的随机密钥。该密钥将用于生成TOTP代码，这些代码将在身份验证应用中进行验证。

示例：

String secretKey = TOTP.generateSecret();
print(secretKey);

generateTOTPCode(String secretKey, {int interval = 30})

  • 根据提供的密钥和当前时间生成TOTP代码。每个代码的有效期由间隔时间定义，默认为30秒。

参数：

  • secretKey (必需)：之前生成的Base32编码的密钥。
  • interval (可选，默认值为30)：每个代码的有效时间间隔（以秒为单位），默认为30秒。

示例：

String otpCode = totp.generateTOTPCode(secretKey);
print('Generated TOTP code: $otpCode');

verifyCode(String secretKey, String otpCode, {int interval = 30})

  • 验证用户提供的TOTP代码是否有效。每个代码的有效期由间隔时间定义，默认为30秒。

参数：

  • secretKey (必需)：之前生成的Base32编码的密钥。
  • otpCode (必需)：要验证的用户提供的TOTP代码。
  • interval (可选，默认值为30)：每个代码的有效时间间隔（以秒为单位），默认为30秒。

示例：

bool isValid = totp.verifyCode(secretKey, otpCode);
print(isValid ? 'Valid code' : 'Invalid code');

generateQRCodeUri(String appName, String secretKey, {String issuer = 'totp_authenticator', int interval = 30})

  • 生成一个URI，该URI可以被TOTP身份验证应用用来扫描并设置用户的账户。此URI可以用来生成二维码。

示例：

String uri = totp.generateQRCodeUri('MyApp', secretKey);
print('URI for QR Code: $uri');

generateQRCodeUrl(String appName, String secretKey, {String issuer = 'totp_authenticator'})

  • 同上，但返回直接的二维码URL。

示例：

String qrCodeUrl = totp.generateQRCodeUrl('MyApp', secretKey);
print('QR Code URL: $qrCodeUrl');

//Image.network(qrCodeUrl);

更多关于Flutter一次性密码（OTP）认证插件totp_authenticator的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter一次性密码（OTP）认证插件totp_authenticator的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是一个关于如何在Flutter项目中使用totp_authenticator插件来实现一次性密码（OTP）认证的代码示例。这个插件允许你生成和验证基于时间的一次性密码（TOTP）。

首先，你需要在你的pubspec.yaml文件中添加totp_authenticator依赖：

dependencies:
  flutter:
    sdk: flutter
  totp_authenticator: ^x.y.z  # 请替换为最新版本号

然后运行flutter pub get来安装依赖。

接下来，你可以在你的Flutter项目中按照以下步骤实现OTP认证：

  1. 生成一个秘密密钥（这通常是在用户注册时生成的，并存储在服务器端）：
import 'package:totp_authenticator/totp_authenticator.dart';
import 'dart:convert';

void generateSecretKey() async {
  // 生成一个32字节的秘密密钥
  Uint8List secretKey = await TOTPAuthenticator.generateSecretKey();
  // 将密钥转换为Base32字符串以便存储或传输
  String base32Secret = base32.encode(secretKey);
  print("Generated Secret Key (Base32): $base32Secret");

  // 在实际应用中，你可能需要将这个密钥发送到服务器存储
}
  1. 生成TOTP（在服务器端或客户端根据需要生成）：
void generateTOTP(String base32Secret) async {
  // 将Base32字符串转换回Uint8List
  Uint8List secretKey = base32.decode(base32Secret);
  
  // 获取当前时间的时间戳（秒）
  int timestamp = DateTime.now().toEpochSecond();

  // 生成TOTP
  String totp = await TOTPAuthenticator.generateTOTP(secretKey, timestamp);
  print("Generated TOTP: $totp");

  // 在实际应用中，你可能需要将这个TOTP通过短信或其他方式发送给用户
}
  1. 验证TOTP（用户在输入接收到的TOTP后进行验证）：
void verifyTOTP(String base32Secret, String userInput) async {
  // 将Base32字符串转换回Uint8List
  Uint8List secretKey = base32.decode(base32Secret);
  
  // 获取当前时间的时间戳（秒），并允许一个时间窗口（例如30秒）
  int timestamp = DateTime.now().toEpochSecond();
  int window = 30;

  bool isValid = await TOTPAuthenticator.verifyTOTP(
    secretKey,
    userInput,
    timestamp,
    window
  );

  if (isValid) {
    print("TOTP is valid.");
    // 执行登录或其他操作
  } else {
    print("TOTP is invalid.");
    // 提示用户输入错误
  }
}

请注意，上述代码中的base32是一个假设的Base32编码/解码库，你需要在你的项目中实际添加这个库（例如dart:convert中的Base64编码可能需要你自己转换或找到一个Base32库）。由于Flutter标准库中并没有直接提供Base32编码，你可能需要使用第三方库，比如base32-dart。

这是一个完整的例子，演示了如何生成密钥、生成TOTP并验证TOTP。你可以根据自己的需求调整这些函数，例如将它们集成到你的UI逻辑中。

回到顶部