旧バージョンのドキュメントを参照しています。最新のドキュメントはこちらをご参照ください。

高度なシークレット設定

Vault実装では、さまざまな高度な構成オプションが提供されます。 Vaultバックエンドの特定の設定パラメータについては、バックエンドリファレンスを参照してください。

クエリ引数

クエリ引数を使用して、Vaultバックエンドを構成できます。

たとえば、次のクエリでは、値SECURE_を持つprefixというオプションが使用されます。

{vault://env/secret-config-value?prefix=SECURE_}

利用可能な設定オプションの詳細については、それぞれのVaultバックエンドドキュメントを参照してください。

環境変数

KONG_VAULT_<vault-backend id="sl-md0000000">_<config_opt id="sl-md0000000">環境変数を使用して、Vaultバックエンドを構成できます。

たとえば、 Kong GatewayはKONG_VAULT_ENV_PREFIXに一致する環境変数を探す場合があります。

export KONG_VAULT_ENV_PREFIX=SECURE_

Vaults エンティティ

vaults エンティティを使用して、Vault バックエンドを構成できます。

Vaultエンティティは、データベースが初期化された後にのみ使用できます。データベースが初期化される前に使用された値のシークレットは、Vaultsエンティティを使用できません。

Vaultエンティティを作成します。

curl -i -X PUT http://HOSTNAME:8001/vaults/env-vault-1  \
  --data name=env \
  --data description='ENV vault for secrets' \
  --data config.prefix=SECRET_

結果：

{
    "config": {
        "prefix": "SECRET_"
    },
    "created_at": 1644929952,
    "description": "ENV vault for secrets",
    "id": "684ff5ea-7f65-4377-913b-880857f39251",
    "name": "env",
    "prefix": "env-vault-1",
    "tags": null,
    "updated_at": 1644929952
}

構成オプションは、使用する関連バックエンドに依存します。

これにより、環境変数とクエリ引数から構成を削除し、リファレンスでエンティティ名を使用できるようになります。

{vault://env-vault/secret-config-value}

Vault CLI

Usage: kong vault COMMAND [OPTIONS]

Vault utilities for Kong Gateway.

Example usage:
 TEST=hello kong vault get env/test

The available commands are:
  get <reference id="sl-md0000000">  Retrieves a value for <reference id="sl-md0000000">

Options:
 -c,--conf    (optional string)  configuration file
 -p,--prefix  (optional string)  override prefix directory
 --v              verbose
 --vv             debug

宣言型構成

シークレット管理は、decK 1.16 以降でサポートされています。

deckを使用して、Vaultバックエンドを構成できます。以下に例を示します。

vaults:
- config:
    prefix: SECRET_
  description: ENV vault for secrets
  name: env
  prefix: env-vault

Vaultの設定と宣言型設定ファイルでのシークレットリファレンスの使用についての詳細は decKによるシークレット管理を参照してください。

共有構成パラメーター

すべてのVaultは次の構成パラメータをサポートしています。

パラメータ	UIフィールド名	説明
`vaults.description` 任意	説明	Vaultのオプションの説明です。
`vaults.name`	該当なし	Vaultのタイプ。`env`、`gcp`、`aws`、または`hcv`のいずれかを受け入れます。
`vaults.prefix`	プレフィックス	参照プレフィックス。このVaultに保存されているシークレットにアクセスするには、このプレフィックスが必要です。`{vault://env-vault/<some-secret id="sl-md0000000">}`はその一例です。

ほとんどのVaultは、TTLを使用することでシークレットローテーションもサポートしています。

| パラメータ | フィールド名 | 説明 | |——————————-|——————-|——————————————————————————————————————————————————————————————————————————————————————————————————————-| | vaults.config.ttl | TTL | キャッシュされた場合の、vaultからのシークレットのTime to Live（秒）。特別な値0は「ローテーションなし」を意味し、これがデフォルトです。ゼロ以外の値を使用する場合は、少なくとも1分にすることをお勧めします。 | | vaults.config.neg_ttl | ネガティブTTL | Vaultのミス（シークレットではない）の有効期間（秒単位）。ネガティブにキャッシュされたシークレットは、neg_ttlに達するまで有効なままです。その後、Kongはシークレットを再度更新しようとします。neg_ttlのデフォルト値は0です。これは、ネガティブキャッシュが発生しないことを意味します。 | | vaults.config.resurrect_ttl | Resurrect TTL | シークレットが期限切れになった（config.ttl が終了した）後もシークレットが使用され続ける時間（秒単位）。これは、Vaultにアクセスできなくなった場合、またはシークレットがVaultから削除されてすぐに置き換えられない場合に役立ちます。どちらの場合も、ゲートウェイはresurrect_ttl秒間シークレットの更新を試行し続けます。その後、更新の試みは停止します。Vault に予期しない問題が発生した場合にシームレスな移行を確実に行うために、この構成オプションに十分に高い値を割り当てることをお勧めします。resurrect_ttlのデフォルト値は1e8秒で、これは約3年に相当します。 | シークレットローテーションの詳細についてはこちらをご覧ください。