freerasp-react-native 2.0.0 → 2.0.2

package/README.md

@@ -16,12 +16,18 @@ freeRASP for React Native is a mobile in-app protection and security monitoring
   - [Step 2: Set up the dependencies](#step-2-set-up-the-dependencies)
   - [Step 3: Import freeRASP into the app](#step-3-import-freerasp-into-the-app)
   - [Step 4: Setup the configuration, callbacks and initialize freeRASP](#step-4-setup-the-configuration-callbacks-and-initialize-freerasp)
+    - [Configuration](#configuration)
+      - [Dev vs Release version](#dev-vs-release-version)
+    - [Callbacks](#callbacks)
+    - [Initialization](#initialization)
+    - [Alternative: Initialize freeRASP in a Class component](#alternative-initialize-freerasp-in-a-class-component)
   - [Step 5: Additional note about obfuscation](#step-5-additional-note-about-obfuscation)
   - [Step 6: User Data Policies](#step-6-user-data-policies)
 - [Security Report](#security-report)
-- [Enterprise Services](#bar_chart-enterprise-services)
-  - [Commercial version](#commercial-version)
+- [Commercial versions (RASP+ and more)](#bar_chart-commercial-versions-rasp-and-more)
   - [Plans Comparison](#plans-comparison)
+- [About Us](#about-us)
+- [License](#license)
 
 # Overview
 
@@ -60,14 +66,14 @@ Learn more about freemium freeRASP features at [GitHub main repository](https://
 
 # Requirements
 
-Following minimal version requirements has to be met
+Following minimal version requirements have to be met
 in order to run freeRASP in your app:
 
 - `react-native` >= `0.65.3`
 
 # Usage
 
-We will guide you step-by-step, but you can always check the expected result in the example.
+We will guide you step-by-step, but you can always check the expected result in the example folder.
 
 ## (Optional) Create a new React Native demo application
 
@@ -77,11 +83,11 @@ Create a new React Native project:
 
 ## Step 1: Install the plugin
 
-    $ npm install https://github.com/talsec/Free-RASP-ReactNative.git
+    $ npm install freerasp-react-native
 
 or
 
-    $ yarn add https://github.com/talsec/Free-RASP-ReactNative.git
+    $ yarn add freerasp-react-native
 
 ## Step 2: Set up the dependencies
 
@@ -95,9 +101,20 @@ freeRASP React Native plugin uses Pods. Navigate to the `ios` folder and run:
 
     $ pod install
 
+**IMPORTANT:** If you are upgrading from a previous version of freeRASP, please remove the old TalsecRuntime.xcframework and integration script from your project:
+
+1. Open up the **.xcworkspace** file
+1. Go to **Target -> Build Phases -> Link Binary With Libraries**
+1. Remove **TalsecRuntime.xcframework**
+1. On top bar select **Product -> Scheme -> Edit Scheme...**
+1. On the left side select **Build -> Pre-actions**
+1. Find integration script and click trash icon on the right side to remove it
+1. Update freeRASP. If you are getting any errors, check that in `node_modules/freerasp-react-native/ios`, TalsecRuntime.xcframework is a folder, not a symlink. If it is a symlink, remove it and reinstall the module.
+1. run `pod install`
+
 ## Step 3: Import freeRASP into the app
 
-We provide a custom hook that handles all required logic as registration of freeRASP, mounting and unmounting of listeners for you. Import the hook into your app:
+We provide a React Custom Hook that handles all required logic as registration of freeRASP, mounting and unmounting of listeners for you. Import the Hook into your app:
 
 ```ts
 import { useFreeRasp } from 'freerasp-react-native';
@@ -213,10 +230,46 @@ const actions = {
 useFreeRasp(config, actions);
 ```
 
+_Please note that useFreeRasp Hook should be called outside useEffect._
+
 When freeRASP initializes correctly, you should see `freeRASP initialized` message in logs. Otherwise, you'll see warning with description of what went wrong.
 
 _You can override this default behavior by extending the `actions` object with `started` key (to change action after successful initialization), and `initializationError` key (to set up action after unsuccessful initialization)_
 
+### Alternative: Initialize freeRASP in a Class component
+
+- import methods from the freeRASP plugin:
+
+  ```ts
+  import {
+    talsecStart,
+    setThreatListeners,
+    removeThreatListeners,
+  } from 'freerasp-react-native';
+  ```
+
+- override `constructor()` method in the entry point to your app, set listeners to threats and start freeRASP:
+
+  ```ts
+  constructor(props) {
+    super(props);
+
+    // Add these method calls
+    setThreatListeners(actions);
+    talsecStart(config);
+  }
+  ```
+
+  _In this code snippet, `actions` is object with your reactions to threats and `config` is freeRASP configuration object from previous parts of the readme._
+
+- override `componentWillUnmount()` method where you clean up the listeners:
+
+  ```ts
+  componentWillUnmount() {
+    removeThreatListeners();
+  }
+  ```
+
 ## Step 5: Additional note about obfuscation
 
 The freeRASP contains public API, so the integration process is as simple as possible. Unfortunately, this public API also creates opportunities for the attacker to use publicly available information to interrupt freeRASP operations or modify your custom reaction implementation in threat callbacks. In order for freeRASP to be as effective as possible, it is highly recommended to apply obfuscation to the final package/application, making the public API more difficult to find and also partially randomized for each application so it cannot be automatically abused by generic hooking scripts.
@@ -246,6 +299,8 @@ android {
 
 ## Step 6: User Data Policies
 
+See the generic info about freeRASP data collection [here](https://github.com/talsec/Free-RASP-Community/tree/master#data-collection-processing-and-gdpr-compliance).
+
 Google Play [requires](https://support.google.com/googleplay/android-developer/answer/10787469?hl=en) all app publishers to declare how they collect and handle user data for the apps they publish on Google Play. They should inform users properly of the data collected by the apps and how the data is shared and processed. Therefore, Google will reject the apps which do not comply with the policy.
 
 Apple has a [similar approach](https://developer.apple.com/app-store/app-privacy-details/) and specifies the types of collected data.
@@ -265,6 +320,36 @@ If you encounter any other issues, you can see the list of solved issues [here](
 - In `package.json`, update `react-native` to a higher patch version and run `npm install` (or `yarn install`).
 - [See this issue to find out which patch version is relevant for you.](https://github.com/facebook/react-native/issues/35210)
 
+### `Invalid hook call. Hooks can only be called inside of the body of a function component.`
+
+**Reason:**
+The `useFreeRasp` Hook cannot be called inside useEffect.
+
+**Solution:**
+
+- If you want to initialize freeRASP inside useEffect, you have to handle the initialization on your own. Such inititialization would look like this:
+
+```ts
+import {
+  setThreatListeners,
+  talsecStart,
+  removeThreatListeners,
+} from 'freerasp-react-native';
+
+...
+
+useEffect(() => {
+  setThreatListeners(actions);
+  talsecStart(config);
+
+  return () => {
+    removeThreatListeners();
+  };
+}, []);
+```
+
+Where `actions`, `config` are objects described in previous chapters.
+
 # Security Report
 
 The Security Report is a weekly summary describing the application's security state and characteristics of the devices it runs on in a practical and easy-to-understand way.
@@ -275,12 +360,10 @@ To receive Security Reports, fill out the _watcherMail_ field in [config](#confi
 
 ![dashboard](https://raw.githubusercontent.com/talsec/Free-RASP-Community/master/visuals/dashboard.png)
 
-# :bar_chart: Enterprise Services
+# :bar_chart: Commercial versions (RASP+ and more)
 
 We provide app security hardening SDK: i.e. AppiCrypt®, Customer Data Encryption (local storage), End-to-end encryption, Strings protection (e.g. API keys) and Dynamic Certificate Pinning to our commercial customers as well. To get the most advanced protection compliant with PSD2 RT and eIDAS and support from our experts, contact us at [talsec.app](https://talsec.app).
 
-## Commercial version
-
 The commercial version provides a top-notch protection level, extra features, support, and maintenance. One of the most valued commercial features is [AppiCrypt®](https://www.talsec.app/appicrypt) - App Integrity Cryptogram.
 
 It allows easy to implement API protection and App Integrity verification on the backend to prevent API abuse:
@@ -298,6 +381,11 @@ Learn more about commercial features at [https://talsec.app](https://talsec.app/
 
 ## Plans Comparison
 
+<i>
+freeRASP is freemium software i.e. there is a Fair Usage Policy (FUP) that impose some limitations on the free usage. See the FUP section in the table below
+</i>
+<br/>
+<br/>
 <table>
     <thead>
         <tr>
@@ -421,3 +509,13 @@ Learn more about commercial features at [https://talsec.app](https://talsec.app/
 </table>
 
 For further comparison details (and planned features), follow our [discussion](https://github.com/talsec/Free-RASP-Community/discussions/5).
+
+# About Us
+
+Talsec is an academic-based and community-driven mobile security company. We deliver in-App Protection and a User Safety suite for Fintechs. We aim to bridge the gaps between the user's perception of app safety and the strong security requirements of the financial industry.
+
+Talsec offers a wide range of security solutions, such as App and API protection SDK, Penetration testing, monitoring services, and the User Safety suite. You can check out offered products at [our web](https://www.talsec.app).
+
+# License
+
+This project is provided as freemium software i.e. there is a fair usage policy that impose some limitations on the free usage. The SDK software consists of opensource and binary part which is property of Talsec. The opensource part is licensed under the MIT License - see the [LICENSE](https://github.com/talsec/Free-RASP-Community/blob/master/LICENSE) file for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "freerasp-react-native",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "React Native plugin for improving app security and threat monitoring on Android and iOS mobile devices.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",