# fluttertpc_flutter_keychain

**Repository Path**: openharmony-sig/fluttertpc_flutter_keychain

## Basic Information

- **Project Name**: fluttertpc_flutter_keychain
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2024-06-25
- **Last Updated**: 2025-05-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 🚨 **重要提示 | IMPORTANT**
>
> **⚠️ 此代码仓已归档。新地址请访问 [fluttertpc_flutter_keychain](https://gitcode.com/openharmony-sig/fluttertpc_flutter_keychain)。| ⚠️ This repository has been archived. For the new address, please visit [fluttertpc_flutter_keychain](https://gitcode.com/openharmony-sig/fluttertpc_flutter_keychain).**
>
---
>
# flutter_keychain

A Flutter plugin for supporting secure storage of strings via Keychain and Keystore

If you have other types you want to store, you need to serialize to and from UTF-8 strings.

* [Keychain](https://developer.apple.com/library/content/documentation/Security/Conceptual/keychainServConcepts/01introduction/introduction.html#//apple_ref/doc/uid/TP30000897-CH203-TP1) is used for iOS
* AES encryption is used for Android. AES secret key is encrypted with RSA and RSA key is stored in [KeyStore](https://developer.android.com/training/articles/keystore.html)

*Note* KeyStore was introduced in Android 4.3 (API level 18). The plugin does not work on earlier versions.


## Getting Started
```dart

import 'package:flutter_keychain/flutter_keychain.dart';
...

// Get value
var value = await FlutterKeychain.get(key: "key");

// Put value
await FlutterKeychain.put(key: "key", value: "value");

// Remove item
await FlutterKeychain.remove(key: "key");

// Clear the secure store
await FlutterKeychain.clear();

```

### Configure Android version
In `[project]/android/app/build.gradle` set `minSdkVersion` to >= 18.
```
android {
    ...
    defaultConfig {
        ...
        minSdkVersion 18
        ...
    }
}
```

## Contributing

For help on editing plugin code, view the [documentation](https://flutter.io/developing-packages/#edit-plugin-package).