feat(common): rename hardwareBackedKeystore to secureHardwareNotAvailable

Author: tompsota

README.md

@@ -239,8 +239,8 @@ const actions = {
     console.log('device binding');
   },
   // Android & iOS
-  'hardwareBackedKeystoreNotAvailable': () => {
-    console.log('hardwareBackedKeystoreNotAvailable');
+  'secureHardwareNotAvailable': () => {
+    console.log('secureHardwareNotAvailable');
   },
   // Android & iOS
   'passcode': () => {
@@ -290,7 +290,7 @@ The Security Report is a weekly summary describing the application's security st
 
 The report provides a quick overview of the security incidents, their dynamics, app integrity, and reverse engineering attempts. It contains info about the security of devices, such as OS version or the ratio of devices with screen locks and biometrics. Each visualization also comes with a concise explanation.
 
-To receive Security Reports, fill out the _watcherMail_ field in [config](#step-3-setup-the-configuration-for-your-app).
+To receive Security Reports, fill out the _watcherMail_ field in [config](#configuration).
 
 ![dashboard](https://raw.githubusercontent.com/talsec/Free-RASP-Community/master/visuals/dashboard.png)
 
@@ -423,6 +423,7 @@ Learn more about commercial features at [https://talsec.app](https://talsec.app/
             <td>no</td>
             <td>yes</td>
         </tr>
+        <tr>
          <td colspan=5><strong>Fair usage policy</strong></td>
         </tr>
         <tr>

android/src/main/java/com/freeraspreactnative/FreeraspDeviceStateListener.kt

@@ -14,7 +14,7 @@ internal object FreeraspDeviceStateListener: ThreatListener.DeviceState {
 
   override fun onHardwareBackedKeystoreNotAvailableDetected() {
     "hardwareBackedKeystoreNotAvailable".let {
-      listener?.deviceStateChangeDetected(it)
+      listener?.deviceStateChangeDetected("secureHardwareNotAvailable")
     }
   }
 

example/src/App.tsx

@@ -90,10 +90,10 @@ const App = () => {
       );
     },
     // Android & iOS
-    'hardwareBackedKeystoreNotAvailable': () => {
+    'secureHardwareNotAvailable': () => {
       setAppChecks((currentState) =>
         currentState.map((threat) =>
-          threat.name === 'Hardware Backed Keystore'
+          threat.name === 'Secure Hardware Not Available'
             ? { ...threat, status: 'nok' }
             : threat
         )

example/src/checks.ts

@@ -6,7 +6,7 @@ export const commonChecks = [
   { name: 'Unofficial Store', status: 'ok' },
   { name: 'Hooks', status: 'ok' },
   { name: 'Device Binding', status: 'ok' },
-  { name: 'Hardware Backed Keystore', status: 'ok' },
+  { name: 'Secure Hardware Not Available', status: 'ok' },
   { name: 'Passcode', status: 'ok' },
 ];
 

ios/FreeraspReactNative.swift

@@ -41,15 +41,15 @@ class FreeraspReactNative: RCTEventEmitter {
     }
 
     override func supportedEvents() -> [String]! {
-        return ["initializationError", "started", "privilegedAccess", "debug", "simulator", "appIntegrity", "unofficialStore", "hooks", "device binding", "deviceID", "hardwareBackedKeystoreNotAvailable", "passcodeChange", "passcode"]
+        return ["initializationError", "started", "privilegedAccess", "debug", "simulator", "appIntegrity", "unofficialStore", "hooks", "device binding", "deviceID", "secureHardwareNotAvailable", "passcodeChange", "passcode"]
     }
 }
 
 extension SecurityThreatCenter: SecurityThreatHandler {
     public func threatDetected(_ securityThreat: TalsecRuntime.SecurityThreat) {
         // It is better to implement security reactions (e.g. killing the app) here.
         if (securityThreat.rawValue == "missingSecureEnclave") {
-            FreeraspReactNative.shared!.sendEvent(withName: "hardwareBackedKeystoreNotAvailable", body: "hardwareBackedKeystoreNotAvailable")
+            FreeraspReactNative.shared!.sendEvent(withName: "secureHardwareNotAvailable", body: "secureHardwareNotAvailable")
         } else {
             FreeraspReactNative.shared!.sendEvent(withName: securityThreat.rawValue, body: securityThreat.rawValue)
         }

src/index.tsx

@@ -29,7 +29,7 @@ type NativeEventEmitterActions = {
   'deviceID'?: () => any;
   'passcodeChange'?: () => any;
   'passcode'?: () => any;
-  'hardwareBackedKeystoreNotAvailable'?: () => any;
+  'secureHardwareNotAvailable'?: () => any;
   'started'?: () => any;
   'initializationError'?: (reason: { message: string }) => any;
 };