在 SQL 層級，作為一組可載入函數，每個函數都對應到對服務常式的呼叫。

作為 C 語言介面，可作為伺服器外掛程式或可載入函數的外掛程式服務呼叫。

key_id：金鑰 ID 或名稱。以 mysql_ 開頭的 key_id 值由 MySQL 伺服器保留。

user_id：工作階段有效使用者 ID。如果沒有使用者內容，此值可以是 NULL。該值實際上不必是「使用者」；其含義取決於應用程式。

實作金鑰環函數介面的函數會將 CURRENT_USER() 的值作為 user_id 值傳遞給金鑰環服務函數。

每個函數成功傳回 0，失敗傳回 1。

key_id 和 user_id 引數形成唯一的組合，表示要使用金鑰環中的哪個金鑰。

key_type 引數提供有關金鑰的其他資訊，例如其加密方法或預期用途。

金鑰環服務函數將金鑰 ID、使用者名稱、類型和值視為二進位字串，因此比較會區分大小寫。例如，MyKey 和 mykey 的 ID 是指不同的金鑰。

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)

引數

傳回值

成功傳回 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)

引數

傳回值

成功傳回 0，失敗傳回 1。

my_key_remove()

從金鑰環中移除金鑰。

語法

bool my_key_remove(const char *key_id, const char* 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)

引數

傳回值

成功傳回 0，失敗傳回 1。