🤖Android

📝 Prerequisites

freeRASP requires a minimum SDK level of 23. To update the minimum SDK level of the application, follow these steps:

1. From the root of your project, go to build.gradle.

2. Update minSdkVersion to at least 23 (Android 6.0) or higher.

build.gradle

buildscript {
    ext {
      minSdkVersion 23
    }
}

---

📦 Add the dependency

Set Talsec's Artifact Registry in your project's build.gradle (or settings.gradle if you are using settings repositories):

[build.gradle (:project)]

repositories {
    google()
    mavenCentral()
    maven { url "https://jitpack.io" }
    maven { url "https://europe-west3-maven.pkg.dev/talsec-artifact-repository/freerasp" }
}

Make sure that Talsec's maven dependency is at the last position.

Set dependencies in your :app module's build.gradle:

[build.gradle (: app)]

dependencies {
    // freeRASP SDK  
    implementation 'com.aheaditec.talsec.security:TalsecSecurity-Community:9.6.0'
}

---

⚙️ Setup the Configuration for your App

To ensure freeRASP functions correctly, you need to provide the necessary configuration. All required values must be filled in for the plugin to operate properly. Use the following template to configure the plugin. Detailed descriptions of the configuration options are provided on the API page.

1. Create an arbitrary subclass of Application(), override its onCreate()method and implement ThreatListener.ThreatDetected interface. You can, of course, use your Application subclass if you already have one in your project.

   TalsecApplication.kt

   class TalsecApplication : Application(), ThreatListener.ThreatDetected {
       override fun onCreate() {
           super.onCreate()
       }
   }

2. Add a new subclass to AndroidManifest.xml, inside <application> tag:

   AndroidManifest.xml

   <application
       android:name=".TalsecApplication"
   />

3. Set up the Configuration for your app with your values, which are explained in more detail in API.

   TalsecApplication.kt

   companion object {
       private const val expectedPackageName = "com.aheaditec.talsec.demoapp" // Don't use Context.getPackageName!
       private val expectedSigningCertificateHashBase64 = arrayOf(
           "mVr/qQLO8DKTwqlL+B1qigl9NoBnbiUs8b4c2Ewcz0k=",
           "ZjLPK1Dle5JS1aUu1NuNEVVXarMEsCXvni/Kv/FK+tw="
       ) // Replace with your release (!) signing certificate hashes
       private const val watcherMail = "[e-mail]" // for Alerts and Reports
       private val supportedAlternativeStores = arrayOf(
           "com.sec.android.app.samsungapps" // Add other stores, such as the Samsung Galaxy Store
       )
       private val isProd = true
   }

   TalsecApplication.kt

   override fun onCreate() {
       ...
       
       val config = TalsecConfig(
           expectedPackageName,
           expectedSigningCertificateHashBase64,
           watcherMail,
           supportedAlternativeStores,
           isProd
       )
   }

---

👷 Handle detected threats

You can handle the detected threats using listeners. For example, you can log the event, show a window to the user or kill the application. See the Threat detection to learn more details about the performed checks and their importance for app security.

1. Implement methods of ThreatListener.ThreatDetected interface:

   TalsecApplication.kt

   override fun onRootDetected() {
       TODO("Not yet implemented")
   }
   
   override fun onDebuggerDetected() {
       TODO("Not yet implemented")
   }
   
   override fun onEmulatorDetected() {
       TODO("Not yet implemented")
   }
   
   override fun onTamperDetected() {
       TODO("Not yet implemented")
   }
   
   override fun onUntrustedInstallationSourceDetected() {
       TODO("Not yet implemented")
   }
   
   override fun onHookDetected() {
       TODO("Not yet implemented")
   }
   
   override fun onDeviceBindingDetected() {
       TODO("Not yet implemented")
   }
   
   override fun onObfuscationIssuesDetected() {
       TODO("Not yet implemented")
   }

2. Optionally, you can use a device state listener to get additional information about the device state, like passcode lock and HW-backed Keystore state:

   TalsecApplication.kt

   private val deviceStateListener = object : ThreatListener.DeviceState {
       override fun onUnlockedDeviceDetected() {
           TODO("Not yet implemented")
       }
       override fun onHardwareBackedKeystoreNotAvailableDetected() {
           TODO("Not yet implemented")
       }
   
       override fun onDeveloperModeDetected() {
   	TODO("Not yet implemented")
       }
   
       override fun onSystemVPNDetected() {
   	TODO("Not yet implemented")
       }
   }

3. Modify initialization of ThreatListener:

   TalsecApplication.kt

   override fun onCreate() {
       ...
       // ThreatListener(this).registerListener(this)
       ThreatListener(this, deviceStateListener).registerListener(this)
   }

---

🛡️ Start freeRASP

TalsecApplication.kt

override fun onCreate() {
    ...
    Talsec.start(this, config)
}

---

🫣 Enable source code obfuscation

You can make sure that the obfuscation is enabled by checking the value of minifyEnabled property in your module's build.gradle file.

Read more about why this is important in the wiki.

android {
    ...
    buildTypes {
        release {
            minifyEnabled true
            shrinkResources true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}