MySQL :: MySQL 8.4 参考手册 :: 7.6.9.2 密钥环服务

版本 8.4

8.0 日语

MySQL 8.4 参考手册 / ... / 密钥环服务

7.6.9.2 密钥环服务

MySQL 服务器支持密钥环服务，该服务使内部组件和插件能够安全地存储敏感信息以供以后检索。MySQL 发行版提供了一个密钥环接口，可以通过两个级别访问

在 SQL 级别，作为一组可加载函数，每个函数都映射到对服务例程的调用。
作为 C 语言接口，可以作为插件服务从服务器插件或可加载函数调用。

本节介绍如何使用密钥环服务函数在 MySQL 密钥环密钥存储中存储、检索和删除密钥。有关使用函数的 SQL 接口的信息，请参见第 8.4.4.12 节，“通用密钥环密钥管理函数”。有关通用密钥环的信息，请参见第 8.4.4 节，“MySQL 密钥环”。

密钥环服务使用任何启用的底层密钥环插件（如果有）。如果没有启用密钥环插件，则密钥环服务调用将失败。

密钥存储中的““记录”” 由数据（密钥本身）和用于访问密钥的唯一标识符组成。标识符有两部分

key_id：密钥 ID 或名称。以 mysql_ 开头的 key_id 值由 MySQL 服务器保留。
user_id：会话有效用户 ID。如果没有用户上下文，则此值可以为 NULL。该值实际上不必是““用户””；含义取决于应用程序。
实现密钥环函数接口的函数将 CURRENT_USER() 的值作为 user_id 值传递给密钥环服务函数。

密钥环服务函数具有以下共同特征

每个函数在成功时返回 0，在失败时返回 1。
key_id 和 user_id 参数形成一个唯一组合，指示要使用的密钥环中的哪个密钥。
key_type 参数提供有关密钥的附加信息，例如其加密方法或预期用途。
密钥环服务函数将密钥 ID、用户名、类型和值视为二进制字符串，因此比较区分大小写。例如，ID 为 MyKey 和 mykey 的密钥指的是不同的密钥。

以下密钥环服务函数可用

my_key_fetch()
对密钥进行反混淆并从密钥环中检索它，以及它的类型。该函数为用于存储返回的密钥和密钥类型的缓冲区分配内存。当不再需要内存时，调用者应将其清零或混淆，然后释放它。
语法
```
bool my_key_fetch(const char *key_id, const char **key_type,
                  const char* user_id, void **key, size_t *key_len)
```
参数
- key_id、user_id：空终止字符串，它们成对形成一个唯一标识符，指示要获取哪个密钥。
- key_type：缓冲区指针的地址。该函数将指向空终止字符串的指针存储到其中，该字符串提供有关密钥的附加信息（在添加密钥时存储）。
- key：缓冲区指针的地址。该函数将指向包含获取的密钥数据的缓冲区的指针存储到其中。
- key_len：变量的地址，函数将 *key 缓冲区的大小（以字节为单位）存储到该变量中。
返回值
成功返回 0，失败返回 1。
my_key_generate()
生成给定类型和长度的新随机密钥，并将其存储在密钥环中。密钥的长度为 key_len，并与由 key_id 和 user_id 形成的标识符相关联。类型和长度值必须与底层密钥环插件支持的值一致。请参见第 8.4.4.10 节，“支持的密钥环密钥类型和长度”。
语法
```
bool my_key_generate(const char *key_id, const char *key_type,
                     const char *user_id, size_t key_len)
```
参数
- key_id、user_id：空终止字符串，它们成对形成要生成的密钥的唯一标识符。
- key_type：提供有关密钥的附加信息的空终止字符串。
- key_len：要生成的密钥的大小（以字节为单位）。
返回值
成功返回 0，失败返回 1。
my_key_remove()
从密钥环中删除密钥。
语法
```
bool my_key_remove(const char *key_id, const char* user_id)
```
参数
- key_id、user_id：空终止字符串，它们成对形成要删除的密钥的唯一标识符。
返回值
成功返回 0，失败返回 1。
my_key_store()
混淆密钥并将其存储在密钥环中。
语法
```
bool my_key_store(const char *key_id, const char *key_type,
                  const char* user_id, void *key, size_t key_len)
```
参数
- key_id、user_id：空终止字符串，它们成对形成要存储的密钥的唯一标识符。
- key_type：提供有关密钥的附加信息的空终止字符串。
- key：包含要存储的密钥数据的缓冲区。
- key_len：key 缓冲区的大小（以字节为单位）。
返回值
成功返回 0，失败返回 1。