...
...
To support multiple keys for reading encrypted data it is required to store a key identifier on each encrypted page and on each encrypted WAL record (see more details). The key identifier is a sequential counter , and should be the same on all nodes.
...
nodes
...
.
After the FINISH phase is complete, a new encryption key for writing is set on all nodes, i.e. the key change process is formally completed.
Background re-encryption of existing data will be completed sometime in the future, the new "reencryptionFinished" cache group metric can be used to track re-encryption progress.
Process The process applies for all existing partitions including index.
Every time the cache group key changes, we store the current page count of the partition in the meta page (this value is used as the total page count to re-encrypt).
Scan all pages from specified range (metaPageId + [offset -> total])
Re-encryption progress is stored into metapage (int offset, int total), it updates during the checkpoint.
The process aborts only when a partition is destroyed.
At node startup, during partition initialization, if the total number of pages for re-encryption is greater than zero - this cache group is scheduled for re-encryption.
Old cache group encryption key will be removed when
If CACHE_GROUP_KEY_CHANGE_PREPARE has not been successfully completed on all nodes, the process is interrupted and must be restarted.
When the process restarts, a new key identifier is generated (an unused key will be removed on finish-phase, when we set the new key for writing).
It is possible that the node will fail after adding a new key, but before setting it for writing (as an active key).
This node doesn't know whether the PREPARE phase was successful or not, therefore, it does not know which key is currently being used for writing.
By default, it will try to rejoin with the old key, if the join is rejected, then it should be possible to manually set the correct key identifier using the system property or command line tools.
When a non-baseline node joins a cluster (with baseline change), it cleans up all existing data, so this shouldn't be a problem case.
Reencryption status requires an additional 8 bytes on the meta page of each partition.
Index partition uses PageMetaIO to read/write meta information (page type T_META).
Each other partition uses PagePartitionMetaIO to read/write meta information (page type T_PART_META).
Partition meta starts just after the end of the page meta.
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
To support binary compatibility and keep code clean we creating a new successor of PageMetaIO - PageMetaIOV2 with the same type T_META.
We converting all existing T_META pages into a new version.
We storing additional 8 bytes at the end of each T_META and T_PART_META memory pages.
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
WAL delta records have also been modified to store re-encryption status.
Each encrypted page has reserved free space to store CRC of encrypted data.
The size of this free space depends on the size of the encryption block, but cannot be less than 8 bytes (Ignite default encryption implementation (KeystoreEncryptionSpi) uses AES with 16 bytes block size).
Added 1 byte for encryption key ID on each encrypted page (after CRC).
draw.io Diagram | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Node join is rejected during the key rotation, but this limitation may be revised in the future.
When a node joins the cluster (before/after key rotation), it receives the current encryption keys for the cache groups used for writing. If the encryption key is a new key, then the node sets it for writing and starts the background re-encryption process (in other words, the node automatically "rotates" the encryption key. when joining a cluster, if necessary).
Therefore, a node may leave the cluster during a key change, or a node may be absent and rejoin later (it does not matter if the baseline changes or not), it will receive a new key and schedule re-encryption, if necessary.
If the node stops/fails during re-encryption, after restarting it must continue re-encryption from the stored offset:
...
// TBD
...
public IgniteFuture<Void> changeCacheGroupKey(Collection<String> cacheOrGroupNames);
// TBD
...
Re-encryption process state .
in CacheGroupMetrics
The following commands should be added to the control.sh utility:
Code Block | ||||
---|---|---|---|---|
| ||||
control.(sh|bat) --encryption change_cache_key cacheGroupName --yes |
Code Block | ||||
---|---|---|---|---|
| ||||
The encryption key has been changed for cache group "default". |
Code Block | ||
---|---|---|
| ||
control.(sh|bat) --encryption cache_key_ids cacheGroupName |
Code Block | ||||
---|---|---|---|---|
| ||||
Encryption key identifiers for cache: default
Node 6085d500-2736-4c1f-b47c-444cf0a00000:
1 (active)
0
Node d98654c0-6dfb-4996-993e-387156300001:
1 (active)
0 |
Code Block | ||||
---|---|---|---|---|
| ||||
control.(sh|bat) --encryption reencryption_status cacheGroupName |
Code Block | ||||
---|---|---|---|---|
| ||||
Node 4ed26231-f92d-4b1c-86ba-7a117c200001:
1552 KB of data left for re-encryption
Node 89a456e5-59c5-4f13-a75b-39ab25000000:
1552 KB of data left for re-encryption |
Code Block | ||||
---|---|---|---|---|
| ||||
control.(sh|bat) --encryption suspend_reencryption cacheGroupName |
Code Block | ||||
---|---|---|---|---|
| ||||
Node ad1328e7-11e0-4ecb-8ef2-066519e00001:
re-encryption of the cache group "default" has been suspended.
Node 2a9e291f-e2d1-46e3-9954-18deb0e00000:
re-encryption of the cache group "default" has been suspended. |
Code Block | ||||
---|---|---|---|---|
| ||||
control.(sh|bat) --encryption resume_reencryption cacheGroupName |
Code Block | ||||
---|---|---|---|---|
| ||||
Node 2ed43509-caab-48dc-a27d-3be65d800000:
re-encryption of the cache group "default" has been resumed.
Node b52d6451-a948-48d5-b79a-411956700001:
re-encryption of the cache group "default" has been resumed. |
Code Block | ||||
---|---|---|---|---|
| ||||
control.(sh|bat) --encryption reencryption_rate [limit]
Parameters:
limit - decimal value to change rate limit (MB/s) |
Code Block | ||||
---|---|---|---|---|
| ||||
Node 15cb8485-0c09-4361-b267-107d38400000:
re-encryption rate has been limited to 0.01 MB/s.
Node 909ed414-22e6-477b-b2ca-d1934cd00001:
re-encryption rate has been limited to 0.01 MB/s. |
...
...
Jira server ASF JIRA columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution maximumIssues 20 jqlQuery project = Ignite AND labels in (tde-phase-3) ORDER BY status serverId 5aa69414-a9e9-3523-82ec-879b028fb15b key IGNITE-12843