PS-7887-2: RocksDB encryption #4578

kamil-holubicki · 2021-12-31T10:52:46Z

This work is based on top of #4462

Rebased to current 8.0 HEAD
SST files are immutable. Master Key rotation affects only new files
Introduced EncryptionInfoStorage interface with EncryptionInfoPlainFileStorage implementation

NOTE: There is 1 change in rocksdb repository: missing override added. It will be added in upstream in the future, or if not, we can put this class wrapper in myrocks namespace.

White: Parts provided by RocksDB, located in rocksdb namespace
Pink: Parts provided by RocksDB, located in rocksdb namespace that we cannot use (do not meet our requirements)
Blue: Parts provided by Percona, located in myrocks namespace.

1. Detection of MKs used 2. (Keyring)MasterKeyManager introduced

1. MK generated and stored in KeyringComponent (dirty implementation)

1. MK rotation

1. Moved (almost) everything into MyRocks layer

1. Cleanup (files renamed, classes renamed)

1. Master key manager synchronization

1. clang

1. fix MasterKeyManager synchronization

1. Introduced thread safe AesCtrCipherStreamTS needed by EncryptedRandomAccessFile::Read() (concurrent read support)

1. Thread safe CipherStream (also for write, probably not needed) 2. Solved double encryption prefix problem (reopenRWFile) 3. MTR suite adjusted 4. KeyringManager deinitialization method added (todo: solve it in better way)

1. MTR fixes

1. Fix new writable file encryption

1. Fix writable file recreation (MTR)

1. adjust MTR tests 2. added tests combinations for encryption 3. removed execution with encryption=1 from suite.opt (moved to combinations)

1. OPTIONS file encryption

1. Header CRC calculation/validation added 2. CRC moved after key and IV 3. key+IV+CRC are encrypted with master key

1. Cleanup around MK manager

1. MTR fixes

1. fault_env and enc_env deinitialization improved

1. Logging improved 2. Error handling improved 3. Disabled tests not suitable for encryption (have_rocksdb_encryption_disabled.inc) 4. Fixed file size calculation (allowed size of 0 as we can have not encrypted files as well)

1. Suppressed too verbose error logging 2. Fixed error log typos

1. Master key rotation prefix read/read synchronized

1. Implemented main/backup encryption prefix to make master key rotation crash safe 2. MyRocks logger full initialization move before encryption init

rocksdb submodule repo url updated

make rocksdb_encryption variable dynamic

I_S.ROCKSDB_ENCRYPTION table introduced

2. SST files are immutables 3. MK rotation reworked (now affects only new files)

2. Master key rotation recovery

2. Logging + error handling added to enc_info_plainfile_storage

1. uuid used for MK identification managed by EncryptionUuidProvider. Backup does not archive uuid, so after restoring new uuid will be generated and used 2. MK rotation blocked for the 1st phase of backup when files deletions are disabled. This is to avoid inconsistencies during backup. As the rotation is only generation of new MK in Keyring and storing this info in .encryption_info file it simplifies the whole things. Blocking MK rotation does not block normal MyRocks operations (insert, delete, etc), but simplifies the flow a lot.

2. Fixed CRC calculation for .encryption_info file

kamil-holubicki added 30 commits December 28, 2021 13:10

PS-7887

a003c5f

PS-7887:

34f757b

1. Detection of MKs used 2. (Keyring)MasterKeyManager introduced

PS-7887:

565aaf6

1. MK generated and stored in KeyringComponent (dirty implementation)

PS-7887:

492a000

1. MK rotation

PS-7887:

f009021

1. Moved (almost) everything into MyRocks layer

PS-7887:

32f333a

1. Cleanup (files renamed, classes renamed)

PS-7887:

7376424

1. Master key manager synchronization

PS-7887:

8241d55

1. clang

PS-7887:

cbaff93

1. fix MasterKeyManager synchronization

PS-7887:

28e1aea

1. Introduced thread safe AesCtrCipherStreamTS needed by EncryptedRandomAccessFile::Read() (concurrent read support)

PS-7887:

7c6f662

1. Thread safe CipherStream (also for write, probably not needed) 2. Solved double encryption prefix problem (reopenRWFile) 3. MTR suite adjusted 4. KeyringManager deinitialization method added (todo: solve it in better way)

PS-7887:

68ce8b0

1. MTR fixes

PS-7887:

e5a738b

1. Fix new writable file encryption

PS-7887:

2bd221b

1. Fix writable file recreation (MTR)

PS-7887:

ab9d851

1. adjust MTR tests 2. added tests combinations for encryption 3. removed execution with encryption=1 from suite.opt (moved to combinations)

PS-7887:

ef59108

1. OPTIONS file encryption

PS-7887:

cdf5adf

1. Header CRC calculation/validation added 2. CRC moved after key and IV 3. key+IV+CRC are encrypted with master key

PS-7887:

9c24bb5

1. Cleanup around MK manager

PS-7887:

34136d5

1. MTR fixes

PS-7887:

4f0db57

1. fault_env and enc_env deinitialization improved

PS-7887:

d71ee68

1. Logging improved 2. Error handling improved 3. Disabled tests not suitable for encryption (have_rocksdb_encryption_disabled.inc) 4. Fixed file size calculation (allowed size of 0 as we can have not encrypted files as well)

PS-7887:

9d58925

1. Suppressed too verbose error logging 2. Fixed error log typos

PS-7887:

695bb8b

1. Master key rotation prefix read/read synchronized

PS-7887:

d318828

1. Implemented main/backup encryption prefix to make master key rotation crash safe 2. MyRocks logger full initialization move before encryption init

PS-7887:

e205bef

rocksdb submodule repo url updated

PS-7887:

24ecf04

make rocksdb_encryption variable dynamic

PS-7887:

8cdf1ef

I_S.ROCKSDB_ENCRYPTION table introduced

Rocksdb pointer updated

20dbdb2

1. EncryptionInfoStorage interface introduced

19c0484

2. SST files are immutables 3. MK rotation reworked (now affects only new files)

1. Encryption info storage + recovery

e7d22e1

2. Master key rotation recovery

1. Cleanup

0456dc9

2. Logging + error handling added to enc_info_plainfile_storage

kamil-holubicki marked this pull request as draft December 31, 2021 10:52

kamil-holubicki requested review from george-lorch, LenzGr and Oneiroi December 31, 2021 10:54

kamil-holubicki added 2 commits March 17, 2022 12:28

Clenup: unused method removed.

b02cc1c

kamil-holubicki force-pushed the PS-7887-2 branch from 441c454 to b02cc1c Compare March 18, 2022 18:50

kamil-holubicki added 2 commits March 21, 2022 10:08

1. all_vars test result re-recorded

a3404e1

2. Fixed CRC calculation for .encryption_info file

Cipher initialization fixed (uninitialized variable)

c75e7d1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PS-7887-2: RocksDB encryption #4578

PS-7887-2: RocksDB encryption #4578

kamil-holubicki commented Dec 31, 2021

PS-7887-2: RocksDB encryption #4578

Are you sure you want to change the base?

PS-7887-2: RocksDB encryption #4578

Conversation

kamil-holubicki commented Dec 31, 2021