react-native-keychain

What is react-native-keychain?

The react-native-keychain package provides a secure way to store and retrieve sensitive information such as passwords, tokens, and other credentials in a React Native application. It leverages the native keychain services on iOS and the Keystore system on Android to ensure data is stored securely.

What are react-native-keychain's main functionalities?

Storing Credentials

This feature allows you to securely store a username and password in the device's keychain or keystore.

import * as Keychain from 'react-native-keychain';

async function saveCredentials(username, password) {
  await Keychain.setGenericPassword(username, password);
}

Retrieving Credentials

This feature allows you to retrieve stored credentials from the device's keychain or keystore.

import * as Keychain from 'react-native-keychain';

async function getCredentials() {
  const credentials = await Keychain.getGenericPassword();
  if (credentials) {
    console.log('Credentials successfully loaded for user ' + credentials.username);
  } else {
    console.log('No credentials stored');
  }
}

Resetting Credentials

This feature allows you to reset or delete the stored credentials from the device's keychain or keystore.

import * as Keychain from 'react-native-keychain';

async function resetCredentials() {
  await Keychain.resetGenericPassword();
}

Storing Internet Credentials

This feature allows you to securely store internet credentials (e.g., server, username, password) in the device's keychain or keystore.

import * as Keychain from 'react-native-keychain';

async function saveInternetCredentials(server, username, password) {
  await Keychain.setInternetCredentials(server, username, password);
}

Retrieving Internet Credentials

This feature allows you to retrieve stored internet credentials from the device's keychain or keystore.

import * as Keychain from 'react-native-keychain';

async function getInternetCredentials(server) {
  const credentials = await Keychain.getInternetCredentials(server);
  if (credentials) {
    console.log('Internet credentials successfully loaded for server ' + server);
  } else {
    console.log('No internet credentials stored for server ' + server);
  }
}

Other packages similar to react-native-keychain

react-native-sensitive-info

react-native-sensitive-info is another package that provides secure storage for sensitive information in React Native applications. It supports storing data in the Android Keystore and iOS Keychain, similar to react-native-keychain. However, it also offers additional features like encryption and the ability to store data in shared preferences or user defaults.

react-native-secure-storage

react-native-secure-storage is a package that provides secure storage for sensitive data in React Native applications. It uses the Android Keystore and iOS Keychain for secure storage, similar to react-native-keychain. It also supports encryption and offers a simple API for storing and retrieving data.

react-native-encrypted-storage

react-native-encrypted-storage is a package that provides secure and encrypted storage for sensitive data in React Native applications. It uses the Android Keystore and iOS Keychain for secure storage, similar to react-native-keychain. It also offers encryption and decryption of data, ensuring that sensitive information is stored securely.

README

react-native-keychain

Keychain Access for React Native

Currently functionality is limited to just storing internet and generic passwords.

Installation

$ npm install react-native-keychain

Option: Manually

• Right click on Libraries, select Add files to "…" and select node_modules/react-native-keychain/RNKeychain.xcodeproj
• Select your project and under Build Phases -> Link Binary With Libraries, press the + and select libRNKeychain.a.

Option: With CocoaPods

Add the following to your Podfile and run pod update:

pod 'RNKeychain', :path => 'node_modules/react-native-keychain'

Usage

See KeychainExample for fully working project example.

var Keychain = require('react-native-keychain');

var username = 'zuck';
var password = 'poniesRgr8';

// Generic Password, service argument optional
Keychain
  .setGenericPassword(username, password)
  .then(function() {
    console.log('Credentials saved successfully!');
  });

Keychain
  .getGenericPassword()
  .then(function(credentials) {
    console.log('Credentials successfully loaded for user ' + credentials.username);
  });

Keychain
  .resetGenericPassword()
  .then(function() {
    console.log('Credentials successfully deleted');
  });

// Internet Password, server argument required
var server = 'http://facebook.com';
Keychain
  .setInternetCredentials(server, username, password)
  .then(function() {
    console.log('Credentials saved successfully!');
  });

Keychain
  .getInternetCredentials(server)
  .then(function(credentials) {
    console.log('Credentials successfully loaded for user ' + credentials.username);
  });

Keychain
  .resetInternetCredentials(server)
  .then(function() {
    console.log('Credentials successfully deleted');
  });

Todo

• iOS support
• Android support
• Storing objects as JSON
• Expose wider selection of underlying native APIs

License

MIT © Joel Arvidsson 2015