Documentation Home
MySQL 8.0 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 43.3Mb
PDF (A4) - 43.4Mb
Man Pages (TGZ) - 297.3Kb
Man Pages (Zip) - 402.5Kb
Info (Gzip) - 4.3Mb
Info (Zip) - 4.3Mb
Excerpts from this Manual

8.4.4 The MySQL Keyring

8.4.4.1 Keyring Components Versus Keyring Plugins
8.4.4.2 Keyring Component Installation
8.4.4.3 Keyring Plugin Installation
8.4.4.4 Using the component_keyring_file File-Based Keyring Component
8.4.4.5 Using the component_keyring_encrypted_file Encrypted File-Based KeyringComponent
8.4.4.6 Using the keyring_file File-Based Keyring Plugin
8.4.4.7 Using the keyring_encrypted_file Encrypted File-Based Keyring Plugin
8.4.4.8 Using the keyring_okv KMIP Plugin
8.4.4.9 Using the keyring_aws Amazon Web Services Keyring Plugin
8.4.4.10 Using the HashiCorp Vault Keyring Plugin
8.4.4.11 Using the Oracle Cloud Infrastructure Vault Keyring Component
8.4.4.12 Using the Oracle Cloud Infrastructure Vault Keyring Plugin
8.4.4.13 Supported Keyring Key Types and Lengths
8.4.4.14 Migrating Keys Between Keyring Keystores
8.4.4.15 General-Purpose Keyring Key-Management Functions
8.4.4.16 Plugin-Specific Keyring Key-Management Functions
8.4.4.17 Keyring Metadata
8.4.4.18 Keyring Command Options
8.4.4.19 Keyring System Variables

MySQL Server supports a keyring that enables internal server components and plugins to securely store sensitive information for later retrieval. The implementation comprises these elements:

Warning

For encryption key management, thecomponent_keyring_file andcomponent_keyring_encrypted_file components, and thekeyring_file andkeyring_encrypted_file plugins are 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).

Within MySQL, keyring service consumers include:

For general keyring installation instructions, seeSection 8.4.4.2, “Keyring Component Installation”, andSection 8.4.4.3, “Keyring Plugin Installation”. For installation and configuration information specific to a given keyring component or plugin, see the section describing it.

For information about using the keyring functions, seeSection 8.4.4.15, “General-Purpose Keyring Key-Management Functions”.

Keyring components, plugins, and functions access a keyring service that provides the interface to the keyring. For information about accessing this service and writing keyring plugins, seeSection 7.6.9.2, “The Keyring Service”, andWriting Keyring Plugins.