trustdevice_pro_plugin 1.2.4

Flutter plugin that can be used in an application to call the native mobrisk Pro libraries and identify devices.

Flutter trustdevice_pro_plugin Integration Documentation

Integrated Requirement

Compliance Explanation

Please note that when integrating SDK products provided by the TrustDecision in the APP of your company:

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:

Privacy Protocol: https://www.trustdecision.com/legal/privacy-policy

Precautions

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.

Integrate Steps

Integrated SDK

1.Add trustdevice_pro_plugin to the pubspec.yaml in your Flutter app

dependencies:
  flutter:
    sdk: flutter
  ...
  trustdevice_pro_plugin: ^1.2.3

Android permission application

Declare the following permissions in the AndroidManifest.xml file under the application module

<manifest>
   <!--Compulsory permissions-->
   <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"/>

   <!--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" />
   <uses-permission android:name="android.permission.ACCESS_COARSE_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"/>
</manifest>

Dynamic application permissions: Android 6.0 or above requires dynamic application permissions. Dynamic application permissions code must be placed before the initial plugin. The code example is as follows:

//The following permissions are not required to be applied for, 
//and can be selectively applied for according to business conditions
 Future<void> _requestPermission() async {
    Map<Permission, PermissionStatus> statuses = await [
      Permission.location,
      Permission.phone,
    ].request();
  }

Initialization

Sample Code

import 'package:trustdevice_pro_plugin/trustdevice_pro_plugin.dart';
// ...

// 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);
  }
  // ...
}

Required Configuration

Key	Definition	Description	Platform	Sample code
partner	Partner code	Partner, please contact TrustDecision to obtain	All	options["partner"] = "[Your partner]"
appKey	App key	Appkey, please offer your App bundleId for TrustDecision to obtain appkey creation requires the user to provide the application bundleId. ⚠️ Different values for bundleId are used for different applications	All	options["appKey"] = "[Your appKey]"
appName	App name	AppName, please contact TrustDecision to obtain	All	options["appName"] = "[Your appName]"
country	Country code	cn: means China; sg: means Singapore; us: means North America; fra: means Europe	All	options["country"] = "[Your country code]"

Get SDK Version

Sample Code

// Get SDK Version
 Future<String> _getSDKVersion() async {
    var sdkVersion = await _trustdeviceProPlugin.getSDKVersion();
    return Future.value(sdkVersion);
  }

Other Instructions

Android obfuscated packaging If developers need to use proguard for obfuscated packaging, please add the following code to the proguard configuration file:

-keep class cn.tongdun.**{*;}

initWithOptions Optional Parameter

Key	Definition	Description	Platform	Sample code
debug	Whether allow debug	default is false,After the SDK is integrated, the app has the anti-debugging function by default. Develop: Please set value to true. Release: Please not set this key or set value to false Options: true: allow debug; false: not allow debug	All	options["debug"] = true
timeLimit	SDK timeout interval Configuration (unit: seconds)	Timeout interval of network request callback after SDK initialization. Default is 15s.	All	options["timeLimit"] = 5
location	Whether collect location information	default is true,SDK will collect location if the app has been authorized to get location information. Options: true: allow collect location information; false: not allow collect location information	All	options["location"] = true
collectLevel	Degraded blackbox length configuration	Degraded blackbox will be longer. This configuration allows you to control the length of the degraded blackbox. Options: "M": After setting, the degraded blackbox length is about 2000 characters; "L": default value, after setting, the degraded length is about 5000 characters	All	options["collectLevel"] = "M"
IDFA	Whether collect Advertising Identifier (IDFA) information	default is true,SDK will collect IDFA information if the app has been authorized to get IDFA information. Options: true: allow collect IDFA information; false: not allow collect IDFA information	iOS	options["IDFA"] = true
deviceName	Whether collect device's name information	default is true,SDK will collect device's name information. Options: true: allow collect device's name information; false: not allow collect device's name information	iOS	options["deviceName"] = true
blackBoxMaxSize	blackbox maximum length	The default length is Integer.MAX_VALUE, it will increase according to the actual device situation	Android	options["blackBoxMaxSize"] = 3000
customProcessName	custom process name	change the name of the SDK's process	Android	options["customProcessName"] = "td"
forceTLSVersion	Whether https is mandatory to use TLS-v1.1 version	default is false, and the developer can set the corresponding settings according to the specific situation. Options: true: use TLS-v1.1 version; false: not use TLS-v1.1 version	Android	options["forceTLSVersion"] = true
runningTasks	Whether allow getting running tasks	default is true. Options: true: allow getting running tasks; false: not allow getting running tasks	Android	options["runningTasks"] = true
sensor	Whether collect sensor information	default is true,SDK will collect sensor-related information. Options: true: collect sensor information; false: not collect sensor information	Android	options["sensor"] = true
readPhone	Whether collect READ_PHONE_STATE related information	default is true,SDK will collect READ_PHONE_STATE information if app gained READ_PHONE_STATE permission Options: true: collect READ_PHONE_STATE related information; false: not collect READ_PHONE_STATE related information	Android	options["readPhone"] = true
installPackageList	Whether collect the list of installation packages	default is true,SDK will collect the list of installation packages. Options: true: collect the list of installation packages; false: not collect the list of installation packages	Android	options["installPackageList"] = true

Get Blackbox

Synchronous method getBlackBox

Usage Scenario Description

Advantages: It will return blackBox immediately, not affected by the network status;
Disadvantages: After integrating the device fingerprint SDK, if no non-downgraded blackBox has been obtained before, it will return downgraded blackBox will increase the amount of data uploaded by the subsequent query interface, and the data size is about 5000 bytes;
Applicable scenarios: Scenarios that need to obtain blackBox immediately;

Example Code

 Future<String> _getPlatformBlackBox() async {
    var blackbox = await _trustdeviceProPlugin.getBlackbox();
    return Future.value(blackbox);
  }

Asynchronous method getBlackBoxAsync

Usage Scenario Description

**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;
Disadvantages: Does not return immediately, according to the network It usually takes about 300ms to return;
Applicable scenario: Need to get the latest and non-degraded blackBox scenario;

Example Code

 Future<String> _getBlackBoxAsync() async {
    var blackbox = await _trustdeviceProPlugin.getBlackboxAsync();
    return Future.value(blackbox);
  }

Captcha Module

Initial configuration optional parameter list

Configuration Key	Definition	Description	Scenario	Sample Code
language	language type	Options: 1-Simplified Chinese, 2-Traditional Chinese, 3-English, 4-Japanese, 5-Korean, 6-Malay, 7-Thai, 8-Indonesian, 9-Russian Default: 1-Simplified Chinese	You can set the language type according to your needs, Chinese mainland support 1-5, overseas support 1-9	options[language"] = "1"
tapToClose	Click on the blank space to close the Captcha window	Optional: true, false Default: false	After opening, click on the blank area of the interface to close the Captcha window, which is more convenient to close the pop-up window	options[tapToClose"] = true
needSeqid	Whether to carry the seqid in the failure callback message	Optional: true, false Default: true	When enabled, the seqid serial number will be carried in the failure message, and the seqid will be provided to TrustDecision for easy troubleshooting Reason for failure	options[needSeqid"] = true
hideLoadHud	Whether to skip the loading animation	Options: true, false Default: false	When enabled, the loading animation will not be displayed when the Captcha window pops up, shortening the verification time	options[hideLoadHud"] = true
hideWebCloseButton	Whether to hide the close button of the webview	Options: true, false Default: false	Scenarios that need to be forced to complete the Captcha	options[hideWebCloseButton"] = true
openLog	Whether to open the log	Options: true, false Default: false	When enabled, the console will output more log information during debugging, which is convenient for troubleshooting	options[openLog"] = true
skipCaptcha	Whether to skip the TrustDecision Captcha verification	Optional: true, false Default: false	When enabled, the Captcha will not be verified, and a 4000 error code will be returned at the same time, which is used for dynamic settings Whether to use TrustDecision Captcha SDK verification	options[skipCaptcha"] = true
mfaId	MFA ID	Optional: string Default:null	If you have connected to the MFA product (the description can be ignored if the MFA is not connected), please set the mfaId which is obtained from the MFA process to the configuration parameter.	options[mfaId"] = "mfaId string"

Popup Captcha Window

Example Code

    _trustdeviceProPlugin.showCaptcha(TDRiskCaptchaCallback(onReady: () {
        print("Captcha window popup is successful, waiting to be verified!");
    }, onSuccess: (String token) {
        print("Obtain TrustDecision Captcha successfully!，validateToken:" + token);
    }, onFailed: (int errorCode, String errorMsg) {
        print("TrustDecision Captcha failed!, errorCode: $errorCode errorMsg: $errorMsg");
    }));

Error Code

The error code of the captcha function module will be output through showCaptcha method

Error Code	Error Message	Processing Method
1001	The Captcha window is closed	After the Captcha window popup, the user manually cancels the Captcha,no processing is required
2001	The request parameter is abnormal, please check the parameter	Please check the appName and partnerCode parameters
2100	The request parameter is abnormal, please check the parameter	Please check the passed parameter
2101	The request parameter is abnormal, please check the parameter	There is an error in the request process, please contact the operator
2102	The request parameter is abnormal, please check the parameter	The parameter is missing, please check the parameter
2111	Authentication page network error	Try again later, or please contact the operator
2112	Verification page operation is too frequent	Try again later
2113	Unknown error	Unknown error, please contact the operator
2114	Closed the Captcha window	Clicked the Captcha close button, no need to process
2115	Authentication page network error	Failed to load network resources
2116	Authentication page network error	Failed to load network resources
2202	Verification succeeded	The verification result is successful and no processing is required
2301	Did not purchase this service	Please contact the operator
2302	Traffic has been disabled	Please contact the operator
2303	Insufficient traffic	Please contact the operator
2304	Service has expired	Please contact the operator
2305	Daily traffic has been capped	Please contact the operator
2600	The system is busy, please try again later	The system is busy, please try again later
2601	Authentication failed, try again later	Authentication failed, please try again later
2602	Authentication failed, try again later	Authentication failed, please try again later
2603	Authentication failed, try again later	Authentication failed, please try again later
2604	Authentication failed, try again later	Refresh frequently, please try again later
2605	Verification failed, try again later	Failed to obtain Captcha information
2702	Authentication failed, try again later	Parsing error, please try again later
3001	SSL certificate verification failed	Please close the network proxy tool
3002	Error loading verification page	Refresh the network and try again
3003	Authentication page load timed out	Check network and try again
4000	Validation logic skipping	Developers manually handle validation skipping logic
9000	The device fingerprint is not mounted	To integrate the Captcha, you need to integrate the device fingerprint first
9001	No network	Please check network connection
9002	Request timed out	Check network, try again later
9003	Return result is abnormal	Server error, return result is abnormal, contact technical support
9004	Global loading timed out	Check network, try again later

FAQ

Q1：After Integrating the TrustDecision SDK, the project cannot be debugged in Xcode. How to solve it?

A1：Please refer to Initialization When the TrustDecision SDK is initialized, add the following parameters

options["debug"] = true