react-native-keychain-access

Interface is similar to AsyncStorage, aside from pin on android

Getting started

$ npm install react-native-keychain-access --save

Mostly automatic installation

$ react-native link react-native-keychain-access

iOS notes

1. Add a NSFaceIDUsageDescription entry in your Info.plist.

2. Please also note these three lines in Podfile in the example/ios folder:

plugin 'cocoapods-user-defined-build-types'
enable_user_defined_build_types!
pod 'KeychainAccess', :build_type => :dynamic_framework

3. You have to install ruby and run bundle install once in the ios folder. After that, you will always do bundle exec pod install instead of pod install

Android notes

On android, we should get a 6-digit pin from user that looks like:

Usage

1import {Platform} from 'react-native';
2import {Keychain} from 'react-native-keychain-access';
3
4// Must not be changed
5const getService = () => {
6    if (Platform.OS === 'android') {
7        return 'protonsdk.secure_keys'
8    } else if (Platform.OS === 'ios') {
9        return 'proton.swift'
10    } else {
11        throw new Error('Unsupported Platform')
12    }
13}
14
15const KeychainService = new Keychain(getService());
16
17// Get 6-digit pin from user (Android only)
18const params = {
19    pin: Platform.OS === 'android' ? '123456' : undefined,
20};
21
22const key = 'PUB_K1_55VzHNofSRiJbQ5P9XWqNba2DXanF2KcCYby2EcRXyMxF5ki6k';
23const value = 'PVT_K1_2eU3nimmx21gR8Z4zAtmkBTDtfiKz4j1Q7EWGSMJ9QurgQ8ECr';
24const fakeKey = 'PUB_K1_7Zyp3EKYb6V9Q78tWdnnxyijFVkTGV4LcyBXwekP8EXqppFAKE';
25
26const setItem = await KeychainService.setItem(key, value, params);
27console.log(`setItem (${key} | ${value})`, setItem);
28
29const getItem = await KeychainService.getItem(key, params);
30console.log(`getItem (${key})`, getItem);
31
32const hasItem = await KeychainService.hasItem(key);
33console.log(`hasItem (${key})`, hasItem);
34
35const hasItem2 = await KeychainService.hasItem(fakeKey);
36console.log(`!hasItem (${fakeKey})`, hasItem2);
37
38if (Platform.OS === 'android') {
39    try {
40        console.log('Wrong 6 Digit Pin (getItem) - Throws error');
41        await KeychainService.getItem(key, { pin: '122200' });
42    } catch (e) {
43        console.error(e);
44    }
45}
46
47const getAllKeys = await KeychainService.getAllKeys();
48console.log('getAllKeys', getAllKeys);
49
50const getWrongItem = await KeychainService.getItem(fakeKey, params);
51console.log(`Get Wrong Item (${fakeKey}):`, getWrongItem);
52
53const removeItem = await KeychainService.removeItem(key);
54console.log(`removeItem (${key}`, removeItem);
55
56const getRemovedItem = await KeychainService.getItem(key, params);
57console.log(`Get Removed Item (${key})`, getRemovedItem);