added more documentation

Author: mCodex

website/docs/android_options.md

@@ -0,0 +1,37 @@
+---
+id: android_options
+title: Android
+sidebar_label: Android
+---
+
+Android specific configurations
+
+## showModal & strings
+
+When `showModal` is `true`, an Android native prompt will show up asking for user's authentication. This behavior is similar to that of iOS.
+
+You can control strings associated with a modal prompt via `strings` option:
+
+```javascript
+strings: {
+    header: 'Sign in',
+    description: 'Place finger to authenticate',
+    hint: 'Touch',
+    success: 'Fingerprint recognized',
+    notRecognized: 'Fingerprint not recognized, try again',
+    cancel: 'Cancel',
+    cancelled: 'Authentication was cancelled', // reject error message
+}
+```
+
+## setInvalidatedByBiometricEnrollment
+
+If you want to control the behaviour on android when new fingers are enrolled or removed on the device on any device with API level greater than 24. You should call during the initialization of your app to the function `setInvalidatedByBiometricEnrollment`. This will re-initialise the internal android Key generator with the flag set to keep/invalidate the credentials upon fingers change.
+
+```javascript
+import SInfo from 'react-native-sensitive-info';
+
+SInfo.setInvalidatedByBiometricEnrollment(false);
+```
+
+[You can check out more here](https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.Builder#setInvalidatedByBiometricEnrollment(boolean))

website/docs/deleteItem.md

@@ -0,0 +1,11 @@
+---
+id: deleteItem
+title: deleteItem
+sidebar_label: deleteItem
+---
+
+**WIP**
+
+In the meantime checkout our **[README](https://github.com/mCodex/react-native-sensitive-info#methods)** for further information.
+
+Wanna help? Just send a PR 😉

website/docs/getAllItems.md

@@ -0,0 +1,11 @@
+---
+id: getAllItems
+title: getAllItems
+sidebar_label: getAllItems
+---
+
+**WIP**
+
+In the meantime checkout our **[README](https://github.com/mCodex/react-native-sensitive-info#methods)** for further information.
+
+Wanna help? Just send a PR 😉

website/docs/getItem.md

@@ -0,0 +1,11 @@
+---
+id: getItem
+title: getItem
+sidebar_label: getItem
+---
+
+**WIP**
+
+In the meantime checkout our **[README](https://github.com/mCodex/react-native-sensitive-info#methods)** for further information.
+
+Wanna help? Just send a PR 😉

website/docs/installation.md

@@ -6,11 +6,11 @@ sidebar_label: Installation
 
 First of all, install it using `npm` or `yarn`
 
-```
+```bash
 npm install --save react-native-sensitive-info
 ```
 
-```
+```bash
 yarn add react-native-sensitive-info
 ```
 
@@ -22,21 +22,21 @@ yarn add react-native-sensitive-info
 
 Should be automatically linked when you run:
 
-```
+```bash
 pod install
 ```
 
 Then:
 
-```
+```bash
 yarn ios
 ```
 
 #### Android
 
 Should be automatically linked when you run:
 
-```
+```bash
 yarn android
 ```
 
@@ -46,7 +46,7 @@ yarn android
 
 ##### Using cocoapods
 
-```
+```pod
 pod 'react-native-sensitive-info', path: "../node_modules/react-native-sensitive-info"
 ```
 
@@ -69,21 +69,21 @@ In XCode, in the project navigator, select your project.
 
 Go to `settings.gradle` inside your android project folder and paste this lines there:
 
-```
+```java
 include ':react-native-sensitive-info'
 
 project(':react-native-sensitive-info').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-sensitive-info/android')
 ```
 
 and paste it into build.gradle:
 
-```
+```java
 compile project(':react-native-sensitive-info')
 ```
 
 In your` MainApplication.java` add:
 
-```
+```java
 import br.com.classapp.RNSensitiveInfo.RNSensitiveInfoPackage; //<- You must import this
 
 protected List<ReactPackage> getPackages() {
@@ -104,7 +104,7 @@ protected List<ReactPackage> getPackages() {
 * Check the RNSensitiveInfo you just added and press Ok
 * Open MainPage.cs in your app
 
-```
+```c#
 using RNSqlite2;
 
 get

website/docs/ios_options.md

@@ -0,0 +1,55 @@
+---
+id: ios_options
+title: iOS
+sidebar_label: iOS
+---
+
+## touchID
+
+Enable touchID support.
+
+```javascript
+SInfo.setItem('key1', 'value1', {
+  ...
+  touchID: true,
+});
+
+```
+
+## kSecAccessControl
+
+When passing in the [touchID](#touchID) option as `true`, you can also set `kSecAccessControl`. For example:
+
+
+```javascript
+SInfo.setItem('key1', 'value1', {
+  keychainService: 'myKeychain',
+  kSecAccessControl: 'kSecAccessControlTouchIDCurrentSet',
+  sharedPreferencesName: 'mySharedPrefs',
+  touchID: true,
+});
+```
+
+**Note:** By default `kSecAccessControl` will get set to `kSecAccessControlUserPresence`.
+
+## kSecAttrSynchronizable
+
+You can set this to `true` in order to sync the keychain items with iCloud.
+
+**Note:** By default `kSecAttrSynchronizable` will get set to `false`.
+
+## kLocalizedFallbackTitle
+
+You can set this to a string and fallback to pin code authentication.
+
+## Enable Face ID
+
+To enable Face ID, for iOS X and above or iPad Pro, set `kSecAccessControl` to `kSecAccessControlBiometryAny`. For example:
+
+```javascript
+SInfo.setItem('key1', 'value1', {
+  keychainService: 'myKeychain',
+  kSecAccessControl: 'kSecAccessControlBiometryAny',
+  ...
+});
+```

website/docs/overview.md

@@ -8,4 +8,35 @@ RNSInfo is an open-source library developed by many contributors since 2016. ❤
 
 Securing sensitive data is very important in production-ready applications. So, this is why RNSInfo was created for, to help you focus in what matters most, your application. 😉
 
-Handling sensitive data couldn't be easier in React-Native apps. 
+Handling sensitive data couldn't be easier in React-Native apps. 
+
+## Demo
+
+```javascript
+import SInfo from 'react-native-sensitive-info';
+
+SInfo.setItem('key1', 'value1', {
+sharedPreferencesName: 'mySharedPrefs',
+keychainService: 'myKeychain'
+}).then((value) =>
+        console.log(value) //value 1
+);
+
+SInfo.setItem('key2', 'value2', {});
+
+SInfo.getItem('key1', {
+sharedPreferencesName: 'mySharedPrefs',
+keychainService: 'myKeychain'}).then(value => {
+    console.log(value) //value1
+});
+
+SInfo.getItem('key2',{}).then(value => {
+    console.log(value) //value2
+});
+
+SInfo.getAllItems({
+sharedPreferencesName: 'mySharedPrefs',
+keychainService: 'myKeychain'}).then(values => {
+    console.log(values) //value1, value2
+});
+```

website/docs/security.md

@@ -0,0 +1,11 @@
+---
+id: security
+title: Security
+sidebar_label: Security
+---
+
+Jailbroken/Rooted devices can access your iOS' Keystore and Android's shared preferences/keystore in plain text, so it is necessary to add another layer of protection.
+
+- **iOS:** it is implemented through [Access Control](https://developer.apple.com/documentation/security/secaccesscontrol). Everytime the app wants to access the protected keychain item, a prompt by iOS will show up. Only after authentication success will return the requested item.
+
+- **Android** it is implemented through [FingerprintManager](https://developer.android.com/reference/android/hardware/fingerprint/FingerprintManager.html) + Keystore. Keystore has a function called `setUserAuthenticationRequired` which makes Keystore requires user authentication before getting value. However, Android doesn't nicely asks user to scan their finger, it just throws error this is why FingerprintManager comes in. However (AGAIN), FingerprintManager doesn't prompt automatically for you, so you need to build UI yourself to let user to know that it is time to scan his/her fingerprint.

website/sidebars.js

@@ -1,11 +1,15 @@
 module.exports = {
   someSidebar: {
-    Introduction: ['overview', 'installation'],
+    Introduction: ['overview', 'installation', 'security'],
     API: [
+      'deleteItem',
+      'getAllItems',
+      'getItem',
       'hasEnrolledFingerprints',
       'isHardwareDetected',
       'isSensorAvailable',
       'setItem',
     ],
+    Options: ['android_options', 'ios_options']
   },
 };