Flutter端到端加密通信插件r2f_x3dh_e2e的使用

r2f_x3dh_e2e

r2f_x3dh_e2e 是一个从Rust到Flutter的库，它利用X3DH协议实现端到端加密，用于建立共享密钥以确保安全通信。

动机

在当今的数字环境中，确保敏感数据的隐私和安全至关重要。端到端加密是一种强大的技术，可以保证交换数据的保密性和完整性。然而，实施端到端加密可能是一项复杂的工作，需要同时具备密码学和软件开发方面的专业知识。

r2f_x3dh_e2e 库的目标是简化将健壮的端到端加密集成到Flutter应用中的过程。通过利用Rust和Flutter的优势，该库为寻求在其应用中添加安全通信功能的开发者提供了无缝且高效的解决方案。

测试结果（性能模式）

根据在性能模式下进行的测试结果，Rust实现的帧率（FPS）有了显著提升，最高可达49 FPS。同样地，Dart实现也表现出显著改进，最高可达到40 FPS。这些结果表明，Rust和Dart都展示了有希望的优化，从而提高了FPS值并改善了整体性能。

CPU性能对比

测试类型	图像
r2f_x3dh_e2e
dart_x3dh_e2e

性能对比

测试类型	图像
r2f_x3dh_e2e
dart_x3dh_e2e

内存对比

测试类型	图像
r2f_x3dh_e2e
dart_x3dh_e2e

特性

• 简化了Rust的加密能力与Flutter应用的集成。
• 实现了X3DH协议，提供了强安全性保证，包括加密数据的保密性和完整性。
• 支持密钥生成、加密和解密功能。
• 支持字节数组和十六进制字符串形式的密钥。
• 简化了在Flutter应用中加入安全端到端加密的过程。

高级测试

rust_x3dh_e2e 和 dart_x3dh_e2e 项目采用先进的测试技术来确保其实现的可靠性和安全性。测试过程包括以下内容：

• 单元测试：编写全面的单元测试以验证各个函数和组件的正确性。
• 集成测试：执行集成测试以确保Rust和Flutter组件之间的无缝集成。
• 端到端测试：可能进行端到端测试以验证加密和解密过程，确保通信的隐私和数据完整性。

测试覆盖率报告和测试套件执行结果可用于评估测试方法的有效性和全面性。

实现方法

rust_x3dh_e2e 项目用Rust语言实现，这是一种注重安全、性能和并发性的编程语言。使用Rust确保了实现的安全内存管理，并提供了高效的执行。

dart_x3dh_e2e 项目则使用Dart语言实现，这是一种常用于开发跨平台移动应用的语言。Dart提供了丰富的库和框架，用于构建安全且高性能的应用。

两个项目都利用了扩展三重Diffie-Hellman（X3DH）密钥协商协议，这是一种用于在双方之间建立加密密钥的密码协议。该协议确保了密钥交换的安全性和通信的保密性。

dart_x3dh_e2e 项目使用了Flutter Rust-Bridge机制，这使得将Rust代码集成到Flutter应用中成为可能。这种结合使Dart和Rust在跨平台开发和高性能加密方面都能发挥优势。

通过结合Rust和Dart的力量，rust_x3dh_e2e 和 dart_x3dh_e2e 项目旨在利用X3DH协议提供健壮且安全的端到端加密解决方案。这些项目采用的高级测试方法确保了通信过程的可靠性、隐私性和数据完整性。

入门指南

要在您的Flutter项目中使用r2f_x3dh_e2e，请遵循以下步骤：

1. 在您的pubspec.yaml文件中添加库作为依赖项：

   dependencies:
     r2f_x3dh_e2e: ^0.0.2
   

2. 在Dart代码中导入库：

   import 'package:r2f_x3dh_e2e/r2f_x3dh_e2e.dart';
   

3. 参考项目仓库中的example/pubspec.yaml文件，获取使用说明和代码示例。它提供了一个演示如何使用r2f_x3dh_e2e的完整示例。

有关详细使用说明和示例，请参阅文档。

使用

导入所需的包：

import 'package:r2f_x3dh_e2e/models.dart';
import 'package:r2f_x3dh_e2e/r2f_x3dh_e2e.dart';

初始化库：

final r2fX3DHE2ESer = R2FX3DHE2ESer();
await r2fX3DHE2ESer.init();

加密

使用表示为整数列表的共享密钥加密数据：

final encryptedMsg = await r2fX3DHE2ESer.encryptWithBytesKey<EncryptedMsg>(
  x3DHKey: [1, 2, 3, 4, 5], // 共享密钥
  data: 'Hello, World!', // 要加密的数据
);

// 访问加密消息属性
final ciphertext = encryptedMsg.ciphertext;
final iv = encryptedMsg.iv;

使用表示为十六进制字符串的共享密钥加密数据：

final encryptedMsg = await r2fX3DHE2ESer.encryptWithHexStringKey<EncryptedMsg>(
  x3DHKey: 'dad2dae999b40bfe4a60881771e87880511ddb0b6bbd503ddddbb4ae22b34ff1', // 共享密钥（十六进制字符串）
  data: 'Hello, World!', // 要加密的数据
);

// 访问加密消息属性
final ciphertext = encryptedMsg.ciphertext;
final iv = encryptedMsg.iv;

解密

使用表示为十六进制字符串的共享密钥解密消息：

final decryptedData = await r2fX3DHE2ESer.decryptWithHexStringKey(
  x3DHKey: 'dad2dae999b40bfe4a60881771e87880511ddb0b6bbd503ddddbb4ae22b34ff1', // 共享密钥（十六进制字符串）
  ciphertext: [1, 2, 3, 4, 5], // 密文（整数列表）
  iv: [10, 20, 30, 40, 50], // 初始化向量（整数列表）
);

// 访问解密数据
print(decryptedData);

模型

r2f_x3dh_e2e 库提供了以下模型：

X3DHKey

表示X3DH共享密钥。

属性：

• hexStr (String): 密钥的十六进制字符串表示。
• bytes (List<int>): 密钥的字节数组表示。

UniEncryptedMsg

表示带有额外X3DH密钥信息的加密消息。

属性：

• ciphertext (Uint8List): 加密数据。
• iv (Uint8List): 初始化向量。
• x3dhKey (X3DHKey): X3DH共享密钥。

EncryptedMsg

表示加密消息。

属性：

• ciphertext (Uint8List): 加密数据。
• iv (Uint8List): 初始化向量。

贡献

欢迎对r2f_x3dh_e2e进行贡献！如果您遇到任何问题或有改进建议，请提交问题或拉取请求。我们非常感谢您的反馈和贡献。

许可证

r2f_x3dh_e2e 是根据 MIT 许可证授权的。

项目仓库

• dart_x3dh_e2e: X3DH端到端加密库的Dart实现仓库。
• rust_x3dh_e2e: X3DH端到端加密库的Rust实现仓库。

完整示例Demo

以下是一个完整的Flutter示例，展示了如何使用r2f_x3dh_e2e插件进行加密和解密操作。

import 'dart:async';
import 'dart:convert';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:example/models/message.dart';
import 'package:after_layout/after_layout.dart';
import 'package:r2f_x3dh_e2e/r2f_x3dh_e2e.dart';
import 'package:example/widgets/dart_x3dh_widget.dart';
import 'package:example/widgets/rust_x3dh_widget.dart';

// 应用程序的入口点。
Future<void> main() async {
  await R2FX3DHE2ESer().init(); // 初始化R2FX3DHE2ESer对象。
  runApp(const App()); // 运行应用程序。
}

// 应用程序的根部件。
class App extends StatefulWidget {
  const App({super.key});

  [@override](/user/override)
  State<App> createState() => AppState();
}

class AppState extends State<App> with WidgetsBindingObserver, AfterLayoutMixin {
  late ValueNotifier<List<Message>?> _msgNotifi; // 用于保存消息列表的ValueNotifier。
  late List<Widget> tabs; // 用于标签栏的标签列表。
  late List<Widget> tabbarViews; // 用于标签栏的视图列表。

  [@override](/user/override)
  void initState() {
    super.initState();
    _msgNotifi = ValueNotifier(null); // 初始化ValueNotifier，初始值为null。
    tabs = const [
      Tab(icon: Text("Pure-Dart")), // "Pure-Dart"标签。
      Tab(icon: Text("Rust-to-Dart")) // "Rust-to-Dart"标签。
    ];
  }

  [@override](/user/override)
  void dispose() {
    super.dispose();
    _msgNotifi.dispose(); // 释放资源，销毁ValueNotifier。
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return DefaultTabController(
      length: 2,
      child: MaterialApp(
        debugShowMaterialGrid: false,
        debugShowCheckedModeBanner: false,
        home: Scaffold(
          appBar: AppBar(
            title: const Text('X3DH-E2E-TESTING'), // 应用程序栏标题。
            centerTitle: true,
            bottom: TabBar(
              tabs: tabs, // 设置标签栏的标签。
            ),
          ),
          body: LayoutBuilder(
            builder: (context, constraints) {
              return SizedBox(
                width: constraints.maxWidth,
                height: constraints.maxHeight,
                child: ValueListenableBuilder<List<Message>?>(
                  valueListenable: _msgNotifi,
                  child: const Column(
                    mainAxisAlignment: MainAxisAlignment.center,
                    crossAxisAlignment: CrossAxisAlignment.center,
                    children: [
                      SizedBox(
                        child: CircularProgressIndicator(), // 加载指示器。
                      ),
                      Padding(
                        padding: EdgeInsets.symmetric(vertical: 12.0),
                        child: Text(
                          "Loading Messages",
                          style: TextStyle(fontWeight: FontWeight.bold),
                        ),
                      ),
                    ],
                  ),
                  builder: (context, msgs, child) {
                    if (msgs == null) {
                      return child!; // 如果消息为空，则显示加载指示器和文本。
                    }
                    return TabBarView(
                      children: [
                        DartX3dhWidget(messages: msgs), // "Pure-Dart"标签的部件。
                        RustX3dhWidget(messages: msgs), // "Rust-to-Dart"标签的部件。
                      ],
                    );
                  },
                ),
              );
            },
          ),
        ),
      ),
    );
  }

  [@override](/user/override)
  FutureOr<void> afterFirstLayout(BuildContext context) async {
    await Future.delayed(
      const Duration(seconds: 1),
      () async {
        final messagesJson = await rootBundle.loadString('assets/messages_1000.json'); // 从文件加载JSON数据。
        final decodedJson = jsonDecode(messagesJson) as List<dynamic>; // 解码JSON数据。
        final messages = decodedJson.map((value) => Message.fromJson(value)).toList(); // 将解码后的JSON转换为Message对象列表。
        _msgNotifi.value = messages; // 更新ValueNotifier，设置消息列表。
      },
    );
  }
}