Flutter插件rrad_mfa的特性与使用

Flutter插件rrad_mfa的特性与使用

Flutter插件rrad_mfa的功能特性

• 注册设备以用于基于时间的一次性密码（TOTP）。
• 验证基于时间的一次性密码（TOTP）的注册。
• 使用userId验证已注册设备的时间一次密码（TOTP）。
• 发送短信一次性密码（SMS OTP）。
• 验证发送到手机号码的短信一次性密码（SMS OTP）。

安装Flutter插件rrad_mfa

在你的pubspec.yaml文件中添加插件：

dependencies:
  rrad_mfa: any

然后初始化插件实例以便使用它：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  RRADMFA.instance.init(
    appName: 'RRAD', // 应用程序的简称
    serverUrl: 'http://localhost:6969', // 服务器URL
    totpApiKey: 'sdvsdvdaszfhvcedsth',   // TOTP API密钥
    smsApiKey: 'adsrgetwyetr',   // 短信OTP API密钥
  );

  runApp(const MyApp());
}

• 如果你想要使用基于时间的一次性密码（TOTP），则需要totpApiKey。
• 如果你想要使用基于短信的一次性密码（SMS OTP），则需要smsApiKey。

API规范

注册用户ID以首次使用基于时间的一次性密码（TOTP）

TOTPResponse<TOTP?> result = await RRADMFA.instance.register();

如果注册成功，它将返回密钥、用户ID和二维码图像的Uint8List数据。可以使用Image.memory小部件显示图像：

Image.memory(
  result.qrcodeImage!,
);

验证用户ID后的基于时间的一次性密码（TOTP）

TOTPResponse<TOTP?> result = await RRADMFA.instance.verify(
  userId: '', // 存储自注册响应的用户ID
  otp: '',  // 用户输入的一次性密码
);

验证基于时间的一次性密码（TOTP）

TOTPResponse<TOTP?> result = await RRADMFA.instance.validate(
  userId: '', // 存储自注册响应的用户ID
  otp: '',  // 用户输入的一次性密码
);

发送到手机号码的短信一次性密码（SMS OTP）

TOTPResponse<TOTP?> result = await RRADMFA.instance.sendSmsOtp(
  phoneNumber: '', // 用户的手机号码
);

注意：目前我们只向有效的孟加拉国手机号码发送短信一次性密码。

验证发送到手机号码的短信一次性密码（SMS OTP）

TOTPResponse<TOTP?> result = await RRADMFA.instance.validateSmsOtp(
  phoneNumber: '', // 用户的手机号码
  otp: '',  // 用户输入的一次性密码
);

完整示例Demo

以下是一个完整的示例代码，展示了如何使用rrad_mfa插件来实现多因素身份验证：

import 'package:flutter/material.dart';
import 'package:rrad_mfa/rrad_mfa.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化插件
  RRADMFA.instance.init(
    appName: 'RRAD', // 应用程序的简称
    serverUrl: 'http://localhost:6969', // 服务器URL
    totpApiKey: 'sdvsdvdaszfhvcedsth',   // TOTP API密钥
    smsApiKey: 'adsrgetwyetr',   // 短信OTP API密钥
  );

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: HomeScreen(),
    );
  }
}

class HomeScreen extends StatefulWidget {
  [@override](/user/override)
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  String _qrcodeImage = '';
  String _userId = '';

  Future<void> _register() async {
    final TOTPResponse<TOTP?> result = await RRADMFA.instance.register();
    if (result.success) {
      setState(() {
        _qrcodeImage = base64Encode(result.qrcodeImage!);
        _userId = result.userId!;
      });
    } else {
      // 处理错误
      print('Registration failed');
    }
  }

  Future<void> _verify() async {
    final TOTPResponse<TOTP?> result = await RRADMFA.instance.verify(
      userId: _userId,
      otp: '123456', // 假设用户输入了一次性密码
    );
    if (result.success) {
      // 处理成功情况
      print('Verification successful');
    } else {
      // 处理错误
      print('Verification failed');
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('RRAD MFA Demo'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            ElevatedButton(
              onPressed: _register,
              child: Text('Register'),
            ),
            SizedBox(height: 20),
            _qrcodeImage.isNotEmpty
                ? Image.memory(base64Decode(_qrcodeImage))
                : Container(),
            SizedBox(height: 20),
            ElevatedButton(
              onPressed: _verify,
              child: Text('Verify'),
            ),
          ],
        ),
      ),
    );
  }
}