Capacitor plugin for storing string values securly on iOS and Android.
npm install @evva-sfw/capacitor-secure-storage-plugin
npm install @evva-sfw/[email protected]
For version lower than 5 please refer to https://github.com/martinkasa/capacitor-secure-storage-plugin
import { SecureStoragePlugin } from '@evva-sfw/capacitor-secure-storage-plugin';
get(options: { key: string }): Promise<{ value: string }>
Note if item with specified key does not exist, throws an Error
set(options: { key: string; value: string }): Promise<{ value: boolean }>
Note return true in case of success otherwise throws an error
remove(options: { key: string }): Promise<{ value: boolean }>
Note return true in case of success otherwise throws an error
keys(): Promise<{ value: string[] }>
clear(): Promise<{ value: boolean }>
Note return true in case of success otherwise throws an error
getPlatform(): Promise<{ value: string }>
Note return returns which implementation is used - one of 'web', 'ios' or 'android'
const key = 'username';
const value = 'hellokitty2';
SecureStoragePlugin.set({ key, value })
.then(success => console.log(success))
const key = 'username';
SecureStoragePlugin.get({ key })
.then(value => {
console.log(value);
})
.catch(error => {
console.log('Item with specified key does not exist.');
});
async getUsername(key: string) {
return await SecureStoragePlugin.get({ key });
}
This plugin uses the SimpleKeychain Swift library for iOS.
On Android it is implemented by AndroidKeyStore and SharedPreferences. Source: Apriorit
There is no secure storage in browser (not because it is not implemented by this plugin, but it does not exist at all). Values are stored in LocalStorage, but they are at least base64 encoded. Plugin adds 'capsec' prefix to keys to avoid conflicts with other data stored in LocalStorage.