Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(deps): update dependency com.google.crypto.tink:tink-android to v1.16.0 #1133

Merged
merged 2 commits into from
Dec 20, 2024
Merged
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
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
package dev.alvr.katana.core.preferences.di

import android.content.Context
import android.os.Build
import androidx.annotation.RequiresApi
import com.google.crypto.tink.Aead
import com.google.crypto.tink.KeyTemplates
import com.google.crypto.tink.RegistryConfiguration
import com.google.crypto.tink.aead.AeadConfig
import com.google.crypto.tink.integration.android.AndroidKeysetManager
import com.google.crypto.tink.integration.android.AndroidKeystore
import dev.alvr.katana.core.preferences.encrypt.AndroidPreferencesEncrypt
import dev.alvr.katana.core.preferences.encrypt.PreferencesEncrypt
import org.koin.android.ext.koin.androidApplication
Expand All @@ -13,15 +18,11 @@ import org.koin.dsl.module

private val aeadModule = module {
single<Aead> {
AeadConfig.register()

AndroidKeysetManager.Builder()
.withSharedPref(androidApplication(), KEYSET_NAME, PREFERENCE_FILE)
.withKeyTemplate(KeyTemplates.get(TEMPLATE_NAME))
.withMasterKeyUri(MASTER_KEY_URI)
.build()
.keysetHandle
.getPrimitive(Aead::class.java)
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
android23Aead()
} else {
androidCompatAead(androidApplication())
}
}
}

Expand All @@ -33,7 +34,29 @@ internal actual fun encryptionModule() = module {
includes(aeadModule, securerModule)
}

private fun androidCompatAead(context: Context): Aead {
AeadConfig.register()

return AndroidKeysetManager.Builder()
.withSharedPref(context, KEYSET_NAME, PREFERENCE_FILE)
.withKeyTemplate(KeyTemplates.get(TEMPLATE_NAME))
.withMasterKeyUri(MASTER_KEY_URI)
.build()
.keysetHandle
.getPrimitive(RegistryConfiguration.get(), Aead::class.java)
}

@RequiresApi(Build.VERSION_CODES.M)
private fun android23Aead(): Aead {
if (!AndroidKeystore.hasKey(KeyStoreAlias)) {
AndroidKeystore.generateNewAes256GcmKey(KeyStoreAlias)
}
return AndroidKeystore.getAead(KeyStoreAlias)
}

private const val KEYSET_NAME = "master_keyset"
private const val PREFERENCE_FILE = "master_key_preference"
private const val MASTER_KEY_URI = "android-keystore://master_key"
private const val TEMPLATE_NAME = "AES256_GCM"

private const val KeyStoreAlias = "katana"
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ internal class AndroidPreferencesEncrypt(
private val aead: Aead,
) : PreferencesEncrypt {
override fun decrypt(input: ByteArray): ByteArray = operation("Aead decrypt") {
aead.decrypt(input, null)
aead.decrypt(input, byteArrayOf())
}

override fun encrypt(input: ByteArray): ByteArray = operation("Aead encrypt") {
aead.encrypt(input, null)
aead.encrypt(input, byteArrayOf())
}

private inline fun <R> operation(message: String, block: () -> R): R = try {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ internal class AndroidPreferencesEncryptTest : FreeSpec() {
val input = "Test".encodeToByteArray()
encrypt.decrypt(input) shouldBe "tseT".encodeToByteArray()

verify(exactly = 1) { aead.decrypt(input, null) }
verify(exactly = 1) { aead.decrypt(input, byteArrayOf()) }
}

"encrypt using Aead" {
Expand All @@ -27,7 +27,7 @@ internal class AndroidPreferencesEncryptTest : FreeSpec() {
val input = "Test".encodeToByteArray()
encrypt.encrypt(input) shouldBe "tseT".encodeToByteArray()

verify(exactly = 1) { aead.encrypt(input, null) }
verify(exactly = 1) { aead.encrypt(input, byteArrayOf()) }
}
}
}
2 changes: 1 addition & 1 deletion gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ orbit = "9.0.0"
sentry = "7.19.0"
sentry-multiplatform = "0.10.0"
sentry-plugin = "4.14.1"
tink = "1.15.0"
tink = "1.16.0"
turbine = "1.2.0"

[plugins]
Expand Down
Loading