githubEdit

Aria: Enabling Encryption

Step-by-step guide to enabling encryption for user-created and internal temporary Aria tables, including the requirement to manually rebuild existing tables using ALTER TABLE.

To enable data-at-rest encryption for tables using the Aria storage engine, configure the server to use an Encryption Key Management plugin. Once this is done, you can enable encryption by setting the relevant system variables.

Encrypting User-Created Tables

For user-created tables, enable encryption by setting the aria_encrypt_tables system variable to ON, then restart the server:

[mariadb]
aria_encrypt_tables = ON

Alternatively, set the variable with an SQL statement. This doesn't require a server restart, but the setting is lost on server restart:

SET GLOBAL aria_encrypt_tables=ON

Once this is set, Aria enables encryption on all newly created tables.

circle-info

Encryption only works if the ROW_FORMAT table option set to PAGE.

Aria does not support encryption of tables where the ROW_FORMAT table option is set to FIXED or DYNAMIC.

circle-info

Aria does not support the ENCRYPTED table option (see MDEV-18049arrow-up-right about that).

circle-info

Encryption for Aria can only be enabled globally using the aria_encrypt_tables system variable.

Encrypting Existing Tables

In cases where you have existing Aria tables that you would like to encrypt, the process is a little more complicated. Unlike InnoDB, Aria does not utilize background encryption threads to automatically perform encryption changes (see MDEV-18971arrow-up-right about that). Therefore, to encrypt existing tables, you need to identify each table that needs to be encrypted, and then you need to manually rebuild each table.

First, set the aria_encrypt_tables system variable to encrypt new tables.

SET GLOBAL aria_encrypt_tables=ON

Identify Aria tables that have the ROW_FORMAT table option set to PAGE.

For each table in the result set, issue an ALTER TABLE statement to rebuild the table.

This statement causes Aria to rebuild the table using the ROW_FORMAT table option. Since you enabled encryption, Aria also encrypts the table in the process.

Encrypting Internal Temporary Tables on Disk

During the execution of queries, MariaDB routinely creates internal temporary tables. These internal temporary tables initially use the MEMORY storage engine, which is entirely stored in memory. When the table size exceeds the allocation defined by the max_heap_table_size system variable, MariaDB writes the data to disk using another storage engine. If you have the aria_used_for_temp_tables set to ON, MariaDB uses Aria in writing the internal temporary tables to disk.

Encryption for internal temporary tables is handled separately from encryption for user-created tables. To enable encryption for these tables, set the encrypt_tmp_disk_tables system variable to ON. Once set, all internal temporary tables that are written to disk using Aria are automatically encrypted.

Manually Encrypting Tables

Currently, Aria does not support manually encrypting tables through the ENCRYPTED and ENCRYPTION_KEY_ID table options. For more information, see MDEV-18049arrow-up-right.

In cases where you want to encrypt tables manually or set the specific encryption key, use InnoDB.

This page is licensed: CC BY-SA / Gnu FDL

spinner

Last updated

Was this helpful?