API

Types

TalsecConfig

Specifies configuration for your app. See the table below for detailed description of the attributes.

field	type	description	sample value
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 '[e-mail]'.	'[e-mail]'
isProd	boolean?	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

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
packageName	string	Package name of the app.	'com.talsec.freerasp.demoapp'
certificateHashes	string[]	Certificate hashes of your app.	['mVr/qQLO8DKTwqlL+B1qigl9NoBnbiUs8b4c2Ewcz0k=']
supportedAlternativeStores	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']

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
appBundleId	string	Apple Bundle ID for the app	'com.talsec.freerasp.demoapp'
appTeamId	string	Apple Team ID used in the app	'M8AK35...'

NativeEventEmitterActions

Specifies a set of callbacks that are used to notify the application when certain security threat is detected.

Actions

threat	type	Android	iOS
privilegedAccess	() => any
debug	() => any
simulator	() => any
appIntegrity	() => any
unofficialStore	() => any
hooks	() => any
deviceBinding	() => any
deviceID	() => any
passcode	() => any
secureHardwareNotAvailable	() => any
obfuscationIssues	() => any
devMode	() => any
adbEnabled	() => any
systemVPN	() => any

Hooks

const useFreeRasp = (config: TalsecConfig, actions: NativeEventEmitterActions)

React Custom Hook responsible for starting freeRASP and setting up listeners

Methods

const setThreatListeners = async (config: NativeEventEmitterActions): void

Sets up listeners for detected threats

const talsecStart = async (options: TalsecConfig): Promise<string>

Method is used to start freeRASP's audit. Returns 'freeRASP started'string when successful.

const removeThreatListeners = (): void

Unregisters threat listeners. Should be called only when the app is being terminated.