Merge pull request #279 from IO-Design-Team/feature/isolated-hive-checksum-cipher-fix

IsolatedHive checksum cipher fix

Author: Rexios80

hive/CHANGELOG.md

@@ -1,5 +1,6 @@
-## NEXT
+## 2.18.0
 
+- Fixes an issue with IsolatedHive encryption
 - Automatically disables the unsafe isolate warning when running in a test
 
 ## 2.17.0

hive/lib/src/backend/js/native/backend_manager.dart

@@ -18,6 +18,7 @@ class BackendManager implements BackendManagerInterface {
     String? path,
     bool crashRecovery,
     HiveCipher? cipher,
+    int? keyCrc,
     String? collection,
   ) async {
     // compatibility for old store format

hive/lib/src/backend/storage_backend.dart

@@ -54,6 +54,7 @@ abstract class BackendManagerInterface {
     String? path,
     bool crashRecovery,
     HiveCipher? cipher,
+    int? keyCrc,
     String? collection,
   );
 

hive/lib/src/backend/storage_backend_memory.dart

@@ -9,13 +9,14 @@ import 'package:hive_ce/src/box/keystore.dart';
 /// In-memory Storage backend
 class StorageBackendMemory extends StorageBackend {
   final HiveCipher? _cipher;
+  final int? _keyCrc;
 
   final FrameHelper _frameHelper;
 
   Uint8List? _bytes;
 
   /// Not part of public API
-  StorageBackendMemory(Uint8List? bytes, this._cipher)
+  StorageBackendMemory(Uint8List? bytes, this._cipher, this._keyCrc)
       : _bytes = bytes,
         _frameHelper = FrameHelper();
 
@@ -37,6 +38,7 @@ class StorageBackendMemory extends StorageBackend {
       keystore,
       registry,
       _cipher,
+      _keyCrc,
     );
 
     if (recoveryOffset != -1) {

hive/lib/src/backend/stub/backend_manager.dart

@@ -17,6 +17,7 @@ class BackendManager implements BackendManagerInterface {
     String? path,
     bool crashRecovery,
     HiveCipher? cipher,
+    int? keyCrc,
     String? collection,
   ) {
     throw UnimplementedError();

hive/lib/src/backend/vm/backend_manager.dart

@@ -23,6 +23,7 @@ class BackendManager implements BackendManagerInterface {
     String? path,
     bool crashRecovery,
     HiveCipher? cipher,
+    int? keyCrc,
     String? collection,
   ) async {
     if (path == null) {
@@ -45,7 +46,8 @@ class BackendManager implements BackendManagerInterface {
     final file = await findHiveFileAndCleanUp(name, path);
     final lockFile = File('$path$_delimiter$name.lock');
 
-    final backend = StorageBackendVm(file, lockFile, crashRecovery, cipher);
+    final backend =
+        StorageBackendVm(file, lockFile, crashRecovery, cipher, keyCrc);
     await backend.open();
     return backend;
   }

hive/lib/src/backend/vm/storage_backend_vm.dart

@@ -18,25 +18,11 @@ import 'package:meta/meta.dart';
 
 /// Storage backend for the Dart VM
 class StorageBackendVm extends StorageBackend {
-  /// Warning for existing lock of unmatched isolation
-  @visibleForTesting
-  static const unmatchedIsolationWarning = '''
-⚠️ WARNING: HIVE MULTI-ISOLATE RISK DETECTED ⚠️
-
-You are opening this box with Hive, but this box was previously opened with
-IsolatedHive. This can lead to DATA CORRUPTION as Hive boxes are not designed
-for concurrent access across isolates. Each isolate would maintain its own box
-cache, potentially causing data inconsistency and corruption.
-
-RECOMMENDED ACTIONS:
-- ALWAYS use IsolatedHive to perform box operations when working with multiple
-  isolates
-''';
-
   final File _file;
   final File _lockFile;
   final bool _crashRecovery;
   final HiveCipher? _cipher;
+  final int? _keyCrc;
   final FrameIoHelper _frameHelper;
 
   final ReadWriteSync _sync;
@@ -73,6 +59,7 @@ RECOMMENDED ACTIONS:
     this._lockFile,
     this._crashRecovery,
     this._cipher,
+    this._keyCrc,
   )   : _frameHelper = FrameIoHelper(),
         _sync = ReadWriteSync();
 
@@ -82,6 +69,7 @@ RECOMMENDED ACTIONS:
     this._lockFile,
     this._crashRecovery,
     this._cipher,
+    this._keyCrc,
     this._frameHelper,
     this._sync,
   );
@@ -116,7 +104,7 @@ RECOMMENDED ACTIONS:
         props = LockProps();
       }
       if (Logger.unmatchedIsolationWarning && props.isolated && !isolated) {
-        Logger.w(unmatchedIsolationWarning);
+        Logger.w(HiveWarning.unmatchedIsolation);
       }
     }
 
@@ -132,10 +120,12 @@ RECOMMENDED ACTIONS:
         keystore,
         registry,
         _cipher,
+        _keyCrc,
         verbatim: isolated,
       );
     } else {
-      recoveryOffset = await _frameHelper.keysFromFile(path, keystore, _cipher);
+      recoveryOffset =
+          await _frameHelper.keysFromFile(path, keystore, _cipher, _keyCrc);
     }
 
     if (recoveryOffset != -1) {
@@ -158,8 +148,12 @@ RECOMMENDED ACTIONS:
       final bytes = await readRaf.read(frame.length!);
 
       final reader = BinaryReaderImpl(bytes, registry);
-      final readFrame =
-          reader.readFrame(cipher: _cipher, lazy: false, verbatim: verbatim);
+      final readFrame = reader.readFrame(
+        cipher: _cipher,
+        keyCrc: _keyCrc,
+        lazy: false,
+        verbatim: verbatim,
+      );
 
       if (readFrame == null) {
         throw HiveError(
@@ -177,8 +171,12 @@ RECOMMENDED ACTIONS:
       final writer = BinaryWriterImpl(registry);
 
       for (final frame in frames) {
-        frame.length =
-            writer.writeFrame(frame, cipher: _cipher, verbatim: verbatim);
+        frame.length = writer.writeFrame(
+          frame,
+          cipher: _cipher,
+          keyCrc: _keyCrc,
+          verbatim: verbatim,
+        );
       }
 
       try {

hive/lib/src/binary/binary_reader_impl.dart

@@ -7,6 +7,7 @@ import 'package:hive_ce/src/crypto/crc32.dart';
 import 'package:hive_ce/src/object/hive_list_impl.dart';
 import 'package:hive_ce/src/registry/type_registry_impl.dart';
 import 'package:hive_ce/src/util/extensions.dart';
+import 'package:hive_ce/src/util/logger.dart';
 import 'package:meta/meta.dart';
 
 /// Not part of public API
@@ -19,6 +20,8 @@ class BinaryReaderImpl extends BinaryReader {
   int _bufferLimit;
   var _offset = 0;
 
+  var _crcRecomputeWarningPrinted = false;
+
   /// Not part of public API
   BinaryReaderImpl(this._buffer, TypeRegistry typeRegistry, [int? bufferLength])
       : _byteData = ByteData.view(_buffer.buffer, _buffer.offsetInBytes),
@@ -259,6 +262,7 @@ class BinaryReaderImpl extends BinaryReader {
   /// Not part of public API
   Frame? readFrame({
     HiveCipher? cipher,
+    int? keyCrc,
     bool lazy = false,
     int frameOffset = 0,
     bool verbatim = false,
@@ -274,15 +278,35 @@ class BinaryReaderImpl extends BinaryReader {
     if (availableBytes < frameLength - 4) return null;
 
     final crc = _buffer.readUint32(_offset + frameLength - 8);
+    final crcOffset = _offset - 4;
+    final crcLength = frameLength - 4;
     final computedCrc = Crc32.compute(
       _buffer,
-      offset: _offset - 4,
-      length: frameLength - 4,
-      crc: cipher?.calculateKeyCrc() ?? 0,
+      offset: crcOffset,
+      length: crcLength,
+      crc: keyCrc ?? cipher?.calculateKeyCrc() ?? 0,
     );
 
     // frame is corrupted or provided chiper is different
-    if (computedCrc != crc) return null;
+    if (computedCrc != crc) {
+      if (keyCrc != null) {
+        // Attempt to compute the crc without the key crc
+        // This maintains compatibility with data written by IsolatedHive before keyCrc was introduced
+        final computedCrc2 = Crc32.compute(
+          _buffer,
+          offset: crcOffset,
+          length: crcLength,
+        );
+        if (computedCrc2 != crc) return null;
+
+        if (Logger.crcRecomputeWarning && !_crcRecomputeWarningPrinted) {
+          Logger.w(HiveWarning.crcRecomputeNeeded);
+          _crcRecomputeWarningPrinted = true;
+        }
+      } else {
+        return null;
+      }
+    }
 
     _limitAvailableBytes(frameLength - 8);
     Frame frame;

hive/lib/src/binary/binary_writer_impl.dart

@@ -6,7 +6,6 @@ import 'package:hive_ce/src/binary/frame.dart';
 import 'package:hive_ce/src/crypto/crc32.dart';
 import 'package:hive_ce/src/object/hive_list_impl.dart';
 import 'package:hive_ce/src/registry/type_registry_impl.dart';
-import 'package:hive_ce/src/util/debug_utils.dart';
 import 'package:hive_ce/src/util/extensions.dart';
 import 'package:hive_ce/src/util/logger.dart';
 import 'package:meta/meta.dart';
@@ -18,12 +17,6 @@ class BinaryWriterImpl extends BinaryWriter {
   /// The maximum integer that can be stored in a 64 bit float (2^53)
   static const maxInt = 9007199254740992;
 
-  /// Warning message printed when attempting to store an integer that is too large
-  static const intWarning =
-      'WARNING: Writing integer values greater than 2^53 will result in precision loss. '
-      'This is due to Hive storing all numbers as 64 bit floats. '
-      'Consider using a BigInt.';
-
   /// The type registry to use for writing values
   final TypeRegistryImpl typeRegistry;
   var _buffer = Uint8List(_initBufferSize);
@@ -107,7 +100,9 @@ class BinaryWriterImpl extends BinaryWriter {
   @override
   void writeInt(int value) {
     // Web truncates values greater than 2^53 to 2^53
-    if (kDebugMode && value >= maxInt) Logger.w(intWarning);
+    if (Logger.bigIntWarning && value >= maxInt) {
+      Logger.w(HiveWarning.bigInt);
+    }
     writeDouble(value.toDouble());
   }
 
@@ -265,7 +260,12 @@ class BinaryWriterImpl extends BinaryWriter {
   }
 
   /// Not part of public API
-  int writeFrame(Frame frame, {HiveCipher? cipher, bool verbatim = false}) {
+  int writeFrame(
+    Frame frame, {
+    HiveCipher? cipher,
+    int? keyCrc,
+    bool verbatim = false,
+  }) {
     final startOffset = _offset;
     _reserveBytes(4);
     _offset += 4; // reserve bytes for length
@@ -289,7 +289,7 @@ class BinaryWriterImpl extends BinaryWriter {
       _buffer,
       offset: startOffset,
       length: frameLength - 4,
-      crc: cipher?.calculateKeyCrc() ?? 0,
+      crc: keyCrc ?? cipher?.calculateKeyCrc() ?? 0,
     );
     writeUint32(crc);
 

hive/lib/src/binary/frame_helper.dart

@@ -11,7 +11,8 @@ class FrameHelper {
     Uint8List bytes,
     Keystore? keystore,
     TypeRegistry registry,
-    HiveCipher? cipher, {
+    HiveCipher? cipher,
+    int? keyCrc, {
     bool verbatim = false,
   }) {
     final reader = BinaryReaderImpl(bytes, registry);
@@ -21,6 +22,7 @@ class FrameHelper {
 
       final frame = reader.readFrame(
         cipher: cipher,
+        keyCrc: keyCrc,
         lazy: false,
         frameOffset: frameOffset,
         verbatim: verbatim,