Secure, encrypted AES-256-GCM key-value storage offering type-safe entries, Flow-based observation, coroutine-friendly async API, object serialization, hardware-backed key protection and flexible builder configuration.
A Kotlin Multiplatform secure encrypted key-value storage library.
*JS/WASM uses simplified encryption due to Web Crypto API limitations
Add the dependency to your build.gradle.kts:
// For Kotlin Multiplatform projects
kotlin {
sourceSets {
commonMain.dependencies {
implementation("in.sitharaj:vaultkmp:1.0.0")
}
}
}
// For Android/JVM only projects
dependencies {
implementation("in.sitharaj:vaultkmp:1.0.0")
}
import `in`.sitharaj.vaultkmp.VaultStore
import `in`.sitharaj.vaultkmp.VaultConfig
// Create a vault instance
val vault = VaultStore.create {
name("my_secrets")
encryptionLevel(EncryptionLevel.HIGH)
}
vault.putString(, )
vault.putInt(, )
vault.putBoolean(, )
token = vault.getString()
userId = vault.getInt(, default = )
// Define type-safe entries
val tokenEntry = vault.stringEntry("auth_token")
val userIdEntry = vault.intEntry("user_id", default = 0)
val isPremiumEntry = vault.booleanEntry("is_premium", default = false)
// Use entries
tokenEntry.set("new_token")
val token = tokenEntry.get()
val hasToken = tokenEntry.isSet()
tokenEntry.remove()
@Serializable
data class UserSettings(
val theme: String,
val notifications: Boolean
)
val settingsEntry = vault.objectEntry(
key = "settings",
serializer = UserSettings.serializer(),
default = UserSettings("light", true)
)
settingsEntry.set(UserSettings("dark", false))
val settings = settingsEntry.getOrDefault()
vault.observeString("auth_token").collect { token ->
println("Token changed: $token")
}
Initialize in your Application class:
class MyApplication : Application() {
override fun onCreate() {
super.onCreate()
// Initialize VaultKMP with context
PlatformVault.initialize(this)
}
}
No special setup required. Uses NSUserDefaults with AES-256-GCM encryption.
No special setup required. Files stored in ~/.vaultkmp/.
Copyright 2024 Sitharaj Seenivasan
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
| Platform | Encryption | Storage |
|---|
| Android | Android Keystore + AES-256-GCM | DataStore Preferences |
| iOS | NSUserDefaults + AES-256-GCM | NSUserDefaults |
| Desktop | AES-256-GCM (PBKDF2) | Encrypted Files |
| JS/WASM | XOR obfuscation* | localStorage |
| Method | Description |
|---|
putString/getString | Store/retrieve string values |
putInt/getInt | Store/retrieve integer values |
putLong/getLong | Store/retrieve long values |
putBoolean/getBoolean | Store/retrieve boolean values |
putFloat/getFloat | Store/retrieve float values |
putDouble/getDouble | Store/retrieve double values |
putBytes/getBytes | Store/retrieve raw bytes |
putObject/getObject | Store/retrieve serializable objects |
contains(key) | Check if key exists |
remove(key) | Remove a value |
clear() | Remove all values |
keys() | Get all stored keys |
| Method | Default | Description |
|---|
name(string) | "default_vault" | Unique vault name |
encryptionLevel(level) | HIGH | NONE, STANDARD, or HIGH |
keyAlias(string) | "vault_master_key" | Key alias for hardware storage |
cacheDuration(duration) | null (forever) | In-memory cache duration |
Surfaced from shared tags and platforms — no rankings paid for.