シークレット

Kazzle には、API キー、データベース認証情報、トークン、およびアプリが必要とするその他の機密値を保管するための組み込み暗号化ボルトがあります。シークレットは AES-256-GCM を使用して保存時に暗号化され、KMS でラップされたデータ暗号化キーを使用します。平文値がデータベースに到達することはありません。

概念

コレクションは関連するシークレットをグループ化します（例：stripe-keys、database-credentials）。すべてのコレクションにはスラッグ（小文字、ハイフン区切り）があり、これを設定ファイルと CLI コマンドで参照します。環境はコレクション内のオプションのスコープです（例：production、staging）。シークレットは特定の環境にスコープするか、コレクションレベルのデフォルトとして保持できます。 解決順序： 指定されたコレクション + 環境のシークレットを解決する場合、環境固有のシークレットは同じ名前のコレクションレベルのシークレットをオーバーライドします。これにより、ほとんどのシークレットを環境全体で共有しながら、環境ごとに特定の値をオーバーライドできます。

シークレットの管理

アプリ内

Settings > Vault を開いて、UI を通じてコレクション、環境、シークレットを作成します。

AI を使用

AI はコレクションの作成、環境の作成、シークレットの保管、スコープ間での移動、削除をできます。 AI はシークレット名とメタデータを確認できますが、暗号化された値は確認できません。

CLI を使用

# シークレットを KEY=value 行としてエクスポート
kazzle secrets.export --collection=stripe-keys --env=production

アプリからシークレットを参照

kazzle.config.ts でコンポーネントの env をシークレットコレクションと環境にポイントします。そのスコープ内のすべてのシークレットは、シークレット名と一致する名前のプロセス環境変数として注入されます。

import { defineConfig } from '@kazzle/app';

export default defineConfig({
  components: [
    {
      name: 'API Server',
      type: 'process',
      path: './server',
      env: {
        collection: 'stripe-keys',
        environment: 'production'
      }
    }
  ]
});

env.collection と env.environment はスラッグであり、表示名ではありません。env.include を使用して、コレクションのシークレットのサブセットのみを注入します。

env: {
  collection: 'stripe-keys',
  environment: 'production',
  include: ['STRIPE_SECRET_KEY']
}