Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,7 @@ Free models accessible via an API can be found [here](https://github.com/cheahjs
If you in your Google account identified as under 18, you need an adult account because Google is (unreasonably) denying you the API key.

Preview models will eventually be removed by Google and unfortunately won't be redirected to finished equivalents. If this happens, please change the API in the code.

## CI Release Signing

Dokumentation für CI-Secrets und Verhalten bei fehlender Signing-Konfiguration: [docs/ci-signing.md](docs/ci-signing.md)
38 changes: 37 additions & 1 deletion app/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

plugins {
id("com.android.application")
id("org.jetbrains.kotlin.android")
Expand All @@ -14,6 +13,21 @@ System.getenv("SCREENOPERATOR_BUILD_DIR")?.takeIf { it.isNotBlank() }?.let { cus
layout.buildDirectory = file(customBuildDir)
}

val releaseSigningEnv = mapOf(
"ANDROID_KEYSTORE_PATH" to System.getenv("ANDROID_KEYSTORE_PATH"),
"ANDROID_KEY_ALIAS" to System.getenv("ANDROID_KEY_ALIAS"),
"ANDROID_KEYSTORE_PASSWORD" to System.getenv("ANDROID_KEYSTORE_PASSWORD"),
"ANDROID_KEY_PASSWORD" to System.getenv("ANDROID_KEY_PASSWORD"),
)

val missingReleaseSigningEnv = releaseSigningEnv
.filterValues { it.isNullOrBlank() }
.keys

val isReleaseTaskRequested = gradle.startParameter.taskNames.any { task ->
task.contains("release", ignoreCase = true)
}

android {
namespace = "com.google.ai.sample"
compileSdk = 35
Expand All @@ -34,12 +48,27 @@ android {
}
}

signingConfigs {
create("release") {
if (missingReleaseSigningEnv.isEmpty()) {
storeFile = file(releaseSigningEnv.getValue("ANDROID_KEYSTORE_PATH")!!)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛑 Security Vulnerability: Using file() with environment variable path enables path traversal attacks1. An attacker controlling ANDROID_KEYSTORE_PATH could read arbitrary files from the build system (e.g., ../../../../etc/passwd). Validate the path resolves within expected directories or use absolute path validation before passing to file().

Footnotes

  1. CWE-22: Path Traversal - https://cwe.mitre.org/data/definitions/22.html

storePassword = releaseSigningEnv.getValue("ANDROID_KEYSTORE_PASSWORD")
keyAlias = releaseSigningEnv.getValue("ANDROID_KEY_ALIAS")
keyPassword = releaseSigningEnv.getValue("ANDROID_KEY_PASSWORD")
}
}
}

buildTypes {
getByName("debug") {
isDebuggable = true
}
getByName("release") {
isDebuggable = false
if (missingReleaseSigningEnv.isEmpty()) {
signingConfig = signingConfigs.getByName("release")
}
}
}
create("samples") {
initWith(getByName("debug"))
Expand Down Expand Up @@ -67,6 +96,13 @@ android {
}
}

if (isReleaseTaskRequested && missingReleaseSigningEnv.isNotEmpty()) {
error(
"Release signing env vars missing for module :app: ${missingReleaseSigningEnv.joinToString(", ")}. " +
"Set ANDROID_KEYSTORE_PATH, ANDROID_KEY_ALIAS, ANDROID_KEYSTORE_PASSWORD and ANDROID_KEY_PASSWORD."
)
}

dependencies {
constraints {
implementation("org.jetbrains.kotlin:kotlin-stdlib:1.9.20")
Expand Down
19 changes: 19 additions & 0 deletions docs/ci-signing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# CI Signing für Release-Builds

Die Module `app` und `humanoperator` erwarten für Release-Tasks eine Signing-Konfiguration über Umgebungsvariablen.

## Benötigte CI-Secrets

- `ANDROID_KEYSTORE_PATH`: Absoluter oder relativ zum Projekt auflösbarer Pfad zur Keystore-Datei.
- `ANDROID_KEY_ALIAS`: Alias des Release-Keys.
- `ANDROID_KEYSTORE_PASSWORD`: Passwort der Keystore-Datei.
- `ANDROID_KEY_PASSWORD`: Passwort des Keys.

## Verhalten bei fehlenden Variablen

- Für **Release-Tasks** (Taskname enthält `release`) wird der Build mit einer klaren Fehlermeldung abgebrochen, wenn eine der Variablen fehlt.
- Für Nicht-Release-Tasks bleibt die Signing-Config ungesetzt, damit lokale Debug-Builds weiter funktionieren.

## Wichtiger Hinweis zu Firebase

`google-services.json` bleibt unverändert versioniert und ist **nicht** Teil der Signing-Logik.
37 changes: 37 additions & 0 deletions humanoperator/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ plugins {
id("com.google.gms.google-services")
}

val releaseSigningEnv = mapOf(
"ANDROID_KEYSTORE_PATH" to System.getenv("ANDROID_KEYSTORE_PATH"),
"ANDROID_KEY_ALIAS" to System.getenv("ANDROID_KEY_ALIAS"),
"ANDROID_KEYSTORE_PASSWORD" to System.getenv("ANDROID_KEYSTORE_PASSWORD"),
"ANDROID_KEY_PASSWORD" to System.getenv("ANDROID_KEY_PASSWORD"),
)

val missingReleaseSigningEnv = releaseSigningEnv
.filterValues { it.isNullOrBlank() }
.keys

val isReleaseTaskRequested = gradle.startParameter.taskNames.any { task ->
task.contains("release", ignoreCase = true)
}

android {
namespace = "com.screenoperator.humanoperator"
compileSdk = 35
Expand All @@ -21,10 +36,25 @@ android {
}
}

signingConfigs {
create("release") {
if (missingReleaseSigningEnv.isEmpty()) {
storeFile = file(releaseSigningEnv.getValue("ANDROID_KEYSTORE_PATH")!!)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛑 Security Vulnerability: Using file() with environment variable path enables path traversal attacks1. An attacker controlling ANDROID_KEYSTORE_PATH could read arbitrary files from the build system (e.g., ../../../../etc/passwd). Validate the path resolves within expected directories or use absolute path validation before passing to file().

Footnotes

  1. CWE-22: Path Traversal - https://cwe.mitre.org/data/definitions/22.html

storePassword = releaseSigningEnv.getValue("ANDROID_KEYSTORE_PASSWORD")
keyAlias = releaseSigningEnv.getValue("ANDROID_KEY_ALIAS")
keyPassword = releaseSigningEnv.getValue("ANDROID_KEY_PASSWORD")
}
}
}

buildTypes {
release {
isMinifyEnabled = false
proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
if (missingReleaseSigningEnv.isEmpty()) {
signingConfig = signingConfigs.getByName("release")
}
}
}
}

Expand All @@ -43,6 +73,13 @@ android {
}
}

if (isReleaseTaskRequested && missingReleaseSigningEnv.isNotEmpty()) {
error(
"Release signing env vars missing for module :humanoperator: ${missingReleaseSigningEnv.joinToString(", ")}. " +
"Set ANDROID_KEYSTORE_PATH, ANDROID_KEY_ALIAS, ANDROID_KEYSTORE_PASSWORD and ANDROID_KEY_PASSWORD."
)
}

dependencies {
implementation("androidx.core:core-ktx:1.9.0")
implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.6.2")
Expand Down
Loading