feat: added and configured example app for 1.0.1

example/.gitignore

@@ -0,0 +1,11 @@
+*.iml
+.gradle
+/local.properties
+.idea/
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties
+

example/app/.gitignore

@@ -0,0 +1 @@
+/build

example/app/build.gradle.kts

@@ -0,0 +1,73 @@
+plugins {
+    alias(libs.plugins.android.application)
+    alias(libs.plugins.jetbrains.kotlin.android)
+}
+
+android {
+    namespace = "com.exxeta.mobilesecuritytoolkitexample"
+    compileSdk = 34
+
+    defaultConfig {
+        applicationId = "com.exxeta.mobilesecuritytoolkitexample"
+        minSdk = 28
+        targetSdk = 34
+        versionCode = 1
+        versionName = "1.0"
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+        vectorDrawables {
+            useSupportLibrary = true
+        }
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+                "proguard-rules.pro"
+            )
+            // Don't do this, just just to test
+            signingConfig = signingConfigs.getByName("debug")
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+    buildFeatures {
+        compose = true
+    }
+    composeOptions {
+        kotlinCompilerExtensionVersion = "1.5.1"
+    }
+    packaging {
+        resources {
+            excludes += "/META-INF/{AL2.0,LGPL2.1}"
+        }
+    }
+}
+
+dependencies {
+    implementation(libs.android.security.toolkit)
+
+    implementation(libs.androidx.core.ktx)
+    implementation(libs.androidx.lifecycle.runtime.ktx)
+    implementation(libs.androidx.activity.compose)
+    implementation(platform(libs.androidx.compose.bom))
+    implementation(libs.androidx.ui)
+    implementation(libs.androidx.ui.graphics)
+    implementation(libs.androidx.ui.tooling.preview)
+    implementation(libs.androidx.material3)
+
+    testImplementation(libs.junit)
+    androidTestImplementation(libs.androidx.junit)
+    androidTestImplementation(libs.androidx.espresso.core)
+    androidTestImplementation(platform(libs.androidx.compose.bom))
+    androidTestImplementation(libs.androidx.ui.test.junit4)
+    debugImplementation(libs.androidx.ui.tooling)
+    debugImplementation(libs.androidx.ui.test.manifest)
+}

example/app/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

example/app/src/androidTest/java/com/exxeta/mobilesecuritytoolkitexample/ExampleInstrumentedTest.kt

@@ -0,0 +1,24 @@
+package com.exxeta.mobilesecuritytoolkitexample
+
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.ext.junit.runners.AndroidJUnit4
+
+import org.junit.Test
+import org.junit.runner.RunWith
+
+import org.junit.Assert.*
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleInstrumentedTest {
+    @Test
+    fun useAppContext() {
+        // Context of the app under test.
+        val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+        assertEquals("com.exxeta.mobilesecuritytoolkitexample", appContext.packageName)
+    }
+}

example/app/src/main/AndroidManifest.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools" >
+
+    <application
+        android:allowBackup="true"
+        android:dataExtractionRules="@xml/data_extraction_rules"
+        android:fullBackupContent="@xml/backup_rules"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/Theme.MobileSecurityToolkitExample"
+        tools:targetApi="31" >
+        <activity
+            android:name=".MainActivity"
+            android:exported="true"
+            android:label="@string/app_name"
+            android:theme="@style/Theme.MobileSecurityToolkitExample" >
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+    </application>
+
+</manifest>

example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/MainActivity.kt

@@ -0,0 +1,20 @@
+package com.exxeta.mobilesecuritytoolkitexample
+
+import android.os.Bundle
+import androidx.activity.ComponentActivity
+import androidx.activity.compose.setContent
+import androidx.activity.enableEdgeToEdge
+import androidx.compose.ui.platform.LocalContext
+import com.exxeta.mobilesecuritytoolkitexample.ui.theme.MobileSecurityToolkitExampleTheme
+
+class MainActivity : ComponentActivity() {
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        enableEdgeToEdge()
+        setContent {
+            MobileSecurityToolkitExampleTheme {
+                ThreatStatusList()
+            }
+        }
+    }
+}

example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ThreatStatus.kt

@@ -0,0 +1,7 @@
+package com.exxeta.mobilesecuritytoolkitexample
+
+data class ThreatStatus(
+    val title: String,
+    val description: String,
+    val isDetected: Boolean,
+)

example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ThreatStatusList.kt

@@ -0,0 +1,115 @@
+package com.exxeta.mobilesecuritytoolkitexample
+
+import androidx.compose.foundation.layout.Spacer
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.height
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.layout.size
+import androidx.compose.foundation.lazy.LazyColumn
+import androidx.compose.foundation.lazy.items
+import androidx.compose.material3.Card
+import androidx.compose.material3.CardDefaults
+import androidx.compose.material3.Icon
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.mutableStateListOf
+import androidx.compose.runtime.remember
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.platform.LocalContext
+import androidx.compose.ui.res.painterResource
+import androidx.compose.ui.text.style.TextAlign
+import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.unit.dp
+import com.exxeta.mobilesecuritytoolkitexample.ui.theme.MobileSecurityToolkitExampleTheme
+import com.exxeta.securitytoolkit.ThreatDetectionCenter
+
+@Composable
+fun ThreatStatusList() {
+
+    val context = LocalContext.current
+    val detectionCenter = ThreatDetectionCenter(context)
+    detectionCenter.threats
+    val reportedThreats = remember {
+        mutableStateListOf<ThreatDetectionCenter.Threat>()
+    }
+
+    LaunchedEffect(Unit) {
+        detectionCenter.threats.collect {
+            reportedThreats.add(it)
+        }
+    }
+
+    val threats = listOf(
+        ThreatStatus(
+            "Root",
+            "Is a way of acquiring privileged control over the operating system of a device. Tools such as Magisk or Shadow can hide the privileged access",
+            reportedThreats.contains(ThreatDetectionCenter.Threat.ROOT_PRIVILEGES),
+        ),
+        ThreatStatus(
+            "Hooks",
+            "Intercept system or application calls and then modify them (modify the return value of a function call for example)",
+            reportedThreats.contains(ThreatDetectionCenter.Threat.HOOKS),
+        ),
+        ThreatStatus(
+            "Emulator",
+            "Running the application in an Emulator",
+            reportedThreats.contains(ThreatDetectionCenter.Threat.SIMULATOR),
+        ),
+    )
+
+    LazyColumn(
+        modifier = Modifier
+            .padding(16.dp)
+    ) {
+        item {
+            Spacer(modifier = Modifier.height(48.dp))
+            Icon(
+                painter = painterResource(R.drawable.stethoscope_24px),
+                contentDescription = "stethoscope_24px",
+                modifier = Modifier
+                    .fillMaxWidth()
+                    .size(80.dp)
+            )
+            Spacer(modifier = Modifier.height(24.dp))
+            Text(
+                text = "Protection",
+                style = MaterialTheme.typography.headlineLarge,
+                modifier = Modifier
+                    .fillMaxWidth()
+                    .padding(bottom = 8.dp),
+                textAlign = TextAlign.Center
+            )
+            Text(
+                text = "Here is a list of the threats that could put you at risk",
+                style = MaterialTheme.typography.titleMedium,
+                modifier = Modifier
+                    .fillMaxWidth()
+                    .padding(bottom = 16.dp),
+                textAlign = TextAlign.Center,
+                color = Color.Gray
+            )
+        }
+        items(threats) { item ->
+            Card(
+                modifier = Modifier
+                    .padding(8.dp)
+                    .fillMaxWidth(),
+                shape = MaterialTheme.shapes.medium,
+                elevation = CardDefaults.cardElevation(1.dp)
+            ) {
+                ThreatStatusRow(threatStatus = item)
+            }
+        }
+    }
+}
+
+@Preview(showBackground = true, showSystemUi = true)
+@Composable
+private fun Preview() {
+    MobileSecurityToolkitExampleTheme {
+        ThreatStatusList()
+    }
+}

example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ThreatStatusRow.kt

@@ -0,0 +1,79 @@
+package com.exxeta.mobilesecuritytoolkitexample
+
+import androidx.compose.foundation.background
+import androidx.compose.foundation.layout.Arrangement
+import androidx.compose.foundation.layout.Box
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Row
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.padding
+import androidx.compose.foundation.layout.wrapContentHeight
+import androidx.compose.foundation.shape.CornerSize
+import androidx.compose.foundation.shape.RoundedCornerShape
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.material3.Text
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Alignment
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.draw.clip
+import androidx.compose.ui.graphics.Color
+import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.unit.dp
+import com.exxeta.mobilesecuritytoolkitexample.ui.theme.MobileSecurityToolkitExampleTheme
+
+@Composable
+fun ThreatStatusRow(threatStatus: ThreatStatus) {
+    val redColor = Color(1f, 0.23f, 0.18f)
+    val greenColor = Color(0.3f, 0.85f, 0.4f)
+
+    Column(
+        modifier = Modifier
+            .fillMaxWidth()
+            .wrapContentHeight()
+            .padding(16.dp),
+    ) {
+        Row(
+            modifier = Modifier
+                .padding(bottom = 8.dp)
+                .fillMaxWidth(),
+            verticalAlignment = Alignment.CenterVertically,
+            horizontalArrangement = Arrangement.SpaceBetween,
+        ) {
+            Text(
+                text = threatStatus.title,
+                style = MaterialTheme.typography.titleLarge,
+            )
+            Box(
+                modifier = Modifier
+                    .clip(RoundedCornerShape(CornerSize(size = 4.dp)))
+                    .background(if (threatStatus.isDetected) redColor else greenColor)
+            ) {
+                Text(
+                    text = if (threatStatus.isDetected) "DETECTED" else "SAFE",
+                    color = MaterialTheme.colorScheme.background,
+                    style = MaterialTheme.typography.bodySmall,
+                    modifier = Modifier
+                        .padding(vertical = 2.dp)
+                        .padding(horizontal = 8.dp)
+                )
+            }
+        }
+        Text(
+            threatStatus.description,
+            style = MaterialTheme.typography.titleMedium,
+            color = Color.Gray
+        )
+    }
+}
+
+@Preview(showBackground = true, showSystemUi = true)
+@Composable
+private fun Preview() {
+    MobileSecurityToolkitExampleTheme {
+        ThreatStatusRow(
+            ThreatStatus(
+                "Jailbreak", "Description", false,
+            )
+        )
+    }
+}