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.

Sign up for GitHub

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

Jump to bottom

Refactor API to use an interface. #47

Merged
merged 2 commits into from
Oct 25, 2023
Merged

Refactor API to use an interface. #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7b4e7c
Refactor API to use an interface.
Jul 6, 2023
1e08d74
Merge branch 'master' of github.com:Liftric/KVault into api-as-interface
Oct 18, 2023
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
237 changes: 5 additions & 232 deletions src/androidMain/kotlin/com/liftric/kvault/KVault.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,236 +1,9 @@
package com.liftric.kvault

import android.content.Context
import android.content.SharedPreferences
import android.util.Base64
import androidx.security.crypto.EncryptedSharedPreferences
import androidx.security.crypto.MasterKey
import com.liftric.kvault.impl.KVaultImpl

actual open class KVault(context: Context, fileName: String? = null) {
private val encSharedPrefs: SharedPreferences

init {
val masterKey = MasterKey.Builder(context).setKeyScheme(MasterKey.KeyScheme.AES256_GCM).build()
encSharedPrefs = EncryptedSharedPreferences.create(
context,
fileName ?: "secure-shared-preferences",
masterKey,
EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
)
}

/**
* Saves a string value in the SharedPreferences.
* @param key The key to store
* @param stringValue The value to store
* @return True or false, depending on whether the value has been stored in the SharedPreferences
*/
actual fun set(key: String, stringValue: String): Boolean {
return encSharedPrefs
.edit()
.putString(key, stringValue)
.commit()
}

/**
* Saves an int value in the SharedPreferences.
* @param key The key to store
* @param intValue The value to store
* @return True or false, depending on whether the value has been stored in the SharedPreferences
*/
actual fun set(key: String, intValue: Int): Boolean {
return encSharedPrefs
.edit()
.putInt(key, intValue)
.commit()
}

/**
* Saves a long value in the SharedPreferences.
* @param key The key to store
* @param longValue The value to store
* @return True or false, depending on whether the value has been stored in the SharedPreferences
*/
actual fun set(key: String, longValue: Long): Boolean {
return encSharedPrefs
.edit()
.putLong(key, longValue)
.commit()
}

/**
* Saves a float value in the SharedPreferences.
* @param key The key to store
* @param floatValue The value to store
* @return True or false, depending on whether the value has been stored in the SharedPreferences
*/
actual fun set(key: String, floatValue: Float): Boolean {
return encSharedPrefs
.edit()
.putFloat(key, floatValue)
.commit()
}

/**
* Saves a double value in the SharedPreferences.
* @param key The key to store
* @param doubleValue The value to store
* @return True or false, depending on whether the value has been stored in the SharedPreferences
*/
actual fun set(key: String, doubleValue: Double): Boolean {
return encSharedPrefs
.edit()
.putLong(key, doubleValue.toRawBits())
.commit()
}

/**
* Saves a boolean value in the SharedPreferences.
* @param key The key to store
* @param boolValue The value to store
* @return True or false, depending on whether the value has been stored in the SharedPreferences
*/
actual fun set(key: String, boolValue: Boolean): Boolean {
return encSharedPrefs
.edit()
.putBoolean(key, boolValue)
.commit()
}

/**
* Saves a byte array value in the store.
* @param key The key to store
* @param dataValue The value to store
*/
actual fun set(key: String, dataValue: ByteArray): Boolean =
encSharedPrefs
.edit()
.putString(key, Base64.encodeToString(dataValue, Base64.DEFAULT))
.commit()

/**
* Checks if object with key exists in the SharedPreferences.
* @param forKey The key to query
* @return True or false, depending on whether the value has been stored in the SharedPreferences
*/
actual fun existsObject(forKey: String): Boolean {
return encSharedPrefs.contains(forKey)
}

/**
* Returns the string value of an object in the SharedPreferences.
* @param forKey The key to query
* @return The stored string value, or null if it is missing
*/
actual fun string(forKey: String): String? {
return encSharedPrefs.getString(forKey, null)
}

/**
* Returns the int value of an object in the SharedPreferences.
* @param forKey The key to query
* @return The stored int value, or null if it is missing
*/
actual fun int(forKey: String): Int? {
return if (existsObject(forKey)) {
encSharedPrefs.getInt(forKey, Int.MIN_VALUE)
} else {
null
}
}

/**
* Returns the long value of an object in the SharedPreferences.
* @param forKey The key to query
* @return The stored long value, or null if it is missing
*/
actual fun long(forKey: String): Long? {
return if (existsObject(forKey)) {
encSharedPrefs.getLong(forKey, Long.MIN_VALUE)
} else {
null
}
}

/**
* Returns the float value of an object in the SharedPreferences.
* @param forKey The key to query
* @return The stored float value, or null if it is missing
*/
actual fun float(forKey: String): Float? {
return if (existsObject(forKey)) {
encSharedPrefs.getFloat(forKey, Float.MIN_VALUE)
} else {
null
}
}

/**
* Returns the double value of an object in the SharedPreferences.
* @param forKey The key to query
* @return The stored double value, or null if it is missing
*/
actual fun double(forKey: String): Double? {
return if (existsObject(forKey)) {
Double.fromBits(encSharedPrefs.getLong(forKey, Double.MIN_VALUE.toRawBits()))
} else {
null
}
}

/**
* Returns the boolean value of an object in the SharedPreferences.
* @param forKey The key to query
* @return The stored boolean value, or null if it is missing
*/
actual fun bool(forKey: String): Boolean? {
return if (existsObject(forKey)) {
encSharedPrefs.getBoolean(forKey, false)
} else {
null
}
}

/**
* Returns the data value of an object in the store.
* @param forKey The key to query
* @return The stored bytes value
*/
actual fun data(forKey: String): ByteArray? {
return encSharedPrefs.getString(forKey, null)?.let {
Base64.decode(it, Base64.DEFAULT)
}
}

/**
* Returns all keys of the objects in the SharedPreferences.
* @return A list with all keys
*/
actual fun allKeys(): List<String> {
return encSharedPrefs.all.map { it.key }
}

/**
* Deletes object with the given key from the SharedPreferences.
* @param forKey The key to query
* @return True or false, depending on whether the object has been deleted
*/
actual fun deleteObject(forKey: String): Boolean {
return encSharedPrefs
.edit()
.remove(forKey)
.commit()
}

/**
* Deletes all objects from the SharedPreferences.
* @return True or false, depending on whether the objects have been deleted
*/
actual fun clear(): Boolean {
return encSharedPrefs
.edit()
.clear()
.commit()
}
}
fun KVault(
context: Context,
fileName: String? = null
): KVault = KVaultImpl(context, fileName)
Loading
Loading