chore: split index.ts to multiple files and improve docs

README.md

@@ -16,9 +16,6 @@ This library provides access to the Keychain (iOS) and Keystore (Android) for se
 ## Installation
 
 1. Run `yarn add react-native-keychain`
-
-   1 a. **Only for React Native <= 0.59**: `$ react-native link react-native-keychain` and check `MainApplication.java` to verify the package was added. See manual installation below if you have issues with `react-native link`.
-
 2. Run `pod install` in `ios/` directory to install iOS dependencies.
 3. If you want to support FaceID, add a `NSFaceIDUsageDescription` entry in your `Info.plist`.
 4. Re-build your Android and iOS projects.

src/enums.ts

@@ -0,0 +1,124 @@
+import { NativeModules } from 'react-native';
+
+const { RNKeychainManager } = NativeModules;
+
+/**
+ * Enum representing when a keychain item is accessible.
+ */
+export enum ACCESSIBLE {
+  /** The data in the keychain item can be accessed only while the device is unlocked by the user. */
+  WHEN_UNLOCKED = 'AccessibleWhenUnlocked',
+  /** The data in the keychain item cannot be accessed after a restart until the device has been unlocked once by the user. */
+  AFTER_FIRST_UNLOCK = 'AccessibleAfterFirstUnlock',
+  /** The data in the keychain item can always be accessed regardless of whether the device is locked. */
+  ALWAYS = 'AccessibleAlways',
+  /** 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_PASSCODE_SET_THIS_DEVICE_ONLY = 'AccessibleWhenPasscodeSetThisDeviceOnly',
+  /** 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. */
+  WHEN_UNLOCKED_THIS_DEVICE_ONLY = 'AccessibleWhenUnlockedThisDeviceOnly',
+  /** 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. */
+  AFTER_FIRST_UNLOCK_THIS_DEVICE_ONLY = 'AccessibleAfterFirstUnlockThisDeviceOnly',
+}
+
+/**
+ * Enum representing access control options.
+ */
+export enum ACCESS_CONTROL {
+  /** Constraint to access an item with either Touch ID or passcode. */
+  USER_PRESENCE = 'UserPresence',
+  /** Constraint to access an item with Touch ID for any enrolled fingers. */
+  BIOMETRY_ANY = 'BiometryAny',
+  /** Constraint to access an item with Touch ID for currently enrolled fingers. */
+  BIOMETRY_CURRENT_SET = 'BiometryCurrentSet',
+  /** Constraint to access an item with the device passcode. */
+  DEVICE_PASSCODE = 'DevicePasscode',
+  /** Constraint to use an application-provided password for data encryption key generation. */
+  APPLICATION_PASSWORD = 'ApplicationPassword',
+  /** Constraint to access an item with Touch ID for any enrolled fingers or passcode. */
+  BIOMETRY_ANY_OR_DEVICE_PASSCODE = 'BiometryAnyOrDevicePasscode',
+  /** Constraint to access an item with Touch ID for currently enrolled fingers or passcode. */
+  BIOMETRY_CURRENT_SET_OR_DEVICE_PASSCODE = 'BiometryCurrentSetOrDevicePasscode',
+}
+
+/**
+ * Enum representing authentication types.
+ */
+export enum AUTHENTICATION_TYPE {
+  /** Device owner is going to be authenticated by biometry or device passcode. */
+  DEVICE_PASSCODE_OR_BIOMETRICS = 'AuthenticationWithBiometricsDevicePasscode',
+  /** Device owner is going to be authenticated using a biometric method (Touch ID or Face ID). */
+  BIOMETRICS = 'AuthenticationWithBiometrics',
+}
+
+/**
+ * Enum representing security levels.
+ * @platform Android
+ */
+export enum SECURITY_LEVEL {
+  /** Requires for the key to be stored in the Android Keystore, separate from the encrypted data. */
+  SECURE_SOFTWARE = RNKeychainManager &&
+    RNKeychainManager.SECURITY_LEVEL_SECURE_SOFTWARE,
+  /** Requires for the key to be stored on a secure hardware (Trusted Execution Environment or Secure Environment).
+   * Read this article for more information: https://developer.android.com/privacy-and-security/keystore#ExtractionPrevention
+   * */
+  SECURE_HARDWARE = RNKeychainManager &&
+    RNKeychainManager.SECURITY_LEVEL_SECURE_HARDWARE,
+  /** No security guarantees needed (default value). Credentials can be stored in FB Secure Storage. */
+  ANY = RNKeychainManager && RNKeychainManager.SECURITY_LEVEL_ANY,
+}
+
+/**
+ * Enum representing types of biometric authentication supported by the device.
+ */
+export enum BIOMETRY_TYPE {
+  /** Device supports authentication with Touch ID.
+   * @platform iOS
+   */
+  TOUCH_ID = 'TouchID',
+  /** Device supports authentication with Face ID.
+   * @platform iOS
+   */
+  FACE_ID = 'FaceID',
+  /** Device supports authentication with Optic ID.
+   *  @platform visionOS
+   */
+  OPTIC_ID = 'OpticID',
+  /** Device supports authentication with Fingerprint.
+   * @platform Android
+   */
+  FINGERPRINT = 'Fingerprint',
+  /** Device supports authentication with Face Recognition.
+   * @platform Android
+   */
+  FACE = 'Face',
+  /** Device supports authentication with Iris Recognition.
+   * @platform Android
+   */
+  IRIS = 'Iris',
+}
+
+/**
+ * Enum representing storage types.
+ * @platform Android
+ */
+export enum STORAGE_TYPE {
+  /** Facebook compatibility cipher.
+   * @deprecated Facebook Conceal was deprecated and archived in Mar 3, 2020. https://github.com/facebookarchive/conceal
+   */
+  FB = 'FacebookConceal',
+  /** Encryptions without human interaction. */
+  AES = 'KeystoreAESCBC',
+  /** Encryption with biometrics. */
+  RSA = 'KeystoreRSAECB',
+}
+
+/**
+ * Enum representing security rules for storage.
+ * @platform Android
+ */
+export enum SECURITY_RULES {
+  /** No special security rules applied. */
+  NONE = 'none',
+  /** Upgrade secret to the best available storage as soon as it is available and user request secret extraction. Upgrade not applied till we request the secret. This rule only applies to secrets stored with FacebookConseal. */
+  AUTOMATIC_UPGRADE = 'automaticUpgradeToMoreSecuredStorage',
+}