react-native-keychain-master.zip_React_handd55_keychain_react-na

<p align="center"><img src="https://user-images.githubusercontent.com/378279/36642269-6195b10c-1a3d-11e8-9e1b-37a3d1bcf7b3.png" align="center" width="150" height="201" alt="" /></p> <h1 align="center">react-native-keychain</h1> [](https://travis-ci.org/oblador/react-native-keychain) [](https://npmjs.com/package/react-native-keychain) [](https://npmjs.com/package/react-native-keychain) Keychain/Keystore Access for React Native. ## Installation 1. `$ yarn add react-native-keychain` 2. `$ react-native link react-native-keychain` and check `MainApplication.java` to verify the package was added. 3. Rebuild your project with `react-native run-ios/android` See manual installation below if you have issues with `react-native link`. ## Usage ```js import * as Keychain from 'react-native-keychain'; async () => { const username = 'zuck'; const password = 'poniesRgr8'; // Store the credentials await Keychain.setGenericPassword(username, password); try { // Retreive the credentials const credentials = await Keychain.getGenericPassword(); if (credentials) { console.log('Credentials successfully loaded for user ' + credentials.username); } else { console.log('No credentials stored') } } catch (error) { console.log('Keychain couldn\'t be accessed!', error); } await Keychain.resetGenericPassword() } ``` See `KeychainExample` for fully working project example. Both `setGenericPassword` and `setInternetCredentials` are limited to strings only, so if you need to store objects etc, please use `JSON.stringify`/`JSON.parse` when you store/access it. ### `setGenericPassword(username, password, [{ accessControl, accessible, accessGroup, service }])` Will store the username/password combination in the secure storage. Resolves to `true` or rejects in case of an error. ### `getGenericPassword([{ authenticationPrompt, service }])` Will retreive the username/password combination from the secure storage. Resolves to `{ username, password }` if an entry exists or `false` if it doesn't. It will reject only if an unexpected error is encountered like lacking entitlements or permission. ### `resetGenericPassword([{ service }])` Will remove the username/password combination from the secure storage. ### `setInternetCredentials(server, username, password, [{ accessControl, accessible, accessGroup }])` Will store the server/username/password combination in the secure storage. ### `getInternetCredentials(server, [{ authenticationPrompt }])` Will retreive the server/username/password combination from the secure storage. Resolves to `{ username, password }` if an entry exists or `false` if it doesn't. It will reject only if an unexpected error is encountered like lacking entitlements or permission. ### `resetInternetCredentials(server)` Will remove the server/username/password combination from the secure storage. ### `requestSharedWebCredentials()` (iOS only) Asks the user for a shared web credential. Requires additional setup both in the app and server side, see [Apple documentation](https://developer.apple.com/documentation/security/shared_web_credentials). Resolves to `{ server, username, password }` if approved and `false` if denied and throws an error if not supported on platform or there's no shared credentials. ### `setSharedWebCredentials(server, username, password)` (iOS only) Sets a shared web credential. Resolves to `true` when successful. ### `canImplyAuthentication([{ authenticationType }])` Inquire if the type of local authentication policy is supported on this device with the device settings the user chose. Should be used in combination with `accessControl` option in the setter functions. Resolves to `true` if supported. ### `getSupportedBiometryType()` Get what type of hardware biometry support the device has. Resolves to a `Keychain.BIOMETRY_TYPE` value when supported, otherwise `null`. ### Options | Key | Platform | Description | Default | |---|---|---|---| |**`accessControl`**|iOS only|This dictates how a keychain item may be used, see possible values in `Keychain.ACCESS_CONTROL`. |*None*| |**`accessible`**|iOS only|This dictates when a keychain item is accessible, see possible values in `Keychain.ACCESSIBLE`. |*`Keychain.ACCESSIBLE.WHEN_UNLOCKED`*| |**`accessGroup`**|iOS only|In which App Group to share the keychain. Requires additional setup with entitlements. |*None*| |**`authenticationPrompt`**|iOS only|What to prompt the user when unlocking the keychain with biometry or device password. |`Authenticate to retrieve secret`| |**`authenticationType`**|iOS only|Policies specifying which forms of authentication are acceptable. |`Keychain.AUTHENTICATION_TYPE.DEVICE_PASSCODE_OR_BIOMETRICS`| |**`service`**|All|Reverse domain name qualifier for the service associated with password. |*App bundle ID*| #### `Keychain.ACCESS_CONTROL` enum | Key | Description | |-----|-------------| |**`USER_PRESENCE`**|Constraint to access an item with either Touch ID or passcode.| |**`BIOMETRY_ANY`**|Constraint to access an item with Touch ID for any enrolled fingers.| |**`BIOMETRY_CURRENT_SET`**|Constraint to access an item with Touch ID for currently enrolled fingers.| |**`DEVICE_PASSCODE`**|Constraint to access an item with a passcode.| |**`APPLICATION_PASSWORD`**|Constraint to use an application-provided password for data encryption key generation.| |**`BIOMETRY_ANY_OR_DEVICE_PASSCODE`**|Constraint to access an item with Touch ID for any enrolled fingers or passcode.| |**`BIOMETRY_CURRENT_SET_OR_DEVICE_PASSCODE`**|Constraint to access an item with Touch ID for currently enrolled fingers or passcode.| #### `Keychain.ACCESSIBLE` enum | Key | Description | |-----|-------------| |**`WHEN_UNLOCKED`**|The data in the keychain item can be accessed only while the device is unlocked by the user.| |**`AFTER_FIRST_UNLOCK`**|The data in the keychain item cannot be accessed after a restart until the device has been unlocked once by the user.| |**`ALWAYS`**|The data in the keychain item can always be accessed regardless of whether the device is locked.| |**`WHEN_PASSCODE_SET_THIS_DEVICE_ONLY`**|The 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_ONLY`**|The 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_ONLY`**|The 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_ONLY`**|The 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.| #### `Keychain.AUTHENTICATION_TYPE` enum | Key | Description | |-----|-------------| |**`DEVICE_PASSCODE_OR_BIOMETRICS`**|Device owner is going to be authenticated by biometry or device passcode.| |**`BIOMETRICS`**|Device owner is going to be authenticated using a biometric method (Touch ID or Face ID).| #### `Keychain.BIOMETRY_TYPE` enum | Key | Description | |-----|-------------| |**`TOUCH_ID`**|Device supports authentication with Touch ID.| |**`FACE_ID`**|Device supports authentication with Face ID.| |**`FINGERPRINT`**|Device supports authentication with Android Fingerprint.| ## Manual Installation ### iOS #### 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