Flutter加密解密插件cryptography_flutter的使用

概述

cryptography_flutter 是一个Flutter插件，它允许在Android、iOS和Mac OS X上使用原生API进行加密操作。该插件由gohilla.com维护，并且遵循Apache License 2.0开源协议。

使用理由

1. 安全性：操作系统API从安全角度来看是更优的选择。
2. 性能优越：与纯Dart实现相比，操作系统API可以快至100倍。
3. 跨平台支持：当操作系统API不可用时，会回退到package:cryptography的实现。

通用行为

• 包含了两种类型的类：
  • 如FlutterChacha20，在Android/iOS/Mac OS X上使用操作系统API；如果操作系统不支持，则使用背景实现（如BackgroundChacha20）或纯Dart实现（如DartChacha20）。
  • 类似BackgroundChacha20，通过Flutter SDK中的compute函数将长时间计算移动到后台隔离区。
• 对于非常小或过大的输入，避免跨隔离区传递消息开销，直接在同一隔离区内完成计算。
• 设有队列机制防止并发请求过多导致内存耗尽。

快速开始

在项目的pubspec.yaml文件中添加依赖：

dependencies:
  cryptography: ^2.7.0
  cryptography_flutter: ^2.3.2

更多API文档请参阅pub.dev/packages/cryptography。

算法行为

AES-GCM

• FlutterAesGcm用于Android、iOS和Mac OS X，性能比纯Dart实现高约50倍。
• BackgroundAesGcm用于Windows和Linux处理足够大的输入。

ChaCha20-Poly1305-AEAD

• FlutterChacha20适用于Android和Apple系统，性能提升显著。
• BackgroundChacha20为Windows和Linux准备。

NIST ECDH / ECDSA

• FlutterEcdh和FlutterEcdsa仅限Apple系统。

Ed25519 和 X25519

• 分别有FlutterEd25519/BackgroundEd25519及FlutterX25519/BackgroundX25519，均针对Apple系统。

HMAC 和 PBKDF2

• FlutterHmac和FlutterPbkdf2分别适用于Android，而BackgroundPbkdf2则覆盖Apple、Windows和Linux。

示例代码

下面是一个简单的示例应用，演示如何使用AES-GCM算法进行加密解密操作：

import 'dart:convert';
import 'package:cryptography/cryptography.dart';
import 'package:flutter/material.dart';

void main() {
  runApp(const MaterialApp(
    title: 'Cryptography demo',
    home: CipherPage(),
  ));
}

class CipherPage extends StatefulWidget {
  const CipherPage({Key? key}) : super(key: key);

  @override
  State<CipherPage> createState() => _CipherPageState();
}

class _CipherPageState extends State<CipherPage> {
  static final _aesGcm128 = AesGcm.with128bits();

  Cipher _cipher = _aesGcm128;
  final _secretKeyController = TextEditingController();
  final _nonceController = TextEditingController();

  List<int> _clearText = [];
  final _cipherTextController = TextEditingController();
  final _macController = TextEditingController();
  Object? _error;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: SafeArea(
        child: Center(
          child: Container(
            constraints: const BoxConstraints(maxWidth: 500),
            padding: const EdgeInsets.all(20),
            child: ListView(
              children: [
                // Cipher选择器
                InputDecorator(
                  decoration: const InputDecoration(labelText: 'Cipher'),
                  child: DropdownButton<Cipher>(
                    value: _cipher,
                    onChanged: (newValue) {
                      setState(() {
                        _cipher = newValue ?? _aesGcm128;
                        _encrypt();
                      });
                    },
                    items: [
                      DropdownMenuItem(
                        value: _aesGcm128,
                        child: const Text('AES-GCM (128-bits)'),
                      ),
                      // 其他Cipher选项...
                    ],
                  ),
                ),
                const SizedBox(height: 10),
                Text('Class: ${_cipher.runtimeType}'),
                const SizedBox(height: 10),
                // Secret Key输入框
                Row(children: [
                  Expanded(
                    child: TextField(
                      controller: _secretKeyController,
                      onChanged: (value) {
                        _encrypt();
                      },
                      minLines: 1,
                      maxLines: 16,
                      enableInteractiveSelection: true,
                      decoration: InputDecoration(
                          labelText: 'Secret key (${_cipher.secretKeyLength} bytes)'),
                    ),
                  ),
                  ElevatedButton(
                    onPressed: () async {
                      final secretKey = await _cipher.newSecretKey();
                      final bytes = await secretKey.extractBytes();
                      _secretKeyController.text = _toHex(bytes);
                      await _encrypt();
                    },
                    child: const Text('Generate'),
                  ),
                ]),
                const SizedBox(height: 10),
                // Nonce输入框
                Row(children: [
                  Expanded(
                    child: TextField(
                      controller: _nonceController,
                      onChanged: (value) {
                        _encrypt();
                      },
                      minLines: 1,
                      maxLines: 16,
                      enableInteractiveSelection: true,
                      decoration: InputDecoration(
                          labelText: 'Nonce (${_cipher.nonceLength} bytes)'),
                    ),
                  ),
                  ElevatedButton(
                    onPressed: () async {
                      _nonceController.text = _toHex(_cipher.newNonce());
                      await _encrypt();
                    },
                    child: const Text('Generate'),
                  ),
                ]),
                const SizedBox(height: 30),
                const Text('Encrypt'),
                TextField(
                  onChanged: (newValue) {
                    try {
                      _clearText = utf8.encode(newValue);
                      _encrypt();
                    } catch (error) {
                      setState(() {
                        _error = error;
                      });
                    }
                  },
                  minLines: 1,
                  maxLines: 16,
                  enableInteractiveSelection: true,
                  decoration: const InputDecoration(labelText: 'Cleartext (text)'),
                ),
                const SizedBox(height: 10),
                TextField(
                  controller: _cipherTextController,
                  minLines: 1,
                  maxLines: 16,
                  enableInteractiveSelection: true,
                  decoration: const InputDecoration(labelText: 'Ciphertext (hex)'),
                ),
                const SizedBox(height: 10),
                TextField(
                  controller: _macController,
                  minLines: 1,
                  maxLines: 16,
                  enableInteractiveSelection: true,
                  decoration: const InputDecoration(
                      labelText: 'Message Authentication Code (MAC)'),
                ),
                const SizedBox(height: 10),
                if (_error != null) Text(_error.toString()),
              ],
            ),
          ),
        ),
      ),
    );
  }

  Future<void> _encrypt() async {
    try {
      final cipher = _cipher;
      final secretBox = await cipher.encrypt(
        _clearText,
        secretKey: SecretKeyData(
          _fromHex(_secretKeyController.text),
        ),
        nonce: _fromHex(_nonceController.text),
      );
      _cipherTextController.text = _toHex(secretBox.cipherText);
      _macController.text = _toHex(secretBox.mac.bytes);
      setState(() {
        _error = null;
      });
    } catch (error, stackTrace) {
      setState(() {
        _error = '$error\n\n$stackTrace';
        _cipherTextController.text = '';
        _macController.text = '';
      });
      return;
    }
  }

  String _toHex(List<int> bytes) {
    return bytes.map((e) => e.toRadixString(16).padLeft(2, '0')).join(' ');
  }

  List<int> _fromHex(String s) {
    s = s.replaceAll(' ', '').replaceAll('\n', '');
    return List<int>.generate(s.length ~/ 2, (i) {
      var byteInHex = s.substring(2 * i, 2 * i + 2);
      if (byteInHex.startsWith('0')) {
        byteInHex = byteInHex.substring(1);
      }
      final result = int.tryParse(byteInHex, radix: 16);
      if (result == null) {
        throw StateError('Not valid hexadecimal bytes: $s');
      }
      return result;
    });
  }
}

此代码片段展示了如何创建一个简单的Flutter应用程序界面，用户可以选择不同的加密算法并输入密钥、随机数（nonce），然后输入明文进行加密。加密后的密文和MAC会被显示出来。同时提供了生成随机密钥和随机数的功能按钮。