`isEncryptionEnabled()` returns true even after `reKey("")`

[mrousavy]

The language of MMKV

C++

The version of MMKV

2.3.0

The platform of MMKV

iOS

The installation of MMKV

CocoaPods

What's the issue?

When creating an encrypted instance using an encryption key + the default AES-128 encryption and then removing encryption again via reKey(""), isEncryptionEnabled() still returns true.
Is this expected?

What's the log of MMKV when that happened?

creating encrypted instance...
[MMKV] Creating MMKV instance "some-id-s"... (Path: , Encrypted: true)
'isEncrypted:', true
removing encryption key (reKey(""))...
[I] <MemoryFile.cpp:102::open> open fd[11], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s.crc
[I] <MemoryFile.cpp:108::close> closing fd[11], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s.crc
[I] <MemoryFile.cpp:102::open> open fd[11], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s
[I] <MemoryFile.cpp:108::close> closing fd[11], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s
[I] <MMKV_IO.cpp:91::loadFromFile> loading [some-id-s] with 0 actual size, file size 16384, InterProcess 0, meta info version:0
[I] <MMKV_IO.cpp:142::loadFromFile> loaded [some-id-s] with 0 key-values
[I] <MMKV_IO.cpp:1394::reKey> reKey to no aes key
[I] <MMKV_IO.cpp:1480::clearAll> cleaning all key-values from [some-id-s]
[I] <MMKV_IO.cpp:1494::clearAll> nothing to clear for [some-id-s]
[I] <MMKV.cpp:314::clearMemoryCache> clearMemoryCache [some-id-s]
'isEncrypted:', true

[mrousavy]

Same happens with a new instance:

creating encrypted instance...
[MMKV] Creating MMKV instance "some-id-s2"... (Path: , Encrypted: true)
[I] <MMKV.cpp:256::mmkvWithID> prepare to load some-id-s2 (id be5ed269aac3eeba4580ddb182df95fe) from rootPath /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv
[I] <MemoryFile.cpp:102::open> open fd[11], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2
[I] <MemoryFile.cpp:249::mmapOrCleanup> mmap to address [0x107854000], oldPtr [0x0], [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2]
[I] <MemoryFile.cpp:108::close> closing fd[11], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2
[I] <MemoryFile_OSX.cpp:35::tryResetFileProtection> protection on [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2] is NSFileProtectionCompleteUntilFirstUserAuthentication
[I] <MemoryFile.cpp:102::open> open fd[11], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2.crc
[I] <MemoryFile.cpp:249::mmapOrCleanup> mmap to address [0x107864000], oldPtr [0x0], [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2.crc]
[I] <MemoryFile.cpp:108::close> closing fd[11], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2.crc
[I] <MemoryFile_OSX.cpp:35::tryResetFileProtection> protection on [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2.crc] is NSFileProtectionCompleteUntilFirstUserAuthentication
'isEncrypted:', true
removing encryption key (reKey(""))...
[I] <MemoryFile.cpp:102::open> open fd[11], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2.crc
[I] <MemoryFile.cpp:108::close> closing fd[11], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2.crc
[I] <MemoryFile.cpp:102::open> open fd[11], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2
[I] <MemoryFile.cpp:108::close> closing fd[11], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s2
[I] <MMKV_IO.cpp:91::loadFromFile> loading [some-id-s2] with 0 actual size, file size 16384, InterProcess 0, meta info version:0
[I] <MMKV_IO.cpp:142::loadFromFile> loaded [some-id-s2] with 0 key-values
[I] <MMKV_IO.cpp:1394::reKey> reKey to no aes key
[I] <MMKV_IO.cpp:1480::clearAll> cleaning all key-values from [some-id-s2]
[I] <MMKV_IO.cpp:1494::clearAll> nothing to clear for [some-id-s2]
[I] <MMKV.cpp:314::clearMemoryCache> clearMemoryCache [some-id-s2]
'isEncrypted:', true

And same happens when the instance is not encrypted at first, then encrypted, then decrypted again:

creating instance...
[MMKV] Creating MMKV instance "some-id-s3"... (Path: , Encrypted: false)
[I] <MMKV.cpp:256::mmkvWithID> prepare to load some-id-s3 (id fd7e84bf562057cd2dc86e958237a3a2) from rootPath /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv
[I] <MemoryFile.cpp:102::open> open fd[11], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MemoryFile.cpp:249::mmapOrCleanup> mmap to address [0x107834000], oldPtr [0x0], [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3]
[I] <MemoryFile.cpp:108::close> closing fd[11], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MemoryFile_OSX.cpp:35::tryResetFileProtection> protection on [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3] is NSFileProtectionCompleteUntilFirstUserAuthentication
[I] <MemoryFile.cpp:102::open> open fd[11], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc
[I] <MemoryFile.cpp:249::mmapOrCleanup> mmap to address [0x107868000], oldPtr [0x0], [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc]
[I] <MemoryFile.cpp:108::close> closing fd[11], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc
[I] <MemoryFile_OSX.cpp:35::tryResetFileProtection> protection on [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc] is NSFileProtectionCompleteUntilFirstUserAuthentication
'isEncrypted:', false
adding encryption key (reKey("somekey"))...
[I] <MemoryFile.cpp:102::open> open fd[11], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc
[I] <MemoryFile.cpp:108::close> closing fd[11], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc
[I] <MemoryFile.cpp:102::open> open fd[11], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MemoryFile.cpp:108::close> closing fd[11], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MMKV_IO.cpp:91::loadFromFile> loading [some-id-s3] with 0 actual size, file size 16384, InterProcess 0, meta info version:0
[I] <MMKV_IO.cpp:142::loadFromFile> loaded [some-id-s3] with 0 key-values
[I] <MMKV_IO.cpp:1408::reKey> reKey to a aes key
[I] <MMKV_IO.cpp:1480::clearAll> cleaning all key-values from [some-id-s3]
[I] <MMKV_IO.cpp:1494::clearAll> nothing to clear for [some-id-s3]
[I] <MMKV.cpp:314::clearMemoryCache> clearMemoryCache [some-id-s3]
'isEncrypted:', true
removing encryption key (reKey(""))...
[I] <MMKV_IO.cpp:258::loadMetaInfoAndCheck> meta file [some-id-s3] has flag [0]
[I] <MemoryFile.cpp:102::open> open fd[11], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MemoryFile.cpp:249::mmapOrCleanup> mmap to address [0x107834000], oldPtr [0x0], [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3]
[I] <MemoryFile.cpp:108::close> closing fd[11], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MemoryFile_OSX.cpp:35::tryResetFileProtection> protection on [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3] is NSFileProtectionCompleteUntilFirstUserAuthentication
[I] <MMKV_IO.cpp:91::loadFromFile> loading [some-id-s3] with 0 actual size, file size 16384, InterProcess 0, meta info version:4
[I] <MMKV_IO.cpp:142::loadFromFile> loaded [some-id-s3] with 0 key-values
[I] <MMKV_IO.cpp:1394::reKey> reKey to no aes key
[I] <MMKV_IO.cpp:1480::clearAll> cleaning all key-values from [some-id-s3]
[I] <MMKV_IO.cpp:1494::clearAll> nothing to clear for [some-id-s3]
[I] <MMKV.cpp:314::clearMemoryCache> clearMemoryCache [some-id-s3]
'isEncrypted:', true

as you can see, it was false first for this one but true even after removing the key.

[mrousavy]

I changed this line here:

MMKV/Core/MMKV.h

Line 537 in 55b929a

bool isEncryptionEnabled() const { return m_dicCrypt; }

-    bool isEncryptionEnabled() const { return m_dicCrypt; }
+    bool isEncryptionEnabled() const { return m_crypter; }

And now it works:

creating instance...
[Dispatcher] Installing global Dispatcher Holder into Runtime "HermesRuntime[RNBridgeless] (com.facebook.react.runtime.JavaScript)"...
[JSICache] Creating new JSICache<T> for runtime HermesRuntime[RNBridgeless] (com.facebook.react.runtime.JavaScript)..
[HybridObjectPrototype] Creating new JS prototype for C++ instance type "HybridNitroModulesProxy"...
[HybridObjectPrototype] Creating new JS prototype for C++ instance type "HybridObject"...
[HybridObjectPrototype] Creating new JS prototype for C++ instance type "HybridMMKVFactorySpec"...
[HybridObjectPrototype] Creating new JS prototype for C++ instance type "HybridMMKVPlatformContextSpec"...
[MMKVFactory] Initializing MMKV with rootPath=/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv
[I] <MMKV.cpp:166::initialize> version v2.3.0, page size 16384, arch arm64-v8a
[I] <MMKV.cpp:213::initializeMMKV> Apple Device: 5, version: 8
[I] <MMKV.cpp:223::initializeMMKV> root dir: /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv
[MMKV] Creating MMKV instance "some-id-s3"... (Path: , Encrypted: false)
[I] <MMKV.cpp:256::mmkvWithID> prepare to load some-id-s3 (id fd7e84bf562057cd2dc86e958237a3a2) from rootPath /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv
[I] <MemoryFile.cpp:102::open> open fd[18], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MemoryFile.cpp:249::mmapOrCleanup> mmap to address [0x11b3a4000], oldPtr [0x0], [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3]
[I] <MemoryFile.cpp:108::close> closing fd[18], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MemoryFile_OSX.cpp:35::tryResetFileProtection> protection on [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3] is NSFileProtectionCompleteUntilFirstUserAuthentication
[I] <MemoryFile.cpp:102::open> open fd[18], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc
[I] <MemoryFile.cpp:249::mmapOrCleanup> mmap to address [0x11b3a8000], oldPtr [0x0], [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc]
[I] <MemoryFile.cpp:108::close> closing fd[18], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc
[I] <MemoryFile_OSX.cpp:35::tryResetFileProtection> protection on [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc] is NSFileProtectionCompleteUntilFirstUserAuthentication
[HybridObjectPrototype] Creating new JS prototype for C++ instance type "HybridMMKVSpec"...
'isEncrypted:', false
adding encryption key (reKey("somekey"))...
[I] <MemoryFile.cpp:102::open> open fd[18], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc
[I] <MemoryFile.cpp:108::close> closing fd[18], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3.crc
[I] <MemoryFile.cpp:102::open> open fd[18], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MemoryFile.cpp:108::close> closing fd[18], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MMKV_IO.cpp:258::loadMetaInfoAndCheck> meta file [some-id-s3] has flag [0]
[I] <MMKV_IO.cpp:91::loadFromFile> loading [some-id-s3] with 0 actual size, file size 16384, InterProcess 0, meta info version:4
[I] <MMKV_IO.cpp:142::loadFromFile> loaded [some-id-s3] with 0 key-values
[I] <MMKV_IO.cpp:1408::reKey> reKey to a aes key
[I] <MMKV_IO.cpp:1480::clearAll> cleaning all key-values from [some-id-s3]
[I] <MMKV_IO.cpp:1494::clearAll> nothing to clear for [some-id-s3]
[I] <MMKV.cpp:314::clearMemoryCache> clearMemoryCache [some-id-s3]
'isEncrypted:', true
removing encryption key (reKey(""))...
[I] <MMKV_IO.cpp:258::loadMetaInfoAndCheck> meta file [some-id-s3] has flag [0]
[I] <MemoryFile.cpp:102::open> open fd[18], flag 0x7, /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MemoryFile.cpp:249::mmapOrCleanup> mmap to address [0x11b30c000], oldPtr [0x0], [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3]
[I] <MemoryFile.cpp:108::close> closing fd[18], /Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3
[I] <MemoryFile_OSX.cpp:35::tryResetFileProtection> protection on [/Users/mrousavy/Library/Containers/62A6C3FE-5E94-4215-A0D9-B2E0975796D3/Data/Documents/mmkv/some-id-s3] is NSFileProtectionCompleteUntilFirstUserAuthentication
[I] <MMKV_IO.cpp:91::loadFromFile> loading [some-id-s3] with 0 actual size, file size 16384, InterProcess 0, meta info version:4
[I] <MMKV_IO.cpp:142::loadFromFile> loaded [some-id-s3] with 0 key-values
[I] <MMKV_IO.cpp:1394::reKey> reKey to no aes key
[I] <MMKV_IO.cpp:1480::clearAll> cleaning all key-values from [some-id-s3]
[I] <MMKV_IO.cpp:1494::clearAll> nothing to clear for [some-id-s3]
[I] <MMKV.cpp:314::clearMemoryCache> clearMemoryCache [some-id-s3]
'isEncrypted:', false

Do you want me to create a PR? I am not sure if this is also relevant for isCompareBeforeSetEnabled().

[lingol]

The current implementation is buggy. Noted and will fix it in the future.

[mrousavy]

Thanks :)

[lingol]

Do you want me to create a PR? I am not sure if this is also relevant for isCompareBeforeSetEnabled().

Yes that one's buggy too. A full review on the checking on m_dicCrypt is required.

I'm on Chinese New Year vocation now so the review is due later this month or early next month.

[mrousavy]

No stress at all, just wanted to report this.
Happy new year!

[lingol]

It's been fixed on dev branch.

[mrousavy]

amazing thank you!