- 1. Introduction
- 2. Installation Guide
- 3. API Reference
- 4. Configuration and Description
- 5. Sample Project
- 6. Questions or Issues
- 7. Licensing and Terms
HUAWEI Safety Detect builds robust security capabilities, including system integrity check (SysIntegrity), app security check (AppsCheck), malicious URL check (URLCheck), fake user detection (UserDetect), and malicious WiFi detection (WifiDetect), into your app, effectively protecting it against security threats. This plugin enables communication between HUAWEI Safety Detect Kit SDK and Flutter platform. It exposes all functionality provided by HUAWEI Safety Detect Kit SDK.
Before you get started, you must register as a HUAWEI Developer and complete identity verification on the HUAWEI Developer website. For details, please refer to Register a HUAWEI ID.
Creating an app in the AppGallery Connect is required in order to communicate with the Huawei services. To create an app, perform the following steps:
Step 1. Sign in to AppGallery Connect and select My projects.
Step 2. Select your project from the project list or create a new one by clicking the Add Project button.
Step 3. Go to Project Setting > General information, and click Add app. If an app exists in the project and you need to add a new one, expand the app selection area on the top of the page and click Add app.
Step 4. On the Add app page, enter the app information, and click OK.
A signing certificate fingerprint is used to verify the authenticity of an app when it attempts to access an HMS Core (APK) through the HMS SDK. Before using the HMS Core (APK), you must locally generate a signing certificate fingerprint and configure it in the AppGallery Connect. You can refer to 3rd and 4th steps of Generating a Signing Certificate codelab tutorial for the certificate generation. Perform the following steps after you have generated the certificate.
Step 1: Sign in to AppGallery Connect and select your project from My Projects. Then go to Project Setting > General information. In the App information field, click the add icon next to SHA-256 certificate fingerprint, and enter the obtained SHA-256 certificate fingerprint.
Step 2: After completing the configuration, click OK (Check mark icon) to save the changes.
Step 1: Sign in to AppGallery Connect and select your project from My Projects. Then go to Project Settings > Manage APIs and make sure the Safety Detect is enabled.
Step 2: Go to Project Setting > General information page, under the App information field, click agconnect-services.json to download the configuration file.
Step 3: Copy the agconnect-services.json file to the android/app directory of your project.
Step 4: Open the build.gradle file in the android directory of your project.
-
Navigate to the buildscript section and configure the Maven repository address and agconnect plugin for the HMS SDK.
buildscript { repositories { google() jcenter() maven { url 'https://developer.huawei.com/repo/' } } dependencies { /* * <Other dependencies> */ classpath 'com.huawei.agconnect:agcp:1.4.1.300' } }
-
Go to allprojects and configure the Maven repository address for the HMS SDK.
allprojects { repositories { google() jcenter() maven { url 'https://developer.huawei.com/repo/' } } }
Step 5: Open the build.gradle file in the android/app/ directory.
-
Add
apply plugin: 'com.huawei.agconnect'line after otherapplyentries.apply plugin: 'com.android.application' apply from: "$flutterRoot/packages/flutter_tools/gradle/flutter.gradle" apply plugin: 'com.huawei.agconnect'
-
Set your package name in defaultConfig > applicationId and set minSdkVersion to 19 or higher. Package name must match with the package_name entry in the agconnect-services.json file.
defaultConfig { applicationId "<package_name>" minSdkVersion 19 /* * <Other configurations> */ }
Step 6: Create a file <app_dir>/android/key.properties that contains a reference to your keystore which you generated on the previous step (Generating a Signing Certificate). Add the following lines to the key.properties file and change the values regarding to the keystore you've generated.
storePassword=<your_keystore_password>
keyPassword=<your_key_password>
keyAlias=<your_key_alias>
storeFile=<location of the keystore file, for example: D:\\Users\\<user_name>\\key.jks>
Warning: Keep this file private and don't include it on the public source control.
Step 7: Add the following code to the first line of android/app/build.gradle for reading the key.properties file:
def keystoreProperties = new Properties()
def keystorePropertiesFile = rootProject.file('key.properties')
if (keystorePropertiesFile.exists()) {
keystoreProperties.load(new FileInputStream(keystorePropertiesFile))
}Step 8: Edit buildTypes as follows and add the signingConfigs below:
signingConfigs {
config {
keyAlias keystoreProperties['keyAlias']
keyPassword keystoreProperties['keyPassword']
storeFile keystoreProperties['storeFile'] ? file(keystoreProperties['storeFile']) : null
storePassword keystoreProperties['storePassword']
}
}
buildTypes {
debug {
signingConfig signingConfigs.config
}
release {
signingConfig signingConfigs.config
}
}Step 9: On your Flutter project directory, find and open your pubspec.yaml file and add the huawei_safetydetect library to dependencies. For more details please refer to the Using packages document.
-
To download the package from pub.dev.
dependencies: huawei_safetydetect: {library version}
or
If you downloaded the package from the HUAWEI Developer website, specify the library path on your local device.
dependencies: huawei_safetydetect: # Replace {library path} with actual library path of Huawei Safety Detect Plugin for Flutter. path: {library path}
- Replace {library path} with the actual library path of the Flutter Safety Detect Kit Plugin. The following are examples:
- Relative path example:
path: ../huawei_safetydetect - Absolute path example:
path: D:\Projects\Libraries\huawei_safetydetect
- Relative path example:
- Replace {library path} with the actual library path of the Flutter Safety Detect Kit Plugin. The following are examples:
Step 10: Run the following command to update the package info.
[project_path]> flutter pub get
Step 11: Import the library to access the methods.
import 'package:huawei_safetydetect/huawei_safetydetect.dart';Step 12: Run the following command to start the app.
[project_path]> flutter run
The plugin class that provides HUAWEI Safety Detect APIs which can be called to check the system security.
| Method | Return Type | Description |
|---|---|---|
| getAppID | Future<String> | Obtains the Application ID from the agconnect-services.json file. |
| sysIntegrity | Future<String> | Initiates a request to check the system integrity of the current device. |
| isVerifyAppsCheck | Future<bool> | Checks whether app security check is enabled. |
| enableAppsCheck | Future<bool> | Enables app security check. |
| getMaliciousAppsList | Future<List<MaliciousAppData>> | Initiates an app security check request. |
| initUrlCheck | Future<void> | Initializes URL check. |
| urlCheck | Future<List<UrlCheckThreat>> | Initiates a URL check request. |
| shutdownUrlCheck | Future<void> | Disables URL check. |
| initUserDetect | Future<void> | Initializes fake user detection. |
| userDetection | Future<String> | Initiates a fake user detection request. Note: This function is not available in the Chinese Mainland. |
| shutdownUserDetect | Future<void> | Disables fake user detection. |
| getWifiDetectStatus | Future<WifiDetectResponse> | Obtains the malicious Wi-Fi check result. Note: This feature is available only in the Chinese Mainland. |
| initAntiFraud | Future<void> | Initializes imperceptible fake user detection. |
| releaseAntiFraud | Future<void> | Disables imperceptible fake user detection. |
| getRiskToken | Future<String> | Obtains a risk token. |
| enableLogger | Future<void> | Enables HMS Plugin Method Analytics which is used for sending usage analytics of Safety Detect SDK's methods to improve the service quality. |
| disableLogger | Future<void> | Disables HMS Plugin Method Analytics which is used for sending usage analytics of Safety Detect SDK's methods to improve the service quality. |
Obtains the Application ID from the agconnect-services.json file.
| Type | Description |
|---|---|
| Future<String> | The Application ID. |
// Example for obtaining the appID on a stateful widget's init state
String appId;
@override
void initState() {
super.initState();
getAppId();
}
void getAppId() async {
String res = await SafetyDetect.getAppID;
if (!mounted) return;
setState(() {
appId = res;
});
}Initiates a request to check the system integrity of the current device.
| Parameter | Type | Description |
|---|---|---|
| nonce | Uint8List | Cryptographic nonce value, which is used to prevent replay attacks. Ensure that the nonce value passed each time when the sysIntegrity API is called is unique. A nonce value consists of 16 to 66 bytes. |
| appId | String | The App ID applied in the AppGallery Connect. HMS Core (APK) needs to authenticate the app ID. You need to enable the Safety Detect service on the Manage APIs page in the AppGallery Connect. Since you have created an app during development preparations, you can obtain the app ID from the agconnect-services.json file by the getAppID method. |
| Type | Description |
|---|---|
| Future<String> | System integrity check result which is in JSON Web Signature (JWS)-format, encoded using Base64URL. If an exception or error occurs, null will be returned. Fields in JWS-format Header are as follows: { "alg": "RS256", "x5c": ["",""]}"alg": signature algorithm name. The value RS256 indicates the SHA256withRSA algorithm. "x5c": certificate chain used by Huawei signature server for JWS signing. The value x5c[0] indicates the certificate for JWS signing and x5c[1] indicates the CA certificate of a Huawei device. Fields in JWS-format Payload are as follows: { "nonce": "bSshKk0YTZrfOl5IjK7HcQ==", "timestampMs": 1571708929141, "apkPackageName": "com.huawei.hms.safetydetectsample", "apkDigestSha256": "6Ihk8Wcv1MLm0O5KUCEVYCI/0KWzAHn9DyN38R3WYu8=",, "apkCertificateDigestSha256": "["yT5JtXRgeIgXssx1gQTsMA9GzM9ER4xAgCsCC69Fz3I="], "basicIntegrity": false,}Note: "nonce": Base64-encoding result of the nonce value passed when the sysIntegrity API is called. "timestampMs": timestamp generated by the Huawei signing server. "apkPackageName": your package name "apkDigestSha256": SHA-256 digest of your app's Android package (APK). "apkCertificateDigestSha256": SHA-256 digest of your app's signing certificate. "basicIntegrity": system integrity check result. The value true indicates that the system is integral. "advice": suggestions in handling the system integrity check result. The value RESTORE_TO_FACTORY_ROM indicates restoration to factory settings. |
void checkSysIntegrity() async {
Random secureRandom = Random.secure();
List randomIntegers = List<int>();
for (var i = 0; i < 24; i++) {
randomIntegers.add(secureRandom.nextInt(255));
}
Uint8List nonce = Uint8List.fromList(randomIntegers);
// Platform messages may fail, so we use a try/catch PlatformException.
try {
String sysintegrityresult = await SafetyDetect.sysIntegrity(nonce, appId);
List<String> jwsSplit = sysintegrityresult.split(".");
String decodedText = utf8.decode(base64Url.decode(jwsSplit[1]));
Map<String, dynamic> jsonMap = json.decode(decodedText);
bool basicIntegrity = jsonMap['basicIntegrity'];
print("BasicIntegrity is ${basicIntegrity.toString()}");
print("SysIntegrityCheck result is: $decodedText");
} on PlatformException catch (e) {
print("Error occured while getting SysIntegrityResult. Error is : ${e.toString()}");
}
}Checks whether app security check is enabled.
| Type | Description |
|---|---|
| Future<bool> | Whether app security check is enabled. (App security check is enabled by default and cannot be disabled. Therefore, the value true is always returned.) |
void verifyAppsCheck() async {
bool result = await SafetyDetect.isVerifyAppsCheck();
print("AppsCheck is " + (result ? "verified." : "not verified."));
}Enables app security check.
| Type | Description |
|---|---|
| Future<bool> | Result of enabling app security check. (App security check is enabled by default and cannot be disabled. Therefore, the value true is always returned.) |
void enableAppsCheck() async {
bool result = await SafetyDetect.enableAppsCheck();
print("AppsCheck is " + (result ? "enabled" : "disabled"));
}Initiates an app security check request.
| Type | Description |
|---|---|
| Future<List<MaliciousAppData>> | App security check result list. |
void getMaliciousAppsList() async {
List<MaliciousAppData> maliciousApps = [];
maliciousApps = await SafetyDetect.getMaliciousAppsList();
String maliciousAppsResult = maliciousApps.length == 0
? "No malicious apps detected."
: "Malicious Apps:" + maliciousApps.toString();
print(maliciousAppsResult);
}Initializes URL check.
| Type | Description |
|---|---|
| Future<void> | Future result of an execution that returns no value. |
SafetyDetect.initUrlCheck();Future<List<UrlCheckThreat>> urlCheck(String url, String appId, List<UrlThreatTypes> urlThreatTypes) async
Initiates a URL check request.
| Parameter | Type | Description |
|---|---|---|
| url | String | URL to check, including the protocol, host, and path but excluding query parameters. The SDK will discard all passed query parameters. |
| appId | String | The App ID applied in the AppGallery Connect. HMS Core (APK) needs to authenticate the app ID. You need to enable the Safety Detect service on the Manage APIs page in the AppGallery Connect. Since you have created an app during development preparations, you can obtain the app ID from the agconnect-services.json file by the getAppID method. |
| urlThreatTypes | List<UrlThreatType> | Concerned threat types for URLs to check. |
| Type | Description |
|---|---|
| Future<List<UrlCheckThreat>> | URL check results. |
void urlCheck() async {
String concernedUrl = "http://example.com/hms/safetydetect/malware";
String urlCheckRes = "";
List<UrlThreatType> threatTypes = [
UrlThreatType.malware,
UrlThreatType.phishing];
List<UrlCheckThreat> urlCheckResults =
await SafetyDetect.urlCheck(concernedUrl, appId, threatTypes);
if (urlCheckResults.length == 0) {
urlCheckRes = "No threat is detected for the URL: $concernedUrl";
} else {
urlCheckResults.forEach((element) {
urlCheckRes += "${element.getUrlThreatType} is detected on the URL: $concernedUrl";
});
}
print(urlCheckRes);
}Disables URL check.
| Type | Description |
|---|---|
| Future<void> | Future result of an execution that returns no value. |
SafetyDetect.shutdownUrlCheck();Initializes fake user detection.
| Type | Description |
|---|---|
| Future<void> | Future result of an execution that returns no value. |
SafetyDetect.initUserDetect();Initiates a fake user detection request.
Note: This function is not available in the Chinese Mainland.
| Parameter | Type | Description |
|---|---|---|
| appId | String | The App ID applied in the AppGallery Connect. HMS Core (APK) needs to authenticate the app ID. You need to enable the Safety Detect service on the Manage APIs page in the AppGallery Connect. Since you have created an app during development preparations, you can obtain the app ID from the agconnect-services.json file by the getAppID method. |
| Type | Description |
|---|---|
| Future<String> | Response token returned by the userDetection API. You can use the response token to obtain the fake user detection result from the cloud of UserDetect. |
void userDetection() async {
try {
String token = await SafetyDetect.userDetection(appId);
print("User verification succeded, user token: $token");
} on PlatformException catch (e) {
print("Error occurred: ${e.code}:" +
SafetyDetectStatusCodes[e.code]);
}
}Disables fake user detection.
| Type | Description |
|---|---|
| Future<void> | Future result of an execution that returns no value. |
SafetyDetect.shutdownUserDetect();Obtains the malicious Wi-Fi check result.
Note: This feature is available only in the Chinese Mainland.
| Type | Description |
|---|---|
| Future<WifiDetectResponse> | Malicious Wi-Fi check result. Result will contain the obtained wifi options. The options are as follows: 0: No Wi-Fi is connected. 1: The Wi-Fi is secure. 2: The Wi-Fi is insecure. |
void getWifiDetectStatus() async {
try {
WifiDetectResponse wifiDetectStatus =
await SafetyDetect.getWifiDetectStatus();
print("Wifi detect status is: " +
wifiDetectStatus.getWifiDetectType.toString());
} on PlatformException catch (e) {
String resultCodeDesc = SafetyDetectStatusCodes[e.code];
print("Error occurred with status code: ${e.code}, Description: $resultCodeDesc");
}
}Initializes imperceptible fake user detection.
| Parameter | Type | Description |
|---|---|---|
| appId | String | The App ID applied in the AppGallery Connect. HMS Core (APK) needs to authenticate the app ID. You need to enable the Safety Detect service on the Manage APIs page in the AppGallery Connect. Since you have created an app during development preparations, you can obtain the app ID from the agconnect-services.json file by the getAppID method. |
| Type | Description |
|---|---|
| Future<void> | Future result of an execution that returns no value. |
void initAntiFraud() async {
SafetyDetect.initAntiFraud(appId);
print("Anti Fraud enabled");
}Disables imperceptible fake user detection.
| Type | Description |
|---|---|
| Future<void> | Future result of an execution that returns no value. |
void releaseAntiFraud() async {
SafetyDetect.releaseAntiFraud();
print("Anti Fraud disabled");
}Obtains a risk token.
| Type | Description |
|---|---|
| Future<String> | Risk token. |
void getRiskToken() async {
String riskToken = await SafetyDetect.getRiskToken();
print("Risk token obtained: $riskToken");
}Enables HMS Plugin Method Analytics which is used for sending usage analytics of Safety Detect SDK's methods to improve the service quality.
| Type | Description |
|---|---|
| Future<void> | Future result of an execution that returns no value. |
SafetyDetect.enableLogger(); // Enables HMSLoggerDisables HMS Plugin Method Analytics which is used for sending usage analytics of Safety Detect SDK's methods to improve the service quality.
| Type | Description |
|---|---|
| Future<void> | Future result of an execution that returns no value. |
SafetyDetect.disableLogger(); // Disables HMSLoggerThis section contains data types for interaction with the HUAWEI Safety Detect Flutter Plugin APIs. The following table describes detailed information about data types.
| Classes | Description |
|---|---|
| MaliciousAppData | Malicious app entity class which contains the verify apps check result. |
| UrlCheckThreat | Url check threat entity class which contains the url check threat result. |
| WifiDetectResponse | Wifi detect response entity class which contains the wifi detect result. |
Malicious app entity class which contains the verify apps check result.
| Name | Type | Description |
|---|---|---|
| apkCategory | int | Integer value of a malicious app type. Values are as follows: 1: risk app 2: virus app The corresponding MaliciousAppType can be obtained with getMaliciousAppType method. |
| apkPackageName | String | Package name of a malicious app. |
| apkSha256 | String | Base64 encoding result of the SHA-256 value of a malicious app. |
| Method | Return Type | Description |
|---|---|---|
| getMaliciousAppType | MaliciousAppType | Obtains the MaliciousAppType that corresponds to the detected apkCategory of the current MaliciousAppData instance. |
| toMap | Map<String, dynamic> | Obtains the map representation of the current MaliciousAppData instance. |
| toString | String | Obtains the string representation of the current MaliciousAppData instance. |
Obtains the MaliciousAppType that corresponds to the detected apkCategory of the current MaliciousAppData instance.
| Type | Description |
|---|---|
| MaliciousAppType | Malicious App Type. |
Obtains the map representation of the current MaliciousAppData instance.
| Type | Description |
|---|---|
| Map<String, dynamic> | Map representation of the current MaliciousAppData object. |
Obtains the string representation of the current MaliciousAppData instance.
| Type | Description |
|---|---|
| String | String representation of the current MaliciousAppData object. |
Url check threat entity class which contains the url check threat result.
| Method | Return Type | Description |
|---|---|---|
| getUrlCheckResult | int | Obtains the integer value of the URL check result's threat type. The options are as follows: 1: MALWARE 3: PHISHING |
| getUrlThreatType | UrlThreatType | Obtains the UrlThreatType of the URL check result. |
Obtains the integer value of the URL check result's threat type. The options are as follows:
- 1: MALWARE
- 3: PHISHING
| Type | Description |
|---|---|
| int | Integer value of the threat type. |
Obtains the UrlThreatType of the URL check result.
| Type | Description |
|---|---|
| UrlThreatType | Threat type. |
Wifi detect response entity class which contains the wifi detect result.
| Method | Return Type | Description |
|---|---|---|
| getWifiDetectStatus | int | Obtains the security check result of a Wi-Fi network. This helps your app protect the payment and privacy security of your users, preventing economic loss and privacy breach. |
| getWifiDetectType | WifiDetectType | Obtains the WifiDetectType of the wifiDetectStatus. |
Obtains the security check result of a Wi-Fi network. This helps your app protect the payment and privacy security of your users, preventing economic loss and privacy breach.
| Type | Description |
|---|---|
| int | Security status of the current Wi-Fi. The options are as follows: 0: No Wi-Fi is connected. 1: The Wi-Fi is secure. 2: The Wi-Fi is insecure. To obtain the corresponding WifiDetectType of the result please use the getWifiDetectType method |
Obtains the WifiDetectType of the wifiDetectStatus.
| Type | Description |
|---|---|
| WifiDetectType | Wifi Detect Type. |
This section contains detailed information about constants provided by the HUAWEI Safety Detect Kit Flutter Plugin.
Threat Types that can be detected during app check.
| Value | Description |
|---|---|
| virus_level_risk | Risk app. |
| virus_level_virus | Virus app. |
Threat Types that can be detected during an url check.
| Value | Description |
|---|---|
| malware | Malware URL type. |
| phishing | Phishing URL type. |
Security status type of the current Wi-Fi.
| Value | Description |
|---|---|
| no_wifi | No Wi-Fi is connected. |
| secure_wifi | The Wi-Fi is secure. |
| insecure_wifi | The Wi-Fi is insecure. |
Status codes of the HUAWEI Safety Detect SDK. These status codes are included in a constant Map in the library for an easy conversion between status code and result code.
void getWifiDetectStatus() async {
try {
WifiDetectResponse wifiDetectStatus =
await SafetyDetect.getWifiDetectStatus();
print("Wifi detect status is: " +
wifiDetectStatus.getWifiDetectType.toString());
} on PlatformException catch (e) {
String resultCodeDesc = SafetyDetectStatusCodes[e.code];
print("Error occurred with status code: ${e.code}, Description: $resultCodeDesc");
}
}| Result Code | Value | Description | Solution |
|---|---|---|---|
| SDK_INTERNAL_ERROR | 19001 | HMS Core SDK internal error. | Go to Support > Customer Service > Submit Question Online, select the relevant topic, and submit your question. Huawei will get back to you as soon as possible. |
| NETWORK_ERROR | 19002 | Network exception. | Verify that your phone has access to the Internet. |
| UNSUPPORTED_AREA | 19003 | The API is unavailable in this region. | Verify that this API is supported in the region where the user is located. |
| INVALID_APPID_APPCHECK | 19004 | Invalid app ID in the request. | Verify that the app ID in the request is valid. |
| UNSUPPORTED_EMUI_VERSION | 19202 | The HMS Core (APK) version on the user device does not support the Safety Detect service. | Update HMS Core (APK) to the latest version. |
| APPS_CHECK_FAILED_VIRUS_NUMBER_EXCEEDED | 19402 | The number of apps to check exceeds the maximum allowed by AppCheck. | Reduce the number of apps to check. |
| PARAM_ERROR_EMPTY | 19150 | A mandatory parameter in the request is empty. | Verify that all mandatory parameters in the request are correctly set. |
| PARAM_ERROR_INVALID | 19151 | Parameter verification failed. | Verify that parameters in the request are valid. |
| APPS_CHECK_INTERNAL_ERROR | 19401 | An internal error occurred during app security check. | Contact Huawei technical support. |
| URL_CHECK_INNER_ERROR | 19600 | An internal error occurred during malicious URL check. | Contact Huawei technical support. |
| CHECK_WITHOUT_INIT | 19601 | URLCheck initialization failed. | Call the initUrlCheck() API first to initialize URLCheck. |
| URL_CHECK_THREAT_TYPE_INVALID | 19602 | The URLCheck API does not support the passed URL categories. Currently, Safety Detect can only identify phishing and malware URLs. | Verify that the passed URL categories are valid. |
| URL_CHECK_REQUEST_PARAM_INVALID | 19603 | Invalid parameters for calling urlCheck. | Verify that relevant parameters are valid. |
| URL_CHECK_REQUEST_APPID_INVALID | 19604 | The app ID passed for calling urlCheck is invalid. | Verify that the passed app ID is valid. |
| DETECT_FAIL | 19800 | Fake user detection failed. | Try again. If the detection fails for three times, risks exist. |
| USER_DETECT_TIMEOUT | 19801 | Fake user detection timed out, for example, when the user enters the verification code. | Try again. |
| USER_DETECT_INVALID_APPID | 19802 | The app ID passed for calling userDetection is invalid. | Verify that the passed app ID is valid. |
| ANTI_FRAUD_INIT_FAIL | 19820 | Failed to initialize imperceptible fake user detection. | Contact Huawei technical support. |
| ANTI_FRAUD_INIT_PARAM_INVALID | 19821 | The app ID passed to the initAntiFraud API is incorrect. | Verify the passed parameter. |
| RISK_TOKEN_GET_FAIL | 19830 | Failed to obtain the risk token. | Initializes the API again. |
| RISK_TOKEN_INNER_ERROR | 19831 | An internal error occurred on the API for obtaining a risk token. | Contact Huawei technical support. |
| UNKOWN_ERROR_STATUS_CODE | -1 | Unkown error code. | - |
Before building a release version of your app you may need to customize the proguard-rules.pro obfuscation configuration file to prevent the HMS Core SDK from being obfuscated. Add the configurations below to exclude the HMS Core SDK from obfuscation. For more information on this topic refer to this Android developer guide.
<flutter_project>/android/app/proguard-rules.pro
-ignorewarnings
-keepattributes *Annotation*
-keepattributes Exceptions
-keepattributes InnerClasses
-keepattributes Signature
-keep class com.hianalytics.android.**{*;}
-keep class com.huawei.updatesdk.**{*;}
-keep class com.huawei.hms.**{*;}
-keep class com.huawei.hms.flutter.** { *; }
# Flutter wrapper
-keep class io.flutter.app.** { *; }
-keep class io.flutter.plugin.** { *; }
-keep class io.flutter.util.** { *; }
-keep class io.flutter.view.** { *; }
-keep class io.flutter.** { *; }
-keep class io.flutter.plugins.** { *; }
-dontwarn io.flutter.embedding.**
<flutter_project>/android/app/build.gradle
buildTypes {
debug {
signingConfig signingConfigs.config
}
release {
signingConfig signingConfigs.config
// Enables code shrinking, obfuscation and optimization for release builds
minifyEnabled true
// Unused resources will be removed, resources defined in the res/raw/keep.xml will be kept.
shrinkResources true
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}This plugin includes a demo project in the example folder, there you can find more usage examples.
If you have questions about how to use HMS samples, try the following options:
- Stack Overflow is the best place for any programming questions. Be sure to tag your question with huawei-mobile-services.
- Github is the official repository for these plugins, You can open an issue or submit your ideas.
- Huawei Developer Forum HMS Core Module is great for general questions, or seeking recommendations and opinions.
- Huawei Developer Docs is place to official documentation for all HMS Core Kits, you can find detailed documentations in there.
If you run into a bug in our samples, please submit an issue to the GitHub repository.
Huawei Safety Detect Kit Flutter Plugin is licensed under Apache 2.0 license