Giter VIP home page Giter VIP logo

keychain_access's Introduction

keychain_access

Flutter plugin to access Keychain Access apis on MacOS & iOS.

  • Following operations are available

    • Store secure data
    • Retrieve secure data
    • Delete secure data

Introduction

Why:

In my opinion, there are numerous stable libraries/plugins available for Android however a reliable plugin for MacOS & iOS does not seem to exist.

This plugin currently only supports MacOS & iOS and maybe extended to other platforms if such a need arises.

It leverages Keychain Services API to add secure data, query the secure data and delete the secure data.

Usage

To add secure data into keychain:

import 'package:keychain_access/keychain_access.dart';

await keychainAccess.addSecureData(
    "uniqueSecureDataIdentifier", # Example: username, uid, etc.
    "<secure-password>", # --> Your secure data goes here.
    application: "com.company.exampleApp" # --> This is optional.
);
// *Note: This will throw PlatformException if the secure data with key already exists.
// Use addOrUpdateSecureData to replace in case a record already exists with key.

To update secure data in keychain:

import 'package:keychain_access/keychain_access.dart';

await keychainAccess.updateSecureData(
    "uniqueSecureDataIdentifier", # Example: username, uid, etc.
    "<secure-password>", # --> Your secure data goes here.
    application: "com.company.exampleApp" # --> This is optional.
);
// *Note: This will throw PlatformException if the secure data with key does not exist.
// Use addOrUpdateSecureData to add in case a record does not exist with key.
// However, this does not gurantee any thread-safety.

To add or update secure data in keychain:

import 'package:keychain_access/keychain_access.dart';

await keychainAccess.addOrUpdateSecureData(
    "uniqueSecureDataIdentifier", # Example: username, uid, etc.
    "<secure-password>", # --> Your secure data goes here.
    application: "com.company.exampleApp" # --> This is optional.
);

To delete secure data in keychain:

import 'package:keychain_access/keychain_access.dart';

await keychainAccess.deleteSecureData(
    "uniqueSecureDataIdentifier", # Example: username, uid, etc.
    "<secure-password>", # --> Your secure data goes here.
    application: "com.company.exampleApp" # --> This is optional.
);
// *Note: This will throw PlatformException if the secure data with key does not exist.

keychain_access's People

Contributors

leogps avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.