🔐 Secure Preference — Secure Wrapper for SharedPreferences

SecurePreference is a safe and easy-to-use wrapper around SharedPreferences, utilizing EncryptedSharedPreferences from androidx.security.crypto for data encryption. It provides a convenient API with Flow support and secure key storage using the Android Keystore.

⚠️ ⚠️ ⚠️ Warning: Jetpack Security Crypto Library Deprecated ⚠️ ⚠️ ⚠️

Please be aware that the Jetpack Security Crypto library (androidx.security:security-crypto) is deprecated and no longer actively maintained. Refs, Issue, Post

Recommendation:

It is strongly recommended to migrate to alternative, actively maintained cryptographic libraries for secure key management and encryption. Options such as the Android Keystore system and other third-party libraries provide more robust and secure solutions.

For more details on the deprecation, please refer to the official Jetpack Security documentation and consider exploring alternative approaches for cryptography in your app.

By using deprecated libraries, you risk the security and stability of your application.

🚀 Features

• 🔑 Full Encryption — All data is stored in EncryptedSharedPreferences, preventing compromise.
• 📡 Flow Support — Receive real-time data updates.
• ⚡ Ease of Use — A lightweight API with no complex configurations.
• 🔄 Automatic Updates — Track data changes with minimal code.
• 📌 Support for Various Data Types — Boolean, Int, String, Float, Long, Double, Set<String>, Serializible and Parcelable.
• 💨 Asynchronous Operations — Works with Flow for high performance.
• 💾 Batch Write and Delete — Save multiple values at once.
• 🛠️ Flexibility — Use multiple SecurePreference instances with different keys.

## 🔄 SecurePreference vs SharedPreferences vs DataStore

| Feature                     | SecurePreference | SharedPreferences | DataStore |
|-----------------------------|------------------|-------------------|----------|
| built-in Data Encryption    | ✅ Yes           | ❌ No              | ❌ No     |
| Flow Support                | ✅ Yes           | ❌ No              | ✅ Yes     |
| Keystore Integration        | ✅ Yes           | ❌ No              | ❌ No     |
| Simple API                  | ✅ Yes           | ✅ Yes             | ❌ No     |
| Performance                 | ⚡ High           | ⚡ High            | 🐢 Slow   |
| Complex Data Structures     | ✅ Yes           | ❌ No              | ✅ Yes     |


## 📦 Installation

Add the dependency to `build.gradle.kts`:

```kotlin
dependencies {
    implementation("com.github.droidbaza:securepreference:$latestVersion")
}

🛠 Usage

🔹 Initialization

   val securePrefs by SecurePrefs(this)
   or
   val sp:SecurePreference = SecurePreferenceImpl(context)
   

🔹 Saving Data

securePreference.put("user_token", "123456")
securePreference.put("isLoggedIn", true)
securePreference.put("settings", setOf("dark_mode", "notifications"))

🔹 Retrieving Data

val token = securePrefs.get("user_token","")
val isLoggedIn = securePrefs.get("isLoggedIn", false)

🔹 Retrieving Data with Flow

securePreference.keyResult("user_token", "").collect { token ->
    println("Current token: $token")
}

🔹 Deleting Data

securePreference.clear("user_token")
securePreference.clear("isLoggedIn", "settings")

🔹 Tracking All Changes

securePreference.keys().collect { key ->
    println("Key changed: $key")
}

🤝 Community Support

Contributions are welcome! 🚀

📝 License

This project is licensed under MIT.
Happy coding! 💻✨