diff --git a/example/.gitignore b/example/.gitignore new file mode 100644 index 0000000..55aa985 --- /dev/null +++ b/example/.gitignore @@ -0,0 +1,11 @@ +*.iml +.gradle +/local.properties +.idea/ +.DS_Store +/build +/captures +.externalNativeBuild +.cxx +local.properties + diff --git a/example/app/.gitignore b/example/app/.gitignore new file mode 100644 index 0000000..42afabf --- /dev/null +++ b/example/app/.gitignore @@ -0,0 +1 @@ +/build \ No newline at end of file diff --git a/example/app/build.gradle.kts b/example/app/build.gradle.kts new file mode 100644 index 0000000..1dd306b --- /dev/null +++ b/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) +} \ No newline at end of file diff --git a/example/app/proguard-rules.pro b/example/app/proguard-rules.pro new file mode 100644 index 0000000..481bb43 --- /dev/null +++ b/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 \ No newline at end of file diff --git a/example/app/src/androidTest/java/com/exxeta/mobilesecuritytoolkitexample/ExampleInstrumentedTest.kt b/example/app/src/androidTest/java/com/exxeta/mobilesecuritytoolkitexample/ExampleInstrumentedTest.kt new file mode 100644 index 0000000..2ad8a17 --- /dev/null +++ b/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) + } +} \ No newline at end of file diff --git a/example/app/src/main/AndroidManifest.xml b/example/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000..6f2de71 --- /dev/null +++ b/example/app/src/main/AndroidManifest.xml @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/MainActivity.kt b/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/MainActivity.kt new file mode 100644 index 0000000..1c04f9e --- /dev/null +++ b/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() + } + } + } +} \ No newline at end of file diff --git a/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ThreatStatus.kt b/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ThreatStatus.kt new file mode 100644 index 0000000..4bf27f1 --- /dev/null +++ b/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, +) diff --git a/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ThreatStatusList.kt b/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ThreatStatusList.kt new file mode 100644 index 0000000..b7c53e8 --- /dev/null +++ b/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() + } + + 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() + } +} \ No newline at end of file diff --git a/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ThreatStatusRow.kt b/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ThreatStatusRow.kt new file mode 100644 index 0000000..fe847bd --- /dev/null +++ b/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, + ) + ) + } +} \ No newline at end of file diff --git a/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ui/theme/Color.kt b/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ui/theme/Color.kt new file mode 100644 index 0000000..6a3458e --- /dev/null +++ b/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ui/theme/Color.kt @@ -0,0 +1,11 @@ +package com.exxeta.mobilesecuritytoolkitexample.ui.theme + +import androidx.compose.ui.graphics.Color + +val Purple80 = Color(0xFFD0BCFF) +val PurpleGrey80 = Color(0xFFCCC2DC) +val Pink80 = Color(0xFFEFB8C8) + +val Purple40 = Color(0xFF6650a4) +val PurpleGrey40 = Color(0xFF625b71) +val Pink40 = Color(0xFF7D5260) \ No newline at end of file diff --git a/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ui/theme/Theme.kt b/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ui/theme/Theme.kt new file mode 100644 index 0000000..b2645f5 --- /dev/null +++ b/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ui/theme/Theme.kt @@ -0,0 +1,57 @@ +package com.exxeta.mobilesecuritytoolkitexample.ui.theme + +import android.app.Activity +import android.os.Build +import androidx.compose.foundation.isSystemInDarkTheme +import androidx.compose.material3.MaterialTheme +import androidx.compose.material3.darkColorScheme +import androidx.compose.material3.dynamicDarkColorScheme +import androidx.compose.material3.dynamicLightColorScheme +import androidx.compose.material3.lightColorScheme +import androidx.compose.runtime.Composable +import androidx.compose.ui.platform.LocalContext + +private val DarkColorScheme = darkColorScheme( + primary = Purple80, + secondary = PurpleGrey80, + tertiary = Pink80 +) + +private val LightColorScheme = lightColorScheme( + primary = Purple40, + secondary = PurpleGrey40, + tertiary = Pink40 + + /* Other default colors to override + background = Color(0xFFFFFBFE), + surface = Color(0xFFFFFBFE), + onPrimary = Color.White, + onSecondary = Color.White, + onTertiary = Color.White, + onBackground = Color(0xFF1C1B1F), + onSurface = Color(0xFF1C1B1F), + */ +) + +@Composable +fun MobileSecurityToolkitExampleTheme( + darkTheme: Boolean = isSystemInDarkTheme(), + // Dynamic color is available on Android 12+ + dynamicColor: Boolean = true, + content: @Composable () -> Unit +) { + val colorScheme = when { + dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> { + val context = LocalContext.current + if (darkTheme) dynamicDarkColorScheme(context) else dynamicLightColorScheme(context) + } + darkTheme -> DarkColorScheme + else -> LightColorScheme + } + + MaterialTheme( + colorScheme = colorScheme, + typography = Typography, + content = content + ) +} \ No newline at end of file diff --git a/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ui/theme/Type.kt b/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ui/theme/Type.kt new file mode 100644 index 0000000..d8cd65d --- /dev/null +++ b/example/app/src/main/java/com/exxeta/mobilesecuritytoolkitexample/ui/theme/Type.kt @@ -0,0 +1,34 @@ +package com.exxeta.mobilesecuritytoolkitexample.ui.theme + +import androidx.compose.material3.Typography +import androidx.compose.ui.text.TextStyle +import androidx.compose.ui.text.font.FontFamily +import androidx.compose.ui.text.font.FontWeight +import androidx.compose.ui.unit.sp + +// Set of Material typography styles to start with +val Typography = Typography( + bodyLarge = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 16.sp, + lineHeight = 24.sp, + letterSpacing = 0.5.sp + ) + /* Other default text styles to override + titleLarge = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Normal, + fontSize = 22.sp, + lineHeight = 28.sp, + letterSpacing = 0.sp + ), + labelSmall = TextStyle( + fontFamily = FontFamily.Default, + fontWeight = FontWeight.Medium, + fontSize = 11.sp, + lineHeight = 16.sp, + letterSpacing = 0.5.sp + ) + */ +) \ No newline at end of file diff --git a/example/app/src/main/res/drawable/ic_launcher_background.xml b/example/app/src/main/res/drawable/ic_launcher_background.xml new file mode 100644 index 0000000..07d5da9 --- /dev/null +++ b/example/app/src/main/res/drawable/ic_launcher_background.xml @@ -0,0 +1,170 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/example/app/src/main/res/drawable/ic_launcher_foreground.xml b/example/app/src/main/res/drawable/ic_launcher_foreground.xml new file mode 100644 index 0000000..2b068d1 --- /dev/null +++ b/example/app/src/main/res/drawable/ic_launcher_foreground.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/example/app/src/main/res/drawable/stethoscope_24px.xml b/example/app/src/main/res/drawable/stethoscope_24px.xml new file mode 100644 index 0000000..e8bcd9c --- /dev/null +++ b/example/app/src/main/res/drawable/stethoscope_24px.xml @@ -0,0 +1,9 @@ + + + diff --git a/example/app/src/main/res/mipmap-anydpi/ic_launcher.xml b/example/app/src/main/res/mipmap-anydpi/ic_launcher.xml new file mode 100644 index 0000000..6f3b755 --- /dev/null +++ b/example/app/src/main/res/mipmap-anydpi/ic_launcher.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/example/app/src/main/res/mipmap-anydpi/ic_launcher_round.xml b/example/app/src/main/res/mipmap-anydpi/ic_launcher_round.xml new file mode 100644 index 0000000..6f3b755 --- /dev/null +++ b/example/app/src/main/res/mipmap-anydpi/ic_launcher_round.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/example/app/src/main/res/mipmap-hdpi/ic_launcher.webp b/example/app/src/main/res/mipmap-hdpi/ic_launcher.webp new file mode 100644 index 0000000..c209e78 Binary files /dev/null and b/example/app/src/main/res/mipmap-hdpi/ic_launcher.webp differ diff --git a/example/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp b/example/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp new file mode 100644 index 0000000..b2dfe3d Binary files /dev/null and b/example/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp differ diff --git a/example/app/src/main/res/mipmap-mdpi/ic_launcher.webp b/example/app/src/main/res/mipmap-mdpi/ic_launcher.webp new file mode 100644 index 0000000..4f0f1d6 Binary files /dev/null and b/example/app/src/main/res/mipmap-mdpi/ic_launcher.webp differ diff --git a/example/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp b/example/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp new file mode 100644 index 0000000..62b611d Binary files /dev/null and b/example/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp differ diff --git a/example/app/src/main/res/mipmap-xhdpi/ic_launcher.webp b/example/app/src/main/res/mipmap-xhdpi/ic_launcher.webp new file mode 100644 index 0000000..948a307 Binary files /dev/null and b/example/app/src/main/res/mipmap-xhdpi/ic_launcher.webp differ diff --git a/example/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp b/example/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp new file mode 100644 index 0000000..1b9a695 Binary files /dev/null and b/example/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp differ diff --git a/example/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp b/example/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp new file mode 100644 index 0000000..28d4b77 Binary files /dev/null and b/example/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp differ diff --git a/example/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp b/example/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp new file mode 100644 index 0000000..9287f50 Binary files /dev/null and b/example/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp differ diff --git a/example/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp b/example/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp new file mode 100644 index 0000000..aa7d642 Binary files /dev/null and b/example/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp differ diff --git a/example/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp b/example/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp new file mode 100644 index 0000000..9126ae3 Binary files /dev/null and b/example/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp differ diff --git a/example/app/src/main/res/values/colors.xml b/example/app/src/main/res/values/colors.xml new file mode 100644 index 0000000..f8c6127 --- /dev/null +++ b/example/app/src/main/res/values/colors.xml @@ -0,0 +1,10 @@ + + + #FFBB86FC + #FF6200EE + #FF3700B3 + #FF03DAC5 + #FF018786 + #FF000000 + #FFFFFFFF + \ No newline at end of file diff --git a/example/app/src/main/res/values/strings.xml b/example/app/src/main/res/values/strings.xml new file mode 100644 index 0000000..035cb81 --- /dev/null +++ b/example/app/src/main/res/values/strings.xml @@ -0,0 +1,3 @@ + + Mobile Security Toolkit Example + \ No newline at end of file diff --git a/example/app/src/main/res/values/themes.xml b/example/app/src/main/res/values/themes.xml new file mode 100644 index 0000000..326bef0 --- /dev/null +++ b/example/app/src/main/res/values/themes.xml @@ -0,0 +1,4 @@ + + +