react-native-trustdevice 0.1.5 → 1.1.1

package/README.md

@@ -6,107 +6,110 @@ Please note that when integrating SDK products provided by the TrustDecision in
 
 1.1 According to the user's information protection regulations, before your users start the App for the first time and start collecting information, your company should fully inform the user of the purpose, method, and scope of collecting, using, and sharing the user's personal information with a third party through an interactive interface or design (such as a pop-up window of the privacy policy), and obtain the express consent of the end user.
 
-1.2 To provide business security and risk control services to your company, the TrustDecision SDK will collect, process, and use the identification information（IMEI/IDFA）, AndroidID, IMSI, MEID, MAC address, SIM card serial number, device type, device model, system type, geographical location, login IP address, application list, running process, sensor information(light sensor, gravity sensor, magnetic field sensor, acceleration sensor, gyroscope sensor) and other device information of the user's device. To ensure compliance with your use of related services, the aforementioned privacy policy should cover the authorization of TrustDecision SDK to provide services and collect, process, and use relevant information. The following terms are for your reference. The specific expression can be determined by your company according to the overall framework and content of your privacy agreement:
+1.2 To provide business security and risk control services to your company, the TrustDecision SDK will collect, process, and use the identification information IDFA, AndroidID, OAID, MAC address, Wireless IP address, WIFI list, wireless router identification (BSSID, SSID),device type, device model, system type, geographical location(Rough location information, precise location information), login IP address and other device information of the user's device. To ensure compliance with your use of related services, the aforementioned privacy policy should cover the authorization of TrustDecision SDK to provide services and collect, process, and use relevant information. The following terms are for your reference. The specific expression can be determined by your company according to the overall framework and content of your privacy agreement:
 
 <table border="1">
     <tr>
-        <td style="background-color:#FAFAFA"><font size="2">TrustDecision SDK: For business security and risk control, our company uses the TrustDecision SDK. The SDK needs to obtain the information of your devices, such as （IMEI/IDFA）, AndroidID, IMSI, MAC address, SIM card serial number, device type, device model, system type, geographic location, login IP address, application list, running process, sensor information(light sensor, gravity sensor, magnetic field sensor, acceleration sensor, gyroscope sensor) and other related device information, for fraud risk identification.</font></td>
+        <td style="background-color:#FAFAFA"><font size="2">TrustDecision SDK: For business security and risk control, our company uses the TrustDecision SDK. The SDK needs to obtain the information of your devices, such as IDFA, AndroidID, OAID, GAID,MAC address, Wireless IP address, WIFI list, wireless router identification (BSSID, SSID),device type, device model, system type, geographical location(Rough location information, precise location information), login IP address, application list, running process, network type,device software version,sensor information(light sensor, gravity sensor, magnetic field sensor, acceleration sensor, gyroscope sensor) and other related device information, for fraud risk identification.</font></td>
     </tr>
 </table>
 
-**Privacy Protocol:**  [https://www.trustdecision.com/legal/privacy-policy](https://www.trustdecision.com/legal/privacy-policy)
+**Privacy Protocol:**  <https://www.trustdecision.com/legal/privacy-policy>
 
-**Precautions**
+## Environment
 
-When the installation starts for the first time, the SDK initialization is performed after the user agrees with the privacy agreement.
-Avoid SDK initialization collection without the user agreeing to the privacy agreement, causing compliance risk accidents.
+|                           | Android                              | iOS                |
+| ------------------------- | ------------------------------------ | :----------------- |
+| Supported System Versions | Android 5.0 and above                | iOS 9.0 and above  |
+| Supported Architectures   | armeabi, armeabi-v7a, arm64-v8a, x86 | armv7,arm64,x86_64 |
 
+# Integrate
 
-# Integrate Steps
+## Install
 
-## Integrated SDK
+### Plugin Install
 
-Execute in your react native project root directory
+Please execute in your react native project root directory
 
+```shell
+  npm install --save react-native-trustdevice@1.1.1
 ```
 
-npm install --save react-native-trustdevice@0.1.5
-
-```
-
-### Android
-
-### iOS
-
-Update cocoapods
-
-```
-npx pod-install
-```
-
-## Android permission application
+### AndroidManifest.xml
 
 Declare the following permissions in the AndroidManifest.xml file under the application module
 
 ```xml
 <manifest>
-   <!--Compulsory permissions-->
+   <!-- required -->
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
+  <!-- Outside the Chinese Mainland -->
+  <uses-permission android:name="com.google.android.gms.permission.AD_ID"/>
 
-   <!--The following permissions are optional. If this part of the authority is not declared, the acquisition of some device information will be abandoned, which will have a certain effect on data analysis and the accuracy of the fingerprint of the device fingerprint-->
-   <uses-permission android:name="com.google.android.gms.permission.AD_ID"/>
-   <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+   <!--optional, If not declared, some device information will be abandoned -->
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
+   <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
    <uses-permission android:name="android.permission.READ_PHONE_STATE" />
-   <!-- This permission is required for Android 11 and above to obtain the installation package list. Collecting the installation package list involves risk and compliance. Whether this permission is required is optional for the business party
-select -->
-   <uses-permission android:name="android.permission.QUERY_ALL_PACKAGES"/>
+   <!-- required for Android 11 and above to obtain the installed packages -->
+   <uses-permission android:name="android.permission.QUERY_ALL_PACKAGES"
+        tools:ignore="QueryAllPackagesPermission" />
 </manifest>
 ```
 
-Dynamic application permissions: Android 6.0 or above requires dynamic application permissions. Dynamic application permissions code must be placed before the initial 
+### Permissions
+
+| Name                               | Description                                                                                       |
+| ---------------------------------- | ------------------------------------------------------------------------------------------------- |
+| **INTERNET**(required)             | Allows the app to access the network connection and send requests to communicate with the server. |
+| **ACCESS_NETWORK_STATE**(required) | Collect network connection status information.                                                    |
+| **ACCESS_WIFI_STATE**(required)    | Collect the current WiFi access status and WLAN hotspot information.                              |
+| **AD_ID**(required)                | Collect the Google advertising ID, required outside the Chinese Mainland.                         |
+| ACCESS_COARSE_LOCATION             | Get location information, with an accuracy of approximately 30 to 1500 meters.                    |
+| ACCESS_FINE_LOCATION               | Get location information, with positioning accuracy within 10 meters.                             |
+| READ_PHONE_STATE                   | Collect information on SIM card                                                                   |
+| QUERY_ALL_PACKAGES                 | Collect installed packages                                                                        |
 
 ## Initialization
 
+### Cautions
 
-## get TrustDevice Module
+- Ensure that it is initialized after the user agrees to the privacy agreement.
 
+### Definition
 
+```tsx
+   async function initWithOptions(options: {[key: string]: any})
 ```
-  const TrustDevice = NativeModules.TrustDevice;
 
+## Get blackBox
+
+### Cautions
+
+- Call `getBlackBox` after `initWithOptions`.
+- Don't cache blackBox returned by getBlackBox in the app. Please rely on this function to get blackBox.
+
+### Definition
+
+```tsx
+  // get by synchronous call 
+  async function getBlackBox();
+  // get by asynchronous call
+  async function getBlackBoxAsync();
 ```
 
-**Sample Code**
+## Best Practices
 
-```dart
-import 'package:trustdevice_pro_plugin/trustdevice_pro_plugin.dart';
-// ...
+1. Get TrustDevice Module
 
-// Initialization
-class _MyAppState extends State<MyApp> {
-  final _trustdeviceProPlugin = TrustdeviceProPlugin();
-  @override
-  void initState() {
-    super.initState();
-    _initWithOptions();
-  }
-  //initialize the configuration
-  Future<void> _initWithOptions() async {
-    var options = {
-            "partner": "[Your partner]",
-            "appKey": "[Your appKey]",
-            "appName": "[Your appName]",
-            "country": "[Your country code]",
-        };
-     _trustdeviceProPlugin.initWithOptions(options);
-  }
-  // ...
-}
+```tsx
+  const TrustDevice = NativeModules.TrustDevice;
+```
 
+2. Initialize and get blackBox
 
+```tsx
   async function initWithOptions() {
 
     var options = {
@@ -124,260 +127,54 @@ class _MyAppState extends State<MyApp> {
     }
 
      TrustDevice.initWithOptions(options);
+     const blackBox = await TrustDevice.getBlackBoxAsync()
   }
-
-
 ```
 
-**Required Configuration**
-
-<table>
-  <tr>
-    <th>Key</th>
-    <th>Definition</th>
-    <th>Description</th>
-    <th>Platform</th>
-    <th>Sample code</th>
-  </tr>
-  <tr>
-    <td>partner</td>
-    <td>Partner code </td>
-    <td>Partner, please contact TrustDecision to obtain</td>
-    <td>All</td>
-    <td>
-    options["partner"] = "[Your partner]"
-    </td>
-  </tr>
-  <tr>
-    <td>appKey</td>
-    <td>App key</td>
-    <td>Appkey, please offer your App bundleId for TrustDecision to obtain<br>
-    appkey creation requires the user to provide the application bundleId.<br>
-    ⚠️ Different values for bundleId are used for different applications
-    </td>
-    <td>All</td>
-    <td>
-   options["appKey"] = "[Your appKey]"
-   </td>
-  </tr>
-  <tr>
-    <td>appName</td>
-    <td>App name</td>
-    <td>AppName, please contact TrustDecision to obtain</td>
-    <td>All</td>
-    <td>
-    options["appName"] = "[Your appName]"
-   </td>
-  </tr>
-  <tr>
-    <td>country</td>
-    <td> Country code</td>
-    <td> cn: means China;<br>sg: means Singapore;<br>us: means North America;<br>fra: means Europe</td>
-    <td>All</td>
-    <td>
-    options["country"] = "[Your country code]"
-   </td>
-  </tr>
-</table>
-
-
-## Get SDK Version
+3. Obtain blackBox in actual business scenarios
 
-Sample Code
-
-```dart
-// Get SDK Version
-  async function getSDKVersion() {
-    const version = await TrustDevice.getSDKVersion();
-    console.log(version);
-  }
-```
-
-## Other Instructions
-
-Android obfuscated packaging If developers need to use proguard for obfuscated packaging, please add the following code to the proguard configuration file:
-
-```java
--keep class cn.tongdun.**{*;}
-```
-
-# Fingerprint
-
-## initWithOptions Optional Parameter
-
-<table>
-  <tr>
-    <th>Key</th>
-    <th>Definition</th>
-    <th>Description</th>
-    <th>Platform</th>
-    <th>Sample code</th>
-  </tr>
-  <tr>
-    <td>debug</td>
-    <td>Whether allow debug</td>
-    <td>default is false,After the SDK is integrated, the app has the anti-debugging function by default. <br><b>Develop: </b>Please set value to true.<br><b>Release: </b>Please not set this key or set value to false <br><b>Options:</b><br>true: allow debug;<br>false: not allow debug</td>
-    <td>All</td>
-    <td>
-    options["debug"] = true
-   </td>
-  </tr>
-  <tr>
-    <td>timeLimit</td>
-    <td>SDK timeout interval Configuration (unit: seconds)</td>
-    <td>Timeout interval of network request callback after SDK initialization. Default is 15s.</td>
-    <td>All</td>
-    <td>
-    options["timeLimit"] = 5
-    </td>
-  </tr>
-  <tr>
-    <td>location</td>
-    <td>Whether collect location information</td>
-    <td>default is true,SDK will collect location if the app has been authorized to get location information. <br><b>Options:</b><br>true: allow collect location information;<br>false: not allow collect location information</td>
-    <td>All</td>
-    <td>
-    options["location"] = true
-    </td>
-  </tr>
-  <tr>
-    <td>collectLevel</td>
-    <td>Degraded blackbox length configuration</td>
-    <td>Degraded blackbox will be longer. This configuration allows you to control the length of the degraded blackbox. <br><b>Options:</b><br>"M": After setting, the degraded blackbox length is about 2000 characters;<br>"L": default value, after setting, the degraded length is about 5000 characters</td>
-    <td>All</td>
-    <td>
-    options["collectLevel"] = "M"
-    </td>
-  </tr>
-  <tr>
-    <td>IDFA</td>
-    <td>Whether collect Advertising Identifier (IDFA) information</td>
-    <td>default is true,SDK will collect IDFA information if the app has been authorized to get IDFA information. <br><b>Options:</b><br>true: allow collect IDFA information;<br>false: not allow collect IDFA information</td>
-    <td>iOS</td>
-    <td>
-    options["IDFA"] = true
-    </td>
-  </tr>
-  <tr>
-    <td>deviceName</td>
-    <td>Whether collect device's name information</td>
-    <td>default is true,SDK will collect device's name information. <br><b>Options:</b><br>true: allow collect device's name information;<br>false: not allow collect device's name information</td>
-    <td>iOS</td>
-    <td>
-    options["deviceName"] = true
-    </td>
-  </tr>
-  <tr>
-    <td>blackBoxMaxSize</td>
-    <td>blackbox maximum length</td>
-    <td>The default length is Integer.MAX_VALUE, it will increase according to the actual device situation </td>
-    <td>Android</td>
-    <td>
-    options["blackBoxMaxSize"] = 3000
-   </td>
-  </tr>
-  <tr>
-    <td>customProcessName</td>
-    <td>custom process name</td>
-    <td>change the name of the SDK's process</td>
-    <td>Android</td>
-    <td>
-    options["customProcessName"] = "td"
-    </td>
-  </tr>
-  <tr>
-    <td>forceTLSVersion</td>
-    <td>Whether https is mandatory to use TLS-v1.1 version</td>
-    <td>default is false, and the developer can set the corresponding settings according to the specific situation. <br><b>Options:</b><br>true: use TLS-v1.1 version;<br>false: not use TLS-v1.1 version</td>
-    <td>Android</td>
-    <td>
-    options["forceTLSVersion"] = true
-  </td>
-  </tr>
-  <tr>
-    <td>runningTasks</td>
-    <td>Whether allow getting running tasks</td>
-    <td>default is true. <br><b>Options:</b><br>true: allow getting running tasks;<br>false: not allow getting running tasks</td>
-    <td>Android</td>
-    <td>
-     options["runningTasks"] = true
-  </td>
-  </tr>
-  <tr>
-    <td>sensor</td>
-    <td>Whether collect sensor information</td>
-    <td>default is true,SDK will collect sensor-related information. <br><b>Options:</b><br>true: collect sensor information;<br>false: not collect sensor information</td>
-    <td>Android</td>
-    <td>
-    options["sensor"] = true
-   </td>
-  </tr>
-  <tr>
-    <td>readPhone</td>
-    <td>Whether collect READ_PHONE_STATE related information</td>
-    <td>default is true,SDK will collect READ_PHONE_STATE information if app gained READ_PHONE_STATE permission<br><b>Options:</b><br>true: collect READ_PHONE_STATE related information;<br>false: not collect READ_PHONE_STATE related information</td>
-    <td>Android</td>
-    <td>
-    options["readPhone"] = true
-  </td>
-  <tr>
-    <td>installPackageList</td>
-    <td>Whether collect the list of installation packages</td>
-    <td>default is true,SDK will collect the list of installation packages.
-    <br><b>Options:</b><br>true: collect the list of installation packages;<br>false: not collect the list of installation packages</td>
-    <td>Android</td>
-    <td>
-    options["installPackageList"] = true
-  </td>
-  </tr>
-</table>
-
-
-## Get Blackbox
-
-**Attention**
-
-- Please `getBlackBox` after `initWithOptions`,  otherwise SDK exceptions will be caused.
-- We suggest that developers do not cache the results returned by `getBlackBox` in the app. Please rely on this function to get blackbox.
-
-### Synchronous method getBlackBox
-
-#### Usage Scenario Description
-
-**Advantages:** The blackBox will be returned immediately, not affected by the network status;<br/> **Disadvantages:** After the device fingerprint SDK is integrated, if the non-degraded blackBox has not been obtained before, it will return to the degraded blackBox will increase the amount of data uploaded by the subsequent query interface, and the data size is about 5000 bytes;<br/>**Applicable scenarios:** Scenes where blackBox needs to be obtained immediately;<br/>
-
-**Sample Code**
-
-```
-  async function getBlackBox() {
+```tsx
+  async function register() {
     const blackBox = await TrustDevice.getBlackBox()
-    console.log(blackBox);
+    // ...
   }
 ```
 
-### Asynchronous method getBlackBoxAsync
-
+## Status Check
 
-#### Usage Scenario Description
+1. getBlackBox() will return a 26-bit string while initialization successfully: `rGPGX1678775227I9NCwcuVJCb`。
+2. getBlackBox() will return a string of around 5000 bits while initialization Failed, please refer to [overview-definition](https://en-doc.trustdecision.com/reference/terminal-sdk-overview-2-0-en)
 
-**Advantages:** Under normal circumstances, the network returns a non-degraded blackBox, which will reduce the amount of data uploaded by the subsequent query interface, and the data size is about 26 bytes;<br/>**Disadvantages:** Not returned immediately, according to the network It usually takes about 300ms to return;<br/> **Applicable scenario:** Need to get the latest and non-degraded blackBox scenario;<br/>
+# Other
 
-**Sample Code**
+## Get SDK Version
 
-```
-  async function getBlackBoxAsync() {
-    const blackBox = await TrustDevice.getBlackBoxAsync()
-    console.log(blackBox);
-  }
+```tsx
+  async function getSDKVersion();
 ```
 
-# FAQ
-
-**Q1**：After Integrating the TrustDecision SDK, the project cannot be debugged in Xcode. How to solve it?
-
-**A1**：Please refer to [Initialization](#initialization) When the TrustDecision SDK is initialized, add the following parameters
-
-```
-options["debug"] = true
-```
+## Keep Configuration
 
+```xml
+-keep class cn.tongdun.**{*;}
+-keep class com.trustdecision.**{*;}
+```
+
+## All Configuration
+
+| Key                | Description                                                                                                                   | 平台      | Sample                               |
+| ------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------------------ |
+| partner(required)  | Partner code, contact operator to obtain.                                                                                     | All     | options["partner"] = "your partner"  |
+| appKey(required)   | Application identification, please refer to[how to get appKey](https://en-doc.trustdecision.com/reference/android-get-appkey) | All     | options["appKey"] = "your appKey"    |
+| country(required)  | Data-center： **cn** for China  **fra** for Europe  **sg** for Singapore  **inda** for Indonesia  **us** for the USA           | All     | options["country"] = "your country"  |
+| appName            | Application name, contact operator to obtain                                                                                  | All     | options["appName"] = "your appName"  |
+| debug              | Allow debugging, default false, must be closed before the application release.                                                | All     | options["debug"] = true              |
+| timeLimit          | Network timeout configuration, in seconds, default 15s                                                                        | All     | options["timeLimit"] = 5             |
+| location           | whether collecting GPS location information, default allowed                                                                  | All     | options["location"] = true           |
+| collectLevel       | You can set M to control the maximum length of blackBox to 2000, default around 5000                                          | All     | options["collectLevel"] = "M"        |
+| IDFA               | Whether collecting IDFA information, default allowed                                                                          | iOS     | options["IDFA"] = true               |
+| deviceName         | Whether collecting device name, default allowed                                                                               | iOS     | options["deviceName"] = true         |
+| runningTasks       | Whether collecting running tasks, default allowed                                                                             | Android | options["runningTasks"] = true       |
+| sensor             | Whether collecting sensor information, default allowed                                                                        | Android | options["sensor"] = true             |
+| readPhone          | Whether collecting READ _PHONE_ STATE permission-related information, default allowed                                         | Android | options["readPhone"] = true          |
+| installPackageList | Whether collecting application list information, default allowed                                                              | Android | options["installPackageList"] = true |

package/android/build/.transforms/74431a3a20358e468bfc0732882283b0/results.bin

@@ -0,0 +1 @@
+o/debug

package/android/build/.transforms/a1c8911952ed0abe57a80ce78259f834/results.bin

@@ -0,0 +1 @@
+i/

package/android/build/intermediates/incremental/debug/packageDebugResources/compile-file-map.properties

@@ -1 +1 @@
-#Wed Jul 17 20:15:02 CST 2024
+#Sat Oct 12 17:26:32 CST 2024

package/android/build.gradle

@@ -33,6 +33,6 @@ repositories {
 
 dependencies {
     implementation 'com.facebook.react:react-native:+'
-    implementation 'com.trustdecision.android:mobrisk:4.3.5.1'
+    implementation 'com.trustdecision.android:mobrisk:+'
 }
   

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-trustdevice",
-  "version": "0.1.5",
+  "version": "1.1.1",
   "description": "React Native TrustDevice component",
   "main": "index.js",
   "scripts": {