Skip to content

Commit d9d5388

Browse files
theDeniZtheDeniZ
authored
Encryption Example (#1)
* 00: add readme Signed-off-by: Denis Dobanda <[email protected]> * 00: add initial keystore example Signed-off-by: Denis Dobanda <[email protected]> * 00: implement crypto toolbox Signed-off-by: Denis Dobanda <[email protected]> --------- Signed-off-by: Denis Dobanda <[email protected]> Co-authored-by: Denis Dobanda <[email protected]>
1 parent ef6bdc2 commit d9d5388

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1105
-1
lines changed

‎Keystore-Example/.gitignore

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
*.iml
2+
.gradle
3+
/local.properties
4+
/.idea/caches
5+
/.idea/libraries
6+
/.idea/modules.xml
7+
/.idea/workspace.xml
8+
/.idea/navEditor.xml
9+
/.idea/assetWizardSettings.xml
10+
.DS_Store
11+
/build
12+
/captures
13+
.externalNativeBuild
14+
.cxx
15+
local.properties

‎Keystore-Example/REAMDE.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Example of encryption using Keystore
2+
3+
## Description
4+
5+
This project shows an example of how to use the Android Keystore to encrypt and
6+
decrypt String values.
7+
8+
See full example
9+
in [CryptoToolboxImpl](./app/src/main/java/com/exxeta/keystoreexample/CryptoToolboxImpl.kt)
10+
class
11+
12+
## How to use the project
13+
14+
The project was tested on Android 14. Use latest Android Studio version
15+
16+
## Structure of the project
17+
18+
### `CryptoToolbox`
19+
20+
Interface for a CryptoToolbox
21+
22+
### `CryptoToolboxImpl`
23+
24+
Implementation of CryptoToolbox. Use it as it seems fit
25+
26+
### `EncryptionException`
27+
28+
An exception class to use in CryptoToolbox

‎Keystore-Example/app/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/build

‎Keystore-Example/app/build.gradle.kts

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
plugins {
2+
id("com.android.application")
3+
id("org.jetbrains.kotlin.android")
4+
}
5+
6+
android {
7+
namespace = "com.exxeta.keystoreexample"
8+
compileSdk = 34
9+
10+
defaultConfig {
11+
applicationId = "com.exxeta.keystoreexample"
12+
minSdk = 28
13+
targetSdk = 34
14+
versionCode = 1
15+
versionName = "1.0"
16+
17+
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
18+
vectorDrawables {
19+
useSupportLibrary = true
20+
}
21+
}
22+
23+
buildTypes {
24+
release {
25+
isMinifyEnabled = false
26+
proguardFiles(
27+
getDefaultProguardFile("proguard-android-optimize.txt"),
28+
"proguard-rules.pro"
29+
)
30+
}
31+
}
32+
compileOptions {
33+
sourceCompatibility = JavaVersion.VERSION_1_8
34+
targetCompatibility = JavaVersion.VERSION_1_8
35+
}
36+
kotlinOptions {
37+
jvmTarget = "1.8"
38+
}
39+
buildFeatures {
40+
compose = true
41+
}
42+
composeOptions {
43+
kotlinCompilerExtensionVersion = "1.5.1"
44+
}
45+
packaging {
46+
resources {
47+
excludes += "/META-INF/{AL2.0,LGPL2.1}"
48+
}
49+
}
50+
}
51+
52+
dependencies {
53+
54+
implementation("androidx.core:core-ktx:1.13.1")
55+
implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.8.4")
56+
implementation("androidx.activity:activity-compose:1.9.1")
57+
implementation(platform("androidx.compose:compose-bom:2023.08.00"))
58+
implementation("androidx.compose.ui:ui")
59+
implementation("androidx.compose.ui:ui-graphics")
60+
implementation("androidx.compose.ui:ui-tooling-preview")
61+
implementation("androidx.compose.material3:material3")
62+
63+
implementation("androidx.security:security-crypto:1.0.0")
64+
65+
testImplementation("junit:junit:4.13.2")
66+
androidTestImplementation("androidx.test.ext:junit:1.2.1")
67+
androidTestImplementation("androidx.test.espresso:espresso-core:3.6.1")
68+
androidTestImplementation(platform("androidx.compose:compose-bom:2023.08.00"))
69+
androidTestImplementation("androidx.compose.ui:ui-test-junit4")
70+
debugImplementation("androidx.compose.ui:ui-tooling")
71+
debugImplementation("androidx.compose.ui:ui-test-manifest")
72+
}

‎Keystore-Example/app/proguard-rules.pro

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Add project specific ProGuard rules here.
2+
# You can control the set of applied configuration files using the
3+
# proguardFiles setting in build.gradle.
4+
#
5+
# For more details, see
6+
# http://developer.android.com/guide/developing/tools/proguard.html
7+
8+
# If your project uses WebView with JS, uncomment the following
9+
# and specify the fully qualified class name to the JavaScript interface
10+
# class:
11+
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12+
# public *;
13+
#}
14+
15+
# Uncomment this to preserve the line number information for
16+
# debugging stack traces.
17+
#-keepattributes SourceFile,LineNumberTable
18+
19+
# If you keep the line number information, uncomment this to
20+
# hide the original source file name.
21+
#-renamesourcefileattribute SourceFile

‎Keystore-Example/app/src/androidTest/java/com/exxeta/keystoreexample/ExampleInstrumentedTest.kt

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
package com.exxeta.keystoreexample
2+
3+
import androidx.test.platform.app.InstrumentationRegistry
4+
import androidx.test.ext.junit.runners.AndroidJUnit4
5+
6+
import org.junit.Test
7+
import org.junit.runner.RunWith
8+
9+
import org.junit.Assert.*
10+
11+
/**
12+
* Instrumented test, which will execute on an Android device.
13+
*
14+
* See [testing documentation](http://d.android.com/tools/testing).
15+
*/
16+
@RunWith(AndroidJUnit4::class)
17+
class ExampleInstrumentedTest {
18+
@Test
19+
fun useAppContext() {
20+
// Context of the app under test.
21+
val appContext =
22+
InstrumentationRegistry.getInstrumentation().targetContext
23+
assertEquals("com.exxeta.keystoreexample", appContext.packageName)
24+
}
25+
}

‎Keystore-Example/app/src/main/AndroidManifest.xml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
3+
xmlns:tools="http://schemas.android.com/tools">
4+
5+
<application
6+
android:allowBackup="true"
7+
android:dataExtractionRules="@xml/data_extraction_rules"
8+
android:fullBackupContent="@xml/backup_rules"
9+
android:icon="@mipmap/ic_launcher"
10+
android:label="@string/app_name"
11+
android:roundIcon="@mipmap/ic_launcher_round"
12+
android:supportsRtl="true"
13+
android:theme="@style/Theme.KeystoreExample"
14+
tools:targetApi="31">
15+
<activity
16+
android:name=".MainActivity"
17+
android:exported="true"
18+
android:label="@string/app_name"
19+
android:theme="@style/Theme.KeystoreExample">
20+
<intent-filter>
21+
<action android:name="android.intent.action.MAIN"/>
22+
23+
<category android:name="android.intent.category.LAUNCHER"/>
24+
</intent-filter>
25+
</activity>
26+
</application>
27+
28+
</manifest>

‎Keystore-Example/app/src/main/java/com/exxeta/keystoreexample/CryptoToolbox.kt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
package com.exxeta.keystoreexample
2+
3+
interface CryptoToolbox {
4+
fun getValueFor(key: String, doubleEncryption: Boolean = true): String?
5+
6+
fun setValueFor(
7+
key: String,
8+
value: String,
9+
doubleEncryption: Boolean = true,
10+
)
11+
12+
fun deleteValueFor(key: String)
13+
}

0 commit comments

Comments
 (0)