MySQL 服务器支持密钥环服务，使内部服务器组件和插件能够安全地存储敏感信息以供以后检索。本节介绍如何编写服务功能可以用来执行密钥管理操作的服务器端密钥环插件。有关一般密钥环信息，请参阅MySQL 密钥环。

此处的说明基于 plugin/keyringMySQL 源代码分发目录中的源代码。该目录中的源文件实现了一个名为的插件，该插件keyring_file使用服务器主机的本地文件进行数据存储。

要编写密钥环插件，请在插件源文件中包含以下头文件。根据插件功能和要求，可能还需要其他 MySQL 或通用头文件。

#include <mysql/plugin_keyring.h>

plugin_keyring.hincludes plugin.h，因此您无需明确包含后一个文件。plugin.h定义MYSQL_KEYRING_PLUGIN服务器插件类型和声明插件所需的数据结构。 plugin_keyring.h定义特定于密钥环插件的数据结构。

与任何 MySQL 服务器插件一样，密钥环插件具有通用插件描述符（请参阅 第 4.4.2.1 节，“服务器插件库和插件描述符”）。在 keyring.cc中， 的一般描述符 keyring_file如下所示：

mysql_declare_plugin(keyring_file)
{
  MYSQL_KEYRING_PLUGIN,     /* type                                     */
  &keyring_descriptor,      /* descriptor                               */
  "keyring_file",           /* name                                     */
  "Oracle Corporation",     /* author                                   */
  "store/fetch authentication data to/from a flat file", /* description */
  PLUGIN_LICENSE_GPL,
  keyring_init,             /* init function (when loaded)              */
  keyring_deinit,           /* deinit function (when unloaded)          */
  0x0100,                   /* version                                  */
  NULL,                     /* status variables                         */
  keyring_system_variables, /* system variables                         */
  NULL,
  0,
}
mysql_declare_plugin_end;

name成员 ( )keyring_file表示插件名称。这是 INFORMATION_SCHEMA.PLUGINS或 显示的名称SHOW PLUGINS。

通用描述符也指 keyring_system_variables，一个将系统变量暴露给SHOW VARIABLES语句的结构：

static struct st_mysql_sys_var *keyring_system_variables[]= {
  MYSQL_SYSVAR(data),
  NULL
};

如果keyring_init数据文件不存在，初始化函数会创建数据文件，然后读取它并初始化密钥库。该 keyring_deinit函数释放与文件关联的数据结构。

通用描述符中的keyring_descriptor值指向特定类型的描述符。对于密钥环插件，此描述符具有以下结构：

struct st_mysql_keyring
{
  int interface_version;
  bool (*mysql_key_store)(const char *key_id, const char *key_type,
                          const char* user_id, const void *key, size_t key_len);
  bool (*mysql_key_fetch)(const char *key_id, char **key_type,
                          const char *user_id, void **key, size_t *key_len);
  bool (*mysql_key_remove)(const char *key_id, const char *user_id);
  bool (*mysql_key_generate)(const char *key_id, const char *key_type,
                             const char *user_id, size_t key_len);
};

特定于类型的描述符具有以下成员：

对于keyring_file插件，特定于类型的描述符如下所示：

static struct st_mysql_keyring keyring_descriptor=
{
  MYSQL_KEYRING_INTERFACE_VERSION,
  mysql_key_store,
  mysql_key_fetch,
  mysql_key_remove,
  mysql_key_generate
};

密钥环插件实现的 功能 类似于 密钥环服务 API 公开的功能。例如， 插件功能类似于密钥环服务功能。有关密钥环服务函数的参数及其使用方式的信息，请参阅 密钥环服务。 mysql_key_xxxmy_key_xxxmysql_key_storemy_key_store

要编译和安装插件库文件，请使用第 4.4.3 节“编译和安装插件库”中的说明。要使库文件可用，请将其安装在插件目录（由 plugin_dir系统变量命名的目录）中。对于keyring_file插件，它是在您从源代码构建 MySQL 时编译和安装的。它也包含在二进制发行版中。构建过程会生成一个名称为 keyring_file.so（ .so后缀可能因平台而异）的共享对象库。

密钥环插件通常在服务器启动过程的早期加载，以便它们可用于可能依赖于它们的内置插件和存储引擎。对于 ，在服务器文件 keyring_file中使用这些行，根据 需要调整您的平台的后缀： my.cnf.so

[mysqld]
early-plugin-load=keyring_file.so

有关插件加载的其他信息，请参阅 安装和卸载插件。

要验证插件安装，请检查 INFORMATION_SCHEMA.PLUGINS表格或使用SHOW PLUGINS 语句（请参阅 获取服务器插件信息）。例如：

mysql> SELECT PLUGIN_NAME, PLUGIN_STATUS
       FROM INFORMATION_SCHEMA.PLUGINS
       WHERE PLUGIN_NAME LIKE 'keyring%';
+--------------+---------------+
| PLUGIN_NAME  | PLUGIN_STATUS |
+--------------+---------------+
| keyring_file | ACTIVE        |
+--------------+---------------+

安装keyring_file插件时，它会公开一个系统变量，该变量指示用于安全信息存储的数据文件的位置：

mysql> SHOW VARIABLES LIKE 'keyring_file%';
+-------------------+----------------------------------+
| Variable_name     | Value                            |
+-------------------+----------------------------------+
| keyring_file_data | /usr/local/mysql/keyring/keyring |
+-------------------+----------------------------------+

有关 keyring_file_data变量的说明，请参阅服务器系统变量。

要在测试后禁用插件，请在没有--early-plugin-load 命名插件的选项的情况下重新启动服务器。