OmniKV: Secure Storage

The official flutter_secure_storage adapter for OmniKV. Perfect for securely storing auth tokens, API keys, and sensitive user data.

Installation

You must install both the adapter and the underlying storage package:

flutter pub add omni_kv omni_kv_secure_storage flutter_secure_storage

Quick Start

Initialize your KvGateway with the SecureStorageKvAdapter:

import 'package:omni_kv/omni_kv.dart';
import 'package:omni_kv_secure_storage/omni_kv_secure_storage.dart';
import 'package:flutter_secure_storage/flutter_secure_storage.dart';

void main() {
  const storage = FlutterSecureStorage();
  
  final kv = KvGateway(
    SecureStorageKvAdapter(
      storage,
      codec: const SecureStorageKvCodec(prefix: 'my_app.secure.'),
    ),
  );

  // Ready to use!
}

Features & Limitations

• Automatic Serialization: flutter_secure_storage only accepts Strings natively. This adapter will automatically jsonEncode and jsonDecode non-string primitives (like integers or maps) for you.
• Platform Behavior: All platform-specific secure storage rules (Keychain on iOS, EncryptedSharedPreferences on Android) are provided by the underlying plugin.
• Scoped Clearing: If you provide a prefix to the codec, calling kv.clear() will only remove secure-storage keys that start with that prefix.

For full documentation on how to define keys and use the fluent API, see the core OmniKV package.