@atroo/capacitor-secure-storage-plugin v5.0.0
@atroo/capacitor-secure-storage-plugin
Securely store secrets such as usernames, passwords, tokens, certificates or other sensitive information (strings) on iOS & Android
Install
npm install @atroo/capacitor-secure-storage-plugin
npx cap sync
Notes
Android
AutoBackup
To stay secure you need to handle the Auto Backup rules in Android. Please refer to this document.
Java 17
The plugin requires Java 17 to run. You can set it using the following options:
- changing the IDE settings.
- changing the JAVA_HOME environment variable.
- changing
org.gradle.java.home
ingradle.properties
.
API
The SecureStoragePlugin plugin interface
get(...)
get(options: { key: string; }) => Promise<{ value: string; }>
gets the value for the given key
Param | Type | Description |
---|---|---|
options | { key: string; } | key to get value for |
Returns: Promise<{ value: string; }>
getAccessibility(...)
getAccessibility(options: { key: string; }) => Promise<{ value: string | undefined; }>
gets the accessibility for the given key
Param | Type | Description |
---|---|---|
options | { key: string; } | key to get accessibility for |
Returns: Promise<{ value: string; }>
set(...)
set(options: SetDataOptions) => Promise<{ value: boolean; }>
sets the value for the given key
Param | Type | Description |
---|---|---|
options | SetDataOptions | key and value to set |
Returns: Promise<{ value: boolean; }>
remove(...)
remove(options: { key: string; }) => Promise<{ value: boolean; }>
removes the value for the given key
Param | Type | Description |
---|---|---|
options | { key: string; } | key to remove value for |
Returns: Promise<{ value: boolean; }>
clear()
clear() => Promise<{ value: boolean; }>
clears all values
Returns: Promise<{ value: boolean; }>
keys()
keys() => Promise<{ value: string[]; }>
gets all keys
Returns: Promise<{ value: string[]; }>
getPlatform()
getPlatform() => Promise<{ value: string; }>
gets the platform
Returns: Promise<{ value: string; }>
Interfaces
SetDataOptions
allows to define how properties can be accessed on iOS
Prop | Type |
---|---|
key | string |
value | string |
accessibility | Accessibility |
Type Aliases
Accessibility
allows to define how properties can be accessed on iOS
'afterFirstUnlock' | 'afterFirstUnlockThisDeviceOnly' | 'whenUnlocked' | 'whenUnlockedThisDeviceOnly' | 'always' | 'alwaysThisDeviceOnly' | 'whenPasscodeSetThisDeviceOnly'