SQL レベルでは、サービスルーチンへのコールにマップされる一連のユーザー定義関数 (UDF) として。

C 言語インタフェースとして、サーバープラグインまたはユーザー定義関数からプラグインサービスとして呼び出すことができます。

key_id: キー ID またはキー名。mysql_で始まる key_id 値は、MySQL Server によって予約されています。

user_id: セッションの実効ユーザー ID。 ユーザーコンテキストがない場合、この値は NULL にすることができます。 値は実際には 「user」 である必要はありません。意味はアプリケーションによって異なります。

キーリング UDF インタフェースを実装する関数は、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 から形成された識別子に関連付けられます。 型と長さの値は、基礎となるキーリングプラグインでサポートされている値と一致している必要があります。 セクション6.4.4.8「サポートされているキーリングキーのタイプと長さ」を参照してください。

構文:

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 を返します。