Description of the freeRASP API
TalsecConfig
Specifies configuration for your app. See the table below for detailed description of the attributes.
field | type | description | sample value |
---|---|---|---|
AndroidConfig
Specifies configuration for instances of the app running on Android devices. See the table below for detailed description of the attributes.
field | type | description | sample value |
---|---|---|---|
IOSConfig
Specifies configuration for instances of the app running on Android devices. See the table below for detailed description of the attributes.
field | type | description | sample value |
---|---|---|---|
Future<void> start(TalsecConfig config)
Starts freeRASP with configuration provided in config.
void attachListener(ThreatCallback callback)
Attaches instance of ThreatCallback to freeRASP. If ThreatCallback is already attached, current one will be detached and replaced with callback. When threat is detected, respective callback of ThreatCallback is invoked.
ThreatCallback
A class which represents a set of callbacks that are used to notify the application when certain security threat is detected. Read more about the meaning of the callbacks in the .
method name | return type | Android | iOS |
---|---|---|---|
androidConfig
AndroidConfig?
Configuration for Android apps
any AndroidConfig instance
iosConfig
IOSConfig?
Configuration for iOS apps
any IOSConfig instance
watcherMail
String
The value is automatically used as the target address for your security reports. Mail has a strict form 'name@domain.com'
.
'john@example.com'
isProd
bool?
Defaults to true
when undefined. If you want to use the Dev version to make the development process easier, set the parameter to false
. Make sure that you have the Release version in the production (i.e. isProd set to true)!. To simplify switching between debug and release version of freeRASP based on the build type, you can use BuildConfig.BUILD_TYPE.contains("Release", true)
as a value for isProd
.
true
packageName
String
Package name of the app.
'com.talsec.freerasp.demoapp'
signingCertHashes
List<String>
Certificate hashes of your app.
['mVr/qQLO8DKTwqlL+B1qigl9NoBnbiUs8b4c2Ewcz0k=']
supportedStores
List<String>
Package names of the alternative stores. If you publish on the Google Play Store and Huawei AppGallery, as these are already included internally. (You can assign just emptyArray()).
For more information, visit the Detecting Unofficial Installation wiki page.
[ 'com.sec.android.app.samsungapps']
bundleIds
List<String>
List of Bundle IDs for the app
['com.talsec.freerasp.demoapp']
teamId
String
Apple Team ID used in the app
'M8AK35...'
onPrivilegedAccess
VoidCallback?
onDebug
VoidCallback?
onSimulator
VoidCallback?
onAppIntegrity
VoidCallback?
onUnofficialStore
VoidCallback?
onHooks
VoidCallback?
onDeviceBinding
VoidCallback?
onDeviceID
VoidCallback?
onPasscode
VoidCallback?
onSecureHardwareNotAvailable
VoidCallback?
onObfuscationIssues
VoidCallback?
onDevMode
VoidCallback?
onADBEnabled
VoidCallback?
onSystemVPN
VoidCallback?