Skip to content

Commit 9906eb9

Browse files
authored
Update README.md
1 parent cd2c8db commit 9906eb9

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ freeRASP for React Native is a mobile in-app protection and security monitoring
1717
- [Step 3: Dev vs Release version](#step-3-dev-vs-release-version)
1818
- [Step 4: Import freeRASP into the app](#step-4-import-freerasp-into-the-app)
1919
- [Step 5: Setup the configuration, callbacks and initialize freeRASP](#step-5-setup-the-configuration-callbacks-and-initialize-freerasp)
20-
- [Step 6: User Data Policies](#step-6-user-data-policies)
20+
- [Step 6: Additional note about obfuscation](#step-6-additional-note-about-obfuscation)
21+
- [Step 7: User Data Policies](#step-7-user-data-policies)
2122
- [Security Report](#security-report)
2223
- [Enterprise Services](#bar_chart-enterprise-services)
2324
- [Commercial version](#commercial-version)
@@ -263,7 +264,31 @@ When freeRASP initializes correctly, you should see `freeRASP initialized` messa
263264
264265
_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)_
265266
266-
## Step 6: User Data Policies
267+
## Step 6: Additional note about obfuscation
268+
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.
269+
270+
### Android
271+
The majority of Android projects support code shrinking and obfuscation without any additional need for setup. The owner of the project can define the set of rules that are usually automatically used when the application is built in the release mode. For more information, please visit the official documentation
272+
* https://developer.android.com/studio/build/shrink-code
273+
* https://www.guardsquare.com/manual/configuration/usage
274+
275+
You can make sure, that the obfuscation is enabled by checking the value of **minifyEnabled** property in your **module's build.gradle** file.
276+
```gradle
277+
android {
278+
...
279+
280+
buildTypes {
281+
release {
282+
minifyEnabled true
283+
shrinkResources true
284+
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
285+
}
286+
}
287+
}
288+
```
289+
290+
291+
## Step 7: User Data Policies
267292
268293
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.
269294

0 commit comments

Comments
 (0)