flutter_keychain 0.0.5

  • README.md
  • Example
  • Installing
  • Versions
  • new66


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 is used for iOS
  • AES encryption is used for Android. AES secret key is encrypted with RSA and RSA key is stored in KeyStore

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

Getting Started

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


For help on editing plugin code, view the documentation.


  • Intial release with only Android support. iOS support due to follow.


  • Added iOS support (Objective-C for now)


import 'dart:async';

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

void main() => runApp(new MyApp());

class MyApp extends StatefulWidget {
  _MyAppState createState() => new _MyAppState();

class _MyAppState extends State<MyApp> {
  String _firstStart = 'Unknown';

  void initState() {

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
    String platformVersion;
    // Platform messages may fail, so we use a try/catch PlatformException.
    try {
      var firstStart = await FlutterKeychain.get(key: "firstStart");

      if (null == firstStart) {
        await FlutterKeychain.put(
            key: "firstStart", value: DateTime.now().toIso8601String());

      // If the widget was removed from the tree while the asynchronous platform
      // message was in flight, we want to discard the reply rather than calling
      // setState to update our non-existent appearance.
      if (!mounted) return;

      setState(() {
        if (null == firstStart) {
          _firstStart = "Was never started before. Restart and see .";
        } else {
          _firstStart = firstStart;
    } on Exception catch (ae) {
      print("Exception: " + ae.toString());

  Widget build(BuildContext context) {
    return new MaterialApp(
      home: new Scaffold(
        appBar: new AppBar(
          title: const Text('Plugin example app'),
        body: new Center(
          child: new Text('First Start: $_firstStart\n'),

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  flutter_keychain: ^0.0.5

2. Install it

You can install packages from the command line:

with Flutter:

$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:flutter_keychain/flutter_keychain.dart';
Version Uploaded Documentation Archive
0.0.5 Sep 16, 2018 Go to the documentation of flutter_keychain 0.0.5 Download flutter_keychain 0.0.5 archive
0.0.4 Sep 16, 2018 Go to the documentation of flutter_keychain 0.0.4 Download flutter_keychain 0.0.4 archive
0.0.3 Sep 16, 2018 Go to the documentation of flutter_keychain 0.0.3 Download flutter_keychain 0.0.3 archive
0.0.2 Sep 12, 2018 Go to the documentation of flutter_keychain 0.0.2 Download flutter_keychain 0.0.2 archive
0.0.1 Sep 4, 2018 Go to the documentation of flutter_keychain 0.0.1 Download flutter_keychain 0.0.1 archive
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Sep 18, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0
  • pana: 0.12.3
  • Flutter: 0.8.4


Detected platforms: Flutter

References Flutter, and has no conflicting libraries.


The description is too short.

Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

Package is pre-v0.1 release.

While there is nothing inherently wrong with versions of 0.0.*, it usually means that the author is still experimenting with the general direction of the API.

Format lib/generated/i18n.dart.

Run flutter format to format lib/generated/i18n.dart.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11
meta 1.1.6
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8