Capacitor Secure Storage Plugin
[!IMPORTANT] This package was renamed please use the new package name! @evva/capacitor-secure-storage-plugin
Capacitor plugin for storing string values securely on iOS and Android.
How to install
Capacitor 7
npm install @evva/capacitor-secure-storage-plugin
npx cap sync
Capacitor 6
npm install @evva/[email protected]
npx cap sync
Older versions
For version lower than 6 please refer to https://github.com/martinkasa/capacitor-secure-storage-plugin
Compatibility
iOS 15.0+
Android API Level 29+
Usage
import { SecureStoragePlugin } from '@evva/capacitor-secure-storage-plugin';
Example
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 });
}
API
Interfaces
SecureStoragePluginInterface
| Prop | Type |
|---|---|
get | (options: { key: string; accessibility?: string; group?: string; isSynchronizable?: boolean; }) => Promise<{ value: string; }> |
set | (options: { key: string; value: string; accessibility?: string; group?: string; isSynchronizable?: boolean; }) => Promise<{ value: boolean; }> |
remove | (options: { key: string; accessibility?: string; group?: string; isSynchronizable?: boolean; }) => Promise<{ value: boolean; }> |
clear | (options?: { accessibility?: string; group?: string; isSynchronizable?: boolean; }) => Promise<{ value: boolean; }> |
keys | (options?: { accessibility?: string; group?: string; }) => Promise<{ value: string[]; }> |
getPlatform | () => Promise<{ value: string; }> |
Platform specific information
iOS
This plugin uses the SimpleKeychain Swift library for iOS.
Android
On Android, it is implemented using AndroidKeyStore, SharedPreferences, and EncryptedSharedPreferences for enhanced security. This approach uses modern encryption standards to ensure data security on devices with Android Marshmallow and above.
Web
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.