expo-secure-store

What is expo-secure-store?

The expo-secure-store package provides a way to securely store key-value pairs in a device's secure storage. This is useful for storing sensitive information such as authentication tokens, user preferences, and other confidential data.

What are expo-secure-store's main functionalities?

Storing a value

This feature allows you to store a key-value pair securely. The `setItemAsync` method takes a key and a value as arguments and stores them in the secure storage.

import * as SecureStore from 'expo-secure-store';

async function save(key, value) {
  await SecureStore.setItemAsync(key, value);
}

Retrieving a value

This feature allows you to retrieve a value stored under a specific key. The `getItemAsync` method takes a key as an argument and returns the corresponding value.

import * as SecureStore from 'expo-secure-store';

async function getValueFor(key) {
  let result = await SecureStore.getItemAsync(key);
  if (result) {
    console.log("🔐 Here's your value 🔐 \n" + result);
  } else {
    console.log('No value stored under that key.');
  }
}

Deleting a value

This feature allows you to delete a key-value pair from the secure storage. The `deleteItemAsync` method takes a key as an argument and removes the corresponding key-value pair from the storage.

import * as SecureStore from 'expo-secure-store';

async function deleteValueFor(key) {
  await SecureStore.deleteItemAsync(key);
}

Other packages similar to expo-secure-store

react-native-keychain

The react-native-keychain package provides similar functionality for securely storing key-value pairs. It supports both iOS and Android and offers additional features such as biometric authentication. Compared to expo-secure-store, react-native-keychain provides more advanced security options but may require more setup.

redux-persist-sensitive-storage

The redux-persist-sensitive-storage package is designed to work with redux-persist to securely store sensitive data. It uses the device's secure storage mechanisms and is a good option if you are already using Redux for state management. Compared to expo-secure-store, it integrates more seamlessly with Redux but is less general-purpose.

secure-store

The secure-store package is another option for securely storing key-value pairs. It is lightweight and easy to use, making it a good alternative to expo-secure-store for simple use cases. However, it may not offer as many features or as much flexibility as expo-secure-store.

README

expo-secure-store

Provides a way to encrypt and securely store key–value pairs locally on the device.

API documentation

• Documentation for the master branch
• Documentation for the latest stable release

Installation

This package is pre-installed in managed Expo projects. You may skip the rest of the installation guide if this applies to you.

For bare React Native projects, you must ensure that you have installed and configured the @unimodules/core package before continuing.

Add the package to your npm dependencies

npm install expo-secure-store

Configure for iOS

Add the dependency to your Podfile and then run pod install.

pod 'EXSecureStore', path: '../node_modules/expo-secure-store/ios'

Configure for Android

1. Append the following lines to android/settings.gradle:

include ':expo-secure-store'
project(':expo-secure-store').projectDir = new File(rootProject.projectDir, '../node_modules/expo-secure-store/android')

1. Insert the following lines inside the dependencies block in android/app/build.gradle:

api project(':expo-secure-store')

1. In MainApplication.java, import the package and add it to the ReactModuleRegistryProvider list:

import expo.modules.expo.modules.securestore.SecureStorePackage;

private final ReactModuleRegistryProvider mModuleRegistryProvider = new ReactModuleRegistryProvider(Arrays.<Package>asList(
  // Your other packages will be here
  new SecureStorePackage()
), Arrays.<SingletonModule>asList());

Contributing

Contributions are very welcome! Please refer to guidelines described in the contributing guide.