ガイド

暗号化キー

ワークスペースの暗号化キーとバックアップキーが何を守るのか、暗号化キーを起動のたびに同じに保つ必要がある理由、そして何も失わずにキーを変更する方法を説明します。

3 分で読めます

1 つの秘密から 2 つのキーこのセクションへのリンクをコピー

  • 暗号化キーは、ワークスペースを運用する側がホスティング設定で設定する秘密の値です。保存された認証情報(保管庫のシークレットとモデルプロバイダーのキー)、ID プロバイダーの設定、保存済みログイン、Webhook のシークレットは、書き込む前にこのキーで暗号化されます。運用ページの二要素認証のシードも同様です。ワークスペースのサインインページのセッションは、このキーから導出したキーで署名されます。
  • バックアップキーは別に設定するものではなく、暗号化キーから導出されます。データベースのスナップショットはすべて、ワークスペースの外に出る前にこのキーで封印(AES-256-GCM)されるため、バックアップストレージには暗号文しか置かれません。

どちらのキーもワークスペースや運用ページには表示されず、ログでは秘密の値が伏せられます。

暗号化キーを固定する必要がある理由このセクションへのリンクをコピー

永続的なキーが設定されていない場合、ワークスペースは起動のたびにキーを作ります。動作は続けられますが、次の 3 つの代償があります。

  • その間に保存した認証情報は、封印したキーが消えるため、次の再起動のあとは読めなくなります。
  • 消えてしまうキーで封印したスナップショットは二度と復元できないため、スナップショットは封印せずにアップロードされます。
  • シードが次の再起動で失われるため、運用ページの二要素サインインを有効にできません。

このとき運用ページ(/ops)には、保存した認証情報が次の再起動で失われるという警告が表示されます。キーの控えは、パスワードマネージャーなどワークスペースの外に保管してください。復元したデータベースの認証情報も、封印されたスナップショットも、封印したときと同じキーでしか開けません。

キーを作るこのセクションへのリンクをコピー

base64 で書いた 32 バイトのランダムな値であれば使えます。たいていのコンピューターでは、次のコマンドで 1 つ表示できます。

openssl rand -base64 32

それをホスティング設定でワークスペースの暗号化キーに設定し、再起動します。以後スナップショットは封印され、ステータスページに暗号化済みと表示されます。

キーを変更するこのセクションへのリンクをコピー

  1. 上の方法で新しいキーを作り、現在のキーも手元に残しておきます。
  2. ホスティング設定で、新しいキーを暗号化キーに、現在のキーを以前の暗号化キーに設定し、再起動します。
  3. 読み取りはすぐに使えます。新しいキーで開けないものは、以前のキーで試されます。起動中に、以前のキーで開けるすべての保存済みシークレットが、新しいキーで少しずつ再暗号化されます。
  4. 進み具合は 管理 › システムの状態 の暗号化キーのローテーションで確認できます。再暗号化した数、すでに新しいキーだった数、失敗した数、残りの数です。どちらのキーでも開けない値は失敗として数えられ、そのまま残されます。以前のキーが、それらを保存したときのキーかどうかを確認してください。
  5. 変更前に作った API キーは、以前のキーが設定されている間は使えます。API キーを発行し直し、以前のキーで残っているものがないと表示されたら、以前のキーを外して再起動します。

あらかじめ考えておくことが 2 つあります。

  • キーを変更すると、ワークスペースのサインインページから全員がサインアウトされます。セッションがこのキーから導出したキーで署名されているためです。
  • 以前のキーで封印したスナップショットは、そのキーが以前のキーとして設定されている間は復元できます。変更前のスナップショットを保管している間は、以前のキーの控えも残してください。

キーをなくした場合このセクションへのリンクをコピー

なくしたキーを取り戻す方法はありません。動いているワークスペースは、そのキーで封印されていないものはすべて保ちますが、保存した認証情報はすべて入力し直す必要があり、そのキーで封印したスナップショットは復元できなくなります。新しいキーを設定して再起動し、認証情報を入力し直してから、/ops の今すぐバックアップですぐに新しいスナップショットを作ってください。バックアップそのものについてはバックアップと復元で説明しています。

最終更新日