Flutter安全工具插件mtrust_sec_kit的使用

Flutter安全工具插件mtrust_sec_kit的使用

概述

SEC-Kit简化了将M-Trust SEC-Reader集成到您的Flutter应用程序的过程，提供了安全且高效的通信功能。

前提条件

• 在系统上安装了Flutter SDK。
• 具备基本的Flutter开发知识。
• 访问M-Trust SEC-Reader硬件，或者在没有硬件的情况下使用mtrust_virtual_strategy进行开发。

安装

通过以下命令将mtrust_sec_kit添加到您的Flutter项目：

flutter pub add mtrust_sec_kit

或手动将其添加到您的pubspec.yaml文件中：

dependencies:
  mtrust_sec_kit: ^1.0.0

SEC-Kit可以与不同的URP连接策略一起工作。默认情况下，SEC Reader使用BLE（蓝牙低功耗）。请在您的pubspec.yaml文件中包含BLE连接策略：

dependencies:
  mtrust_sec_kit: ^1.0.0
  # 添加BLE连接策略
  mtrust_urp_ble_strategy: ^8.0.1

请根据您的平台配置BLE的具体步骤，请参阅这里。

使用

字体

SEC-Kit使用Lato字体和自定义图标。要包含这些资源，请更新您的pubspec.yaml文件：

flutter:
  fonts: 
    - family: Lato
      fonts:
        - asset: packages/liquid_flutter/fonts/Lato-Regular.ttf
          weight: 500
        - asset: packages/liquid_flutter/fonts/Lato-Bold.ttf
          weight: 800
    - family: LiquidIcons
      fonts:
        - asset: packages/liquid_flutter/fonts/LiquidIcons.ttf

多语言支持

为了支持多种语言，需要将必要的本地化委托添加到您的应用程序中。有关国际化全面指导，请参阅Flutter文档。

return const MaterialApp(
  title: '您的应用名称',
  localizationsDelegates: [
    ...LiquidLocalizations.delegate,
    ...UrpUiLocalizations.delegate,
    ...SecLocalizations.localizationsDelegates,
  ],
  home: MyHomePage(),
);

添加UI依赖

要利用SEC-Kit的UI组件，请包含以下提供者和门户：

1. 主题提供者：用LdThemeProvider包装您的应用：

LdThemeProvider(
  child: MaterialApp(
    home: MyHomePage(),
  ),
)

1. 门户：将您的Scaffold封装在LdPortal中：

LdPortal(
  child: Scaffold(
    ...
  ),
)

使用SEC表单

要显示SEC表单，请使用SecSheet小部件。它需要一个连接策略、有效负载以及验证过程的回调：

SecSheet(
  strategy: _connectionStrategy,
  payload: // 有效负载,
  onVerificationDone: () {},
  onVerificationFailed: () {},
  builder: (context, openSheet) {
    // 调用openSheet以打开SEC表单
  },
),

配置选项

• 连接策略：虽然BLE是默认设置，但SEC-Kit支持各种连接策略。确保根据需要包含并配置适当的策略包。

故障排除

• BLE连接问题：确保设备的蓝牙已启用，并且M-Trust SEC-Reader已开启且在范围内。
• 字体渲染问题：确保字体资源正确引用在您的pubspec.yaml文件中，并且文件存在于指定路径中。

贡献

我们欢迎贡献！请将仓库fork并提交包含更改的pull请求。确保您的代码符合我们的编码标准并包括适当的测试。

许可证

该项目基于Apache 2.0许可证。详情请参见LICENSE文件。

示例代码

import 'dart:typed_data';

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

import 'package:mtrust_urp_virtual_strategy/mtrust_urp_virtual_strategy.dart';

import 'package:liquid_flutter/liquid_flutter.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();

  runApp(LdThemeProvider(
    child: LdThemedAppBuilder(appBuilder: (context, theme) {
      return MaterialApp(
        theme: theme,
        localizationsDelegates: const [
          DefaultMaterialLocalizations.delegate,
          DefaultWidgetsLocalizations.delegate,
          LiquidLocalizations.delegate,
          SecLocalizations.delegate,
          UrpUiLocalizations.delegate,
        ],
        home: const MainApp(),
      );
    }),
  ));
}

extension PrependLength on Uint8List {
  Uint8List prependLength() {
    return Uint8List.fromList(_int16ToBytes(length) + this);
  }

  Uint8List _int16ToBytes(int value) {
    if (value < -32768 || value > 32767) {
      throw ArgumentError('Value must be between -32768 and 32767.');
    }

    final bytes = Uint8List(2);

    // 将两个字节存储为小端顺序
    bytes[0] = (value >> 8) & 0xFF; // 上位字节
    bytes[1] = value & 0xFF; // 下位字节

    return bytes;
  }
}

class MainApp extends StatefulWidget {
  const MainApp({super.key});

  [@override](/user/override)
  State<MainApp> createState() => _MainAppState();
}

class _MainAppState extends State<MainApp> {
  final _virtualStrategy = UrpVirtualStrategy((UrpRequest request) async {
    final payload = UrpSecCommandWrapper.fromBuffer(request.payload);
    final result = switch (payload.deviceCommand.command) {
      (UrpSecCommand.urpSecPrime) => UrpResponse(),
      (UrpSecCommand.urpSecStartMeasurement) => UrpResponse(
          payload: UrpSecMeasurement(
            nonce: 12,
            readerId: "foo",
            signature: "bar",
          ).writeToBuffer(),
        ),
      _ => switch (payload.coreCommand.command) {
          (UrpCommand.urpOff) => UrpResponse(),
          _ => throw Exception("Command not supported"),
        },
    };

    await Future.delayed(const Duration(seconds: 2));

    return result;
  });

  //late final _bleStrategy = UrpBleStrategy();

  [@override](/user/override)
  void initState() {
    _virtualStrategy.createVirtualReader(FoundDevice(
      name: "SEC-000123",
      type: UrpDeviceType.urpSec,
      address: "00:00:00:00:00:00",
    ));
    super.initState();
  }

  // 如果验证成功将被调用。
  void onVerificationDone(/*Measurement content*/) async {
    // 获取身份验证令牌
  }

  // 如果验证失败将被调用。
  void onVerificationFailed() {}

  [@override](/user/override)
  Widget build(BuildContext context) {
    return LdPortal(
      child: Scaffold(
        appBar: LdAppBar(
          context: context,
          title: const Text(
            "SEC Kit Example",
          ),
        ),
        body: SafeArea(
          child: Column(mainAxisAlignment: MainAxisAlignment.end, children: [
            Container(
              width: double.infinity,
            ),
            SecSheet(
              strategy: _virtualStrategy,
              payload: "",
              onVerificationDone: (measurement) {},
              onVerificationFailed: () {},
              builder: (context, openSheet) {
                return LdButton(
                  onPressed: openSheet,
                  child: const Text("Open SEC Sheet"),
                );
              },
            ),
            ldSpacerL,
          ]),
        ),
      ),
    );
  }
}