redux-persist-encrypted-storage

Well known and trusted React Native Encrypted Storage based redux-persist Storage Engine.

This library is using the well known and trusted React Native Encrypted Storage library under the hood to store your data in a secure way. According to the developers, react native encrypted storage uses a wrapper around Android's EncryptedSharedPreferences and iOS' Keychain and developed with the support for TypeScript.

Installation

Ensure to install the react-native-encrypted-storage library as a dependency. Check the installation guide.

And also install the redux-persist-encrypted-storage library.

1yarn add redux-persist-encrypted-storage
2# or
3npm install --save redux-persist-encrypted-storage

Usage

Use as a redux-persist global storage engine:

1import createSecuredStorage from "redux-persist-encrypted-storage";
2
3import { createStore } from "redux";
4import { persistStore, persistCombineReducers } from "redux-persist";
5import reducers from "./reducers";
6
7// Secured storage
8const secureStorage = createSecuredStorage();
9
10const config = {
11  key: "encrypted",
12  secureStorage
13};
14
15const reducer = persistCombineReducers(config, reducers);
16
17function configureStore() {
18  // ...
19  const store = createStore(reducer);
20  const persistor = persistStore(store);
21
22  return { persistor, store };
23}

Use as a separate engine for a subset of your reducers:

1import createSecuredStorage from "redux-persist-encrypted-storage";
2
3import { combineReducers } from "redux";
4import { persistReducer } from "redux-persist";
5import AsyncStorage from "@react-native-async-storage/async-storage";
6
7import { mainReducers, securedReducers } from "./reducers";
8
9// Secure storage configurations
10const secureStorage = createSecuredStorage();
11const securePersistConfig = {
12  key: "secure",
13  storage: secureStorage
14};
15
16// Non-secure storage configurations
17const mainPersistConfig = {
18  key: "main",
19  storage: AsyncStorage
20};
21
22// Combine both reducers into one root reducer
23const rootReducer = combineReducers({
24  insecure: persistReducer(mainPersistConfig, mainReducers),
25  secure: persistReducer(securePersistConfig, secureReducers)
26});
27
28function configureStore() {
29  let store = createStore(rootReducer);
30  let persistor = persistStore(store);
31
32  return { persistor, store };
33}

Caveat

Keys for the Encrypted Storage only support [A-Za-z0-9.-_], meaning all other characters are replaced by an internal replacer function (defaults to _).

Note

Inspired by redux-persist-expo-securestore.