Socket
Socket
Sign inDemoInstall

@atroo/capacitor-secure-storage-plugin

Package Overview
Dependencies
2
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @atroo/capacitor-secure-storage-plugin

Securely store secrets such as usernames, passwords, tokens, certificates or other sensitive information (strings) on iOS & Android


Version published
Maintainers
1
Install size
73.7 kB
Created

Readme

Source

@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 in gradle.properties.

API

The SecureStoragePlugin plugin interface

get(...)

get(options: { key: string; }) => Promise<{ value: string; }>

gets the value for the given key

ParamTypeDescription
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

ParamTypeDescription
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

ParamTypeDescription
optionsSetDataOptionskey and value to set

Returns: Promise<{ value: boolean; }>


remove(...)

remove(options: { key: string; }) => Promise<{ value: boolean; }>

removes the value for the given key

ParamTypeDescription
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

PropType
keystring
valuestring
accessibilityAccessibility

Type Aliases

Accessibility

allows to define how properties can be accessed on iOS

'afterFirstUnlock' | 'afterFirstUnlockThisDeviceOnly' | 'whenUnlocked' | 'whenUnlockedThisDeviceOnly' | 'always' | 'alwaysThisDeviceOnly' | 'whenPasscodeSetThisDeviceOnly'

Keywords

FAQs

Last updated on 30 Nov 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc