Flutter数据库加密插件encrypt_db的使用

Flutter数据库加密插件encrypt_db的使用

描述

encrypt_db 是一个用于使用AES-256加密算法加密和解密数据的Flutter插件。您可以使用此插件将敏感数据存储在本地存储中。 例如：用户凭据、API密钥、Bearer令牌等。

为什么使用这个插件？

• 此插件使用AES-256加密算法来加密和解密数据。
• 此插件使用Keychain（iOS）和KeyStore（Android）来存储加密密钥。
• 此插件可以存储String、int、double 和 bool 数据类型。

安装

在您的应用的 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  encrypt_db: latest_version

入门指南

读取和写入

_encrytDbPlugin.write(key: 'key1', value: 'value1'); /// 返回无值，但写入一个值
_encrytDbPlugin.read(key: 'key1', defaultValue: ''); /// 返回与defaultValue类型相同的值
_encrytDbPlugin.readAll(); /// 返回一个 Map<String, dynamic> 

清除所有数据和清除特定键

_encrytDbPlugin.clearAll(); /// 返回无值，但清除所有数据
_encrytDbPlugin.clear(key: 'key1'); /// 返回无值，但清除一个特定键

示例

import 'package:encrypt_db/encrypt_db.dart';

main() async {
  var _encryptDbPlugin = new EncryptDb();
  
  var result = await _encryptDbPlugin.readAll();
  debugPrint('result0: $result');
  
  await _encryptDbPlugin.clearAll();
  debugPrint('Clear all');
  
  result = await _encryptDbPlugin.readAll();
  debugPrint('result1: $result');
  
  _encryptDbPlugin.write(key: 'key1', value: 'value1');
  debugPrint('Write key1');
  
  result = await _encryptDbPlugin.read(
      key: 'key1', defaultValue: 'default_value');
  debugPrint('result2: $result');
  
  _encryptDbPlugin.write(key: 'key2', value: 'value2');
  debugPrint('Write key2');
  
  result = await _encryptDbPlugin.readAll();
  debugPrint('result3: $result');
  
  _encryptDbPlugin.clear(key: 'key1');
  debugPrint('Delete key1');
  
  result = await _encryptDbPlugin.readAll();
  debugPrint('result4: $result');
  
  _encryptDbPlugin.clearAll();
  debugPrint('Clear all');
}

重要提示

• 此插件需要支持异步/等待。因此，您需要使用 Flutter 1.12.13+hotfix.5 或更高版本。
• Android API 级别 28 或更高版本是必需的。
• iOS 10.0 或更高版本是必需的。
• Dart 3 已准备就绪。

特性和问题

请在 问题跟踪器 上提交功能请求和错误报告。

作者

Debojyoti Singha

贡献者

• Debojyoti Singha

即将到来的功能

• ❌ 可插拔数据库支持
• ❌ 使用RSA-2048算法进行加密
• ❌ macOS 支持
• ❌ Windows 支持
• ❌ Linux 支持

许可证

MIT License

Copyright (c) 2023 Debojyoti Singha

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

示例代码

import 'dart:async';

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

void main() {
  runApp(const MyApp());
}

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final _encryptDbPlugin = EncryptDb();
  final Map<String, dynamic> _testPrintMap = {};

  [@override](/user/override)
  void initState() {
    super.initState();
    initialDb();
  }

  Future<void> initialDb() async {
    try {
      _encryptDbPlugin.initializeEncryptDb();
      _encryptDbPlugin.write(key: 'key0', value: 452);
    } catch (e) {
      debugPrint('Error: $e');
    }
  }

  void _runManualTest() async {
    try {
      var result = await _encryptDbPlugin.readAll();
      debugPrint('result0: $result');
      _testPrintMap['result0'] = result;
      await _encryptDbPlugin.clearAll();
      debugPrint('Clear all');
      result = await _encryptDbPlugin.readAll();
      debugPrint('result1: $result');
      _testPrintMap['result1'] = result;
      _encryptDbPlugin.write(key: 'key1', value: 'value1');
      debugPrint('Write key1');
      _testPrintMap['Write key1'] = 'Write key1';
      result = await _encryptDbPlugin.read(
          key: 'key1', defaultValue: 'default_value');
      debugPrint('result2: $result');
      _testPrintMap['result2'] = result;
      _encryptDbPlugin.write(key: 'key2', value: 'value2');
      debugPrint('Write key2');
      _testPrintMap['Write key2'] = 'Write key2';
      result = await _encryptDbPlugin.readAll();
      debugPrint('result3: $result');
      _testPrintMap['result3'] = result;
      _encryptDbPlugin.clear(key: 'key1');
      debugPrint('Delete key1');
      _testPrintMap['Delete key1'] = 'Delete key1';
      result = await _encryptDbPlugin.readAll();
      debugPrint('result4: $result');
      _testPrintMap['result4'] = result;
      _encryptDbPlugin.clearAll();
      debugPrint('Clear all');
      _testPrintMap['Clear all'] = 'Clear all';
    } catch (e) {
      debugPrint('Error: $e');
    } finally {
      debugPrint('Test print map: $_testPrintMap');
      setState(() {});
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Encrypt DB example app'),
        ),
        body: SafeArea(
          child: Column(
            children: [
              ListView.builder(
                shrinkWrap: true,
                itemCount: _testPrintMap.length,
                itemBuilder:
                    (BuildContext context, int index) {
                  final key = _testPrintMap.keys.elementAt(index);
                  final value = _testPrintMap[key];
                  return Container(
                    margin: const EdgeInsets.all(8),
                    child: Text('log: $key: $value'),
                  );
                },
              ),
              ElevatedButton(
                onPressed: () async {
                  _runManualTest();
                },
                child: const Text('Run Test'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}