Pre-General Availability Draft: 2017-10-19

6.5.4 The MySQL Keyring

[+/-]

6.5.4.1 Keyring Plugin Installation

6.5.4.2 Using the keyring_file File-Based Plugin

6.5.4.3 Supported Keyring Key Types

6.5.4.4 General-Purpose Keyring Key-Management Functions

6.5.4.5 Plugin-Specific Keyring Key-Management Functions

6.5.4.6 Keyring System Variables

MySQL Server supports a keyring service that enables internal server components and plugins to securely store sensitive information for later retrieval. The implementation is plugin-based:

• The keyring_file plugin stores keyring data in a file local to the server host. This plugin is available in all MySQL distributions, Community Edition and Enterprise Edition included.

  Warning

  The keyring_file plugin for encryption key management is not intended as a regulatory compliance solution. Security standards such as PCI, FIPS, and others require use of key management systems to secure, manage, and protect encryption keys in key vaults or hardware security modules (HSMs).

• An SQL interface for keyring key management is implemented as a set of user-defined functions (UDFs).

The InnoDB storage engine uses the keyring to store its key for tablespace encryption. InnoDB can use any supported keyring plugin.

For general keyring installation instructions, see Section 6.5.4.1, “Keyring Plugin Installation”. For information specific to a given keyring plugin, see the section describing that plugin.

For information about using the keyring UDFs, see Section 6.5.4.4, “General-Purpose Keyring Key-Management Functions”.

Keyring plugins and UDFs access a keyring service that provides the interface for server components to the keyring. For information about accessing the keyring plugin service and writing keyring plugins, see Section 29.3.2, “The Keyring Service”, and Section 29.2.4.12, “Writing Keyring Plugins”.