pgx_declare_external_master_keyは、鍵管理システムに存在する暗号化キーを透過的データ暗号化のマスタ暗号化キーとして使用することを宣言します。すでにマスタ暗号化キーが存在する場合、マスタ暗号化キーを変更します。すでにマスタ暗号化キーが存在する場合、キーストアがオープンされている必要があります。
引数には、マスタ暗号化キーを特定するための情報を指定します。引数は名前付け表記で指定してください。引数に渡す情報は使用する鍵管理システムによって異なります。
この関数は、スーパーユーザーのみ実行可能です。また、トランザクションブロック内でこの関数を実行することはできません。
この関数は、拡張モジュール’tde_kms’をインストールした場合に利用可能です。
以下の引数を名前付け表記で指定します。
kms_name text
鍵管理システム接続情報ファイルに指定した鍵管理システム名を指定します。省略できません。
key_id text
暗号化キーに付けられた鍵IDを指定します。省略できません。
sslpassphrase text
KMIPサーバに接続する際のクライアント証明書用秘密鍵ファイルのパスフレーズを指定します。秘密鍵ファイルにパスフレーズが設定されていない場合は省略できます。kms_nameで指定される鍵管理システムのタイプがkmipでない場合は無視されます。
kms_secret text
プラグインに渡される秘密にすべき情報です。鍵管理システムの利用に不要な場合は省略できます。省略できるかはプラグインの実装に依存します。kms_nameで指定される鍵管理システムのタイプがcustomでない場合は無視されます。
例
SELECT pgx_declare_external_master_key( kms_name => 'mykmipsvr', key_id => 'a0eebc99-9c0b-0000-0000-000000000000', sslpassphrase => 'mykmippassphrase' );