@aaxis/react-native-secure-storage 中文文档教程

发布于 3年前 浏览 20 项目主页 更新于 3年前

react-native-secure-storage

这个包基于 react-native-secure-storage 并做了一些定制。

Getting started

$ npm install react-native-secure-storage --save

$ yarn add react-native-secure-storage

Mostly automatic installation

$ react-native link react-native- secure-storage

Manual installation

iOS

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-secure-storage and add RNSecureStorage.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRNSecureStorage.a to your project's Build PhasesLink Binary With Libraries
  4. Run your project (Cmd+R)<

Android

  1. Open up android/app/src/main/java/[...]/MainActivity.java
  • Add import com.aaxis.RNSecureStoragePackage; to the imports at the top of the file
  • Add new RNSecureStoragePackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle: include ':react-native-secure-storage' project(':react-native-secure-storage').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-secure-storage/android')
  2. Insert the following lines inside the dependencies block in android/app/build.gradle: compile project(':react-native-secure-storage')

Usage

import SecureStorage, { ACCESS_CONTROL, ACCESSIBLE, AUTHENTICATION_TYPE } from 'react-native-secure-storage'

async() => {
  const config = {
    accessControl: ACCESS_CONTROL.BIOMETRY_ANY_OR_DEVICE_PASSCODE,
    accessible: ACCESSIBLE.WHEN_UNLOCKED,
    authenticationPrompt: 'auth with yourself',
    service: 'example',
    authenticateType: AUTHENTICATION_TYPE.BIOMETRICS,
  }
  const key = 'someKey'
  await SecureStorage.setItem(key, 'some value', config)
  const got = await SecureStorage.getItem(key, config)
  console.log(got)
}

Methods

这个库现在已经实现了 getItem, setItem, removeItemgetAllKeys 方法 < code>AsyncStorage 来自 React Native。 它不支持回调并将 callback 参数替换为 option 参数。

此外,这个库有一个 getSupportedBiometryType() 方法,它返回一个 BIOMETRY_TYPE 指示设备支持的生物识别类型,以及一个 canCheckAuthentication([{ authenticationType }] ) 方法检查指定的 authenticationType 是否可用。

Options

KeyPlatformDescriptionDefault
accessControliOS onlyThis dictates how a keychain item may be used, see possible values in SecureStorage.ACCESS_CONTROL.None
accessibleiOS onlyThis dictates when a keychain item is accessible, see possible values in SecureStorage.ACCESSIBLE.SecureStorage.ACCESSIBLE.WHEN_UNLOCKED
accessGroupiOS onlyIn which App Group to share the keychain. Requires additional setup with entitlements.None
authenticationPromptiOS onlyWhat to prompt the user when unlocking the keychain with biometry or device password.Authenticate to retrieve secret data
authenticationTypeiOS onlyPolicies specifying which forms of authentication are acceptable.SecureStorage.AUTHENTICATION_TYPE.DEVICE_PASSCODE_OR_BIOMETRICS
serviceAllQualifier for the service.App bundle ID

SecureStorage.ACCESS_CONTROL enum

KeyDescription
USER_PRESENCEConstraint to access an item with either Touch ID or passcode.
BIOMETRY_ANYConstraint to access an item with Touch ID for any enrolled fingers.
BIOMETRY_CURRENT_SETConstraint to access an item with Touch ID for currently enrolled fingers.
DEVICE_PASSCODEConstraint to access an item with a passcode.
APPLICATION_PASSWORDConstraint to use an application-provided password for data encryption key generation.
BIOMETRY_ANY_OR_DEVICE_PASSCODEConstraint to access an item with Touch ID for any enrolled fingers or passcode.
BIOMETRY_CURRENT_SET_OR_DEVICE_PASSCODEConstraint to access an item with Touch ID for currently enrolled fingers or passcode.

SecureStorage.ACCESSIBLE enum

KeyDescription
WHEN_UNLOCKEDThe data in the keychain item can be accessed only while the device is unlocked by the user.
AFTER_FIRST_UNLOCKThe data in the keychain item cannot be accessed after a restart until the device has been unlocked once by the user.
ALWAYSThe data in the keychain item can always be accessed regardless of whether the device is locked.
WHEN_PASSCODE_SET_THIS_DEVICE_ONLYThe data in the keychain can only be accessed when the device is unlocked. Only available if a passcode is set on the device. Items with this attribute never migrate to a new device.
WHEN_UNLOCKED_THIS_DEVICE_ONLYThe data in the keychain item can be accessed only while the device is unlocked by the user. Items with this attribute do not migrate to a new device.
AFTER_FIRST_UNLOCK_THIS_DEVICE_ONLYThe data in the keychain item cannot be accessed after a restart until the device has been unlocked once by the user. Items with this attribute never migrate to a new device.
ALWAYS_THIS_DEVICE_ONLYThe data in the keychain item can always be accessed regardless of whether the device is locked. Items with this attribute never migrate to a new device.

SecureStorage.AUTHENTICATION_TYPE enum

KeyDescription
DEVICE_PASSCODE_OR_BIOMETRICSDevice owner is going to be authenticated by biometry or device passcode.
BIOMETRICSDevice owner is going to be authenticated using a biometric method (Touch ID or Face ID).

SecureStorage.BIOMETRY_TYPE enum

KeyDescription
TOUCH_IDDevice supports authentication with Touch ID.
FACE_IDDevice supports authentication with Face ID.
FINGERPRINTDevice supports authentication with Android Fingerprint.

react-native-secure-storage

This package is based on react-native-secure-storage and did some customized.

Getting started

$ npm install react-native-secure-storage --save

or

$ yarn add react-native-secure-storage

Mostly automatic installation

$ react-native link react-native-secure-storage

Manual installation

iOS

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-secure-storage and add RNSecureStorage.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libRNSecureStorage.a to your project's Build PhasesLink Binary With Libraries
  4. Run your project (Cmd+R)<

Android

  1. Open up android/app/src/main/java/[...]/MainActivity.java
  • Add import com.aaxis.RNSecureStoragePackage; to the imports at the top of the file
  • Add new RNSecureStoragePackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle: include ':react-native-secure-storage' project(':react-native-secure-storage').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-secure-storage/android')
  2. Insert the following lines inside the dependencies block in android/app/build.gradle: compile project(':react-native-secure-storage')

Usage

import SecureStorage, { ACCESS_CONTROL, ACCESSIBLE, AUTHENTICATION_TYPE } from 'react-native-secure-storage'

async() => {
  const config = {
    accessControl: ACCESS_CONTROL.BIOMETRY_ANY_OR_DEVICE_PASSCODE,
    accessible: ACCESSIBLE.WHEN_UNLOCKED,
    authenticationPrompt: 'auth with yourself',
    service: 'example',
    authenticateType: AUTHENTICATION_TYPE.BIOMETRICS,
  }
  const key = 'someKey'
  await SecureStorage.setItem(key, 'some value', config)
  const got = await SecureStorage.getItem(key, config)
  console.log(got)
}

Methods

This library has now implemented getItem, setItem, removeItem and getAllKeys methods of AsyncStorage from React Native. It doesn't support callback and replaced the callback param with an option param.

In addition, this library has a getSupportedBiometryType() method which Returns one of BIOMETRY_TYPE indicating which biometry type the device supports, and a canCheckAuthentication([{ authenticationType }]) method which checks whether the specified authenticationType is available.

Options

KeyPlatformDescriptionDefault
accessControliOS onlyThis dictates how a keychain item may be used, see possible values in SecureStorage.ACCESS_CONTROL.None
accessibleiOS onlyThis dictates when a keychain item is accessible, see possible values in SecureStorage.ACCESSIBLE.SecureStorage.ACCESSIBLE.WHEN_UNLOCKED
accessGroupiOS onlyIn which App Group to share the keychain. Requires additional setup with entitlements.None
authenticationPromptiOS onlyWhat to prompt the user when unlocking the keychain with biometry or device password.Authenticate to retrieve secret data
authenticationTypeiOS onlyPolicies specifying which forms of authentication are acceptable.SecureStorage.AUTHENTICATION_TYPE.DEVICE_PASSCODE_OR_BIOMETRICS
serviceAllQualifier for the service.App bundle ID

SecureStorage.ACCESS_CONTROL enum

KeyDescription
USER_PRESENCEConstraint to access an item with either Touch ID or passcode.
BIOMETRY_ANYConstraint to access an item with Touch ID for any enrolled fingers.
BIOMETRY_CURRENT_SETConstraint to access an item with Touch ID for currently enrolled fingers.
DEVICE_PASSCODEConstraint to access an item with a passcode.
APPLICATION_PASSWORDConstraint to use an application-provided password for data encryption key generation.
BIOMETRY_ANY_OR_DEVICE_PASSCODEConstraint to access an item with Touch ID for any enrolled fingers or passcode.
BIOMETRY_CURRENT_SET_OR_DEVICE_PASSCODEConstraint to access an item with Touch ID for currently enrolled fingers or passcode.

SecureStorage.ACCESSIBLE enum

KeyDescription
WHEN_UNLOCKEDThe data in the keychain item can be accessed only while the device is unlocked by the user.
AFTER_FIRST_UNLOCKThe data in the keychain item cannot be accessed after a restart until the device has been unlocked once by the user.
ALWAYSThe data in the keychain item can always be accessed regardless of whether the device is locked.
WHEN_PASSCODE_SET_THIS_DEVICE_ONLYThe data in the keychain can only be accessed when the device is unlocked. Only available if a passcode is set on the device. Items with this attribute never migrate to a new device.
WHEN_UNLOCKED_THIS_DEVICE_ONLYThe data in the keychain item can be accessed only while the device is unlocked by the user. Items with this attribute do not migrate to a new device.
AFTER_FIRST_UNLOCK_THIS_DEVICE_ONLYThe data in the keychain item cannot be accessed after a restart until the device has been unlocked once by the user. Items with this attribute never migrate to a new device.
ALWAYS_THIS_DEVICE_ONLYThe data in the keychain item can always be accessed regardless of whether the device is locked. Items with this attribute never migrate to a new device.

SecureStorage.AUTHENTICATION_TYPE enum

KeyDescription
DEVICE_PASSCODE_OR_BIOMETRICSDevice owner is going to be authenticated by biometry or device passcode.
BIOMETRICSDevice owner is going to be authenticated using a biometric method (Touch ID or Face ID).

SecureStorage.BIOMETRY_TYPE enum

KeyDescription
TOUCH_IDDevice supports authentication with Touch ID.
FACE_IDDevice supports authentication with Face ID.
FINGERPRINTDevice supports authentication with Android Fingerprint.
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文