Flutter加密解密插件sodium的使用

sodium 是一个为Dart提供的libsodium绑定库，支持VM和JS环境，无需Flutter依赖。它提供了简单的API来访问libsodium的主要功能，并尽可能地与原始C API保持一致。本文将详细介绍如何在Flutter项目中使用sodium进行加密解密操作。

目录

• 特性
• 安装
• 使用
  • Sodium vs SodiumSumo
  • 加载libsodium
    • VM - 加载动态库
    • 转译JavaScript - 加载JavaScript代码
      • 通过Dart加载sodium.js到浏览器
  • 使用API
  • 在单独的隔离区运行计算
    • 使用自定义隔离区
• 文档

特性

sodium 提供了以下特性：

• 简单易用的Dart API，适用于VM和JS环境。
• 提供所有主要的libsodium API（详见API状态）。
• 支持本地API以实现更紧密的集成。

API状态

安装

在 pubspec.yaml 文件中添加 sodium 依赖并运行 flutter pub get：

dependencies:
  sodium: ^latest_version

对于Flutter用户，建议使用 sodium_libs，它可以为每个Flutter平台提供嵌入式的二进制文件。

使用

Sodium vs SodiumSumo

如果你只使用原生版本（即你的应用程序不会被转译成JS），你可以总是使用sumo变体。如果你想同时支持原生和Web，则需要检查你需要的API是否在标准版或sumo版中可用。

加载libsodium

VM - 加载动态库

在Dart VM中，使用 dart:ffi 加载libsodium动态库：

import 'dart:ffi';
import 'package:sodium/sodium.dart';

DynamicLibrary loadLibsodium() {
  return DynamicLibrary.open('/path/to/libsodium.XXX'); // 或者 DynamicLibrary.process()
}

final sodium = await SodiumInit.init2(loadLibsodium);

转译JavaScript - 加载JavaScript代码

对于浏览器环境，可以使用 sodium.js：

import 'package:sodium/sodium.dart';

dynamic loadSodiumJS() {
  return ...; // 例如通过<script>标签加载
}

final sodium = await SodiumInit.init2(loadSodiumJS);

通过Dart加载sodium.js到浏览器

@JS()
library interop;

import 'package:js/js.dart';
import 'package:sodium/sodium.dart';

@JS()
@anonymous
class SodiumBrowserInit {
  external void Function(dynamic sodium) get onload;
  external factory SodiumBrowserInit({void Function(dynamic sodium) onload});
}

Future<dynamic> loadSodiumInBrowser() async {
  final completer = Completer<dynamic>();

  setProperty(window, 'sodium', SodiumBrowserInit(
    onload: allowInterop(completer.complete),
  ));

  final script = ScriptElement();
  script
    ..type = 'text/javascript'
    ..async = true
    ..src = 'sodium.js'; // 使用你服务器上的路径
  document.head!.append(script);

  return completer.future;
}

final sodium = await SodiumInit.init2(loadSodiumInBrowser);

使用API

获取 Sodium 实例后，使用API非常简单。以下是加密示例：

final sodium = // 加载libsodium

final String message = 'my very secret message';
final Uint8List messageBytes = Uint8List.fromList(message.codeUnits);

final nonce = sodium.randombytes.buf(sodium.crypto.secretBox.nonceBytes);
final SecureKey key = sodium.crypto.secretBox.keygen();

final encryptedData = sodium.crypto.secretBox.easy(
  message: messageBytes,
  nonce: nonce,
  key: key,
);

print(encryptedData);

key.dispose();

在单独的隔离区运行计算

对于耗时较长的操作（如密码哈希），可以在隔离区中运行以避免阻塞UI：

final subkeyId = BigInt.from(42);
final masterKey = sodium.crypto.kdf.keygen();
final derivedKey = await sodium.runIsolated(
  secureKeys: [masterKey],
  (sodium, secureKeys, keyPairs) {
    final [masterKey] = secureKeys;
    return sodium.crypto.kdf.deriveFromKey(
      masterKey: masterKey,
      context: 'computed',
      subkeyId: subkeyId,
      subkeyLen: 64,
    );
  }
);

使用自定义隔离区

对于更复杂的场景，可以使用低级隔离区API：

Future<SecureKey> deriveKey() {
  final subkeyId = BigInt.from(42);
  final masterKey = sodium.crypto.kdf.keygen();

  final sodiumFactory = sodium.isolateFactory;
  final transferrableMasterKey = sodium.createTransferrableSecureKey(masterKey);

  final result = compute(_deriveKey, (sodiumFactory, transferrableMasterKey, subkeyId));

  return sodium.materializeTransferrableSecureKey(result);
}

Future<TransferrableSecureKey> _deriveKey((SodiumFactory, TransferrableSecureKey, BigInt) message) async {
  final (sodiumFactory, transferrableMasterKey, subkeyId) = message;
  final sodium = await sodiumFactory();
  final masterKey = sodium.materializeTransferrableSecureKey(transferrableMasterKey);
  final derivedKey = sodium.crypto.kdf.deriveFromKey(
    masterKey: masterKey,
    context: 'computed',
    subkeyId: subkeyId,
    subkeyLen: 64,
  );
  return sodium.createTransferrableSecureKey(derivedKey);
}

文档

更多详细信息请参考 官方文档 和 示例代码。

希望以上内容能帮助你在Flutter项目中顺利使用sodium进行加密解密操作！如果有任何问题，请随时提问。