Motivation

Master keyrotation required in case of it compromising or at the end of crypto period(key validity period). 

Design assumes that administrator will provide ability to get new master key by EncryptionSPI from underlying storage.

Master Key rotation

Definitions

• MK – MasterKey. Encrypts cache keys. Master key is stored in some key storage. Master keys identified by String masterKeyId.

Prerequisites

New master key should be available to EncryptionSPI for each server node.

Process management

Users can control the master key rotation process key via  some kind of user interface(CLI, JMX, Java API,  etc). 

• JAVA API:
  ignite.encryption().changeMasterKey(String masterKeyId) - starts master key rotation process.
  String ignite.encryption().getMasterKeyId() - gets current master key id.
  
  
• JMX:
  changeMasterKey(String masterKeyId) - starts master key rotation process.
  String getMasterKeyId()  - gets current master key id.
  
  
• CLI:
  # Starts master key rotation.
  ./control.sh --encryption change_master_key newMasterKeyId
  
  # Displays cluster's current master key id.
  ./control.sh --encryption get_master_key
  
  # Starts ignite with recovery process. See details.
  ignite.sh -change-master-key-before-join newMasterKeyId

Process description 

1. A node creates the ChangeMasterKeyMessage message and sent it by discovery as a custom event. The goal is to verify that all nodes have the same master key. 
   
   1. Initiating message should contain: 
      1. New master key id. 
      2. New master key hash.
   2. When server node processed message following actions are executed: 
      1. It obtain hash of new master key.
      2. Compares it with the one in message
      3. If it differs then error added to the message.
2. If on step1 there are some errors we log it and cancel process. Otherwise got to step3.
3. The ChangeMasterKeyFinishMessage action message is sent by discovery as a custom event.
   1. Action message sould contain:
      
      1. New master key id.
   2. When server node processed message following actions are executed: 
      1. Blocks creation of encrypted cache key. 
      2. Reencrypt all cache group keys with new master key in a temporary datastructure. No changes in MetaStore.
      3. Create WAL logical record (ChangeMasterKeyRecord) that consist of:
         1. New master key id
         2. Reenctyped cache group keys.
      4. Write cache group keys to MetaStore.
      5. Unblock creation of encrypted cache key. 

Process completion:

Process completes when all nodes in cluster will process action message.

Corner cases

Node left during key rotation process(was not starting re-encrypt cache keys):

If some node was unavailable during master key rotation process it will unable to join to the cluster because it has old master key.

To update this node user should run ignite with command to change master key before join:

• ignite.sh -change-master-key-before-join newMasterKeyId

The node will re-encrypt cache keys with new MK and try to join to cluster.

Node left during key rotation process(was starting re-encrypt cache keys):

1. If during node recovery with logical records we found ChangeMasterKeyRecord it passed to EncryptionManager.
2. When MetaStore becomes available for write, EncryptionManager writes new cache group keys to it.

Node join during key rotation process:

Reject node join. It may lead to inconsistent master keys in cluster. (Or if it possible to delay until key rotation process ends)

Cache start during key rotation process:

Cache keys must not be created during the master key rotation process. So, a node will throw an exception if a user will start cache during the key rotation process.

Public java API changes

EncryptionSpi

The concept of the masterKeyId will be added to the cache keys encryption process in EncryptionSpi:

byte[] masterKeyDigest();

byte[] masterKeyDigest(String masterKeyId);

byte[] encryptKey(Serializable key);

byte[] encryptKey(Serializable key, String masterKeyId);

Serializable decryptKey(byte[] key);

Serializable decryptKey(byte[] key, String masterKeyId);

where masterKeyId - master key id. If null the default key will be used for compatibility reason.

IgniteConfiguration

New methods will be added to the IgniteConfiguration:

public IgniteConfiguration setEncryptionMasterKeyId(String keyId) - sets master key id.

public String getEncryptionMasterKeyId()

Code changes

MetaStorage

MetaStorage will store master key id.

Node attribute

Currently joining node send hash MK for validation in attributes. Attributes can't be modified at runtime. So joining node will send hash MK in JoiningNodeDiscoveryData.