秘密の設定を入れ替えるとき、古い鍵は消していい?

外部サービスの認証情報と保存内容を読む暗号化キーを分け、交換と復旧の順番を説明します。

目次

古い暗号化キーは、新しい鍵で保存済みの設定を読めることを確認するまで、稼働環境から外さないでください。 外した後も、過去のバックアップを復元するために保管が必要な場合があります。

外部サービスのAPIキーを交換する場合は、新しいキーで接続できることを確認してから、古いキーを無効にします。どちらも秘密の文字列ですが、役割と交換の手順が異なります。

ここでいう「キー」は、接続や暗号化に使う秘密の文字列です。このガイドは、公開先の設定を管理する人向けです。記事を書く担当者が接続エラーに遭遇した場合は、値を変更する前に、その連携を管理する人へ知らせます。

サービスへ入る鍵と、保存内容を読む鍵を分ける

種類役割入れ替えるときに見る場所
外部サービスのAPIキーメール送信などを、そのサービスへ依頼するサービス側とEmDash側の接続設定
EMDASH_ENCRYPTION_KEYDBに暗号化して保存したプラグイン設定を読む公開先の秘密設定と復旧用の控え
プレビュー用の秘密値下書きの確認リンクが正しいか確かめる発行済みリンクへの影響

暗号化は、そのままでは読めない形で値を保存することです。DBをコピーできても、読むための鍵がなければ元の値を取り出せません。

DBは、記事や設定を保存するデータベースの略です。たとえばメールサービスのAPIキーをDBに暗号化して保存する場合、「メールを送るためのキー」と「保存したキーを読み出すための暗号化キー」の2つがあります。この2つのキーは別々に管理し、必要なほうを交換します。

変更する場所を先に確かめる

外部サービスのキーを発行するのは、そのサービスの管理画面です。EmDashのプラグインに使わせる値は、プラグインの設定画面か、サーバーへ渡す環境変数に保存します。環境変数は、プログラムが動く場所から受け取る設定値です。

暗号化キーは、公開先の秘密情報を保存する機能から渡します。記事本文やastro.config.mjsへ直接書く値ではありません。鍵の生成・登録・反映の操作は、公式の公開先別の説明(別タブで開く)と照合します。

DBのバックアップだけでは、暗号化キーは戻らない

EMDASH_ENCRYPTION_KEYはDBに保存されません。公開先の秘密設定と、別に保管した復旧用の控えが必要です。DBの保存日時に対応する古い鍵も、復旧に必要になることがあります。

作業メモには、値そのものではなく「保管場所」「利用するサイト」「管理する人」を記録します。設定値を画面に表示させたまま、共有用の画像を撮らないようにします。

暗号化キーの交換は、新旧を一時的に併用する

公式の仕組みでは、新しい鍵を先頭、古い鍵を後ろにして、カンマで並べられます。次は並べ方の説明で、実際に使える鍵ではありません。

EMDASH_ENCRYPTION_KEY=新しい鍵,古い鍵

新しく保存する値には先頭の鍵を使い、既存の値は対応する古い鍵で読みます。保存済みの秘密値を新しい鍵で暗号化し直すには、各値を保存し直す作業が必要です。

  1. 現在の鍵と、復旧に使うDBの控えを確保する。
  2. 公式の生成方法で新しい鍵を用意する。
  3. 公開先へ、新しい鍵と古い鍵を併記して設定する。
  4. 使っているプラグインの秘密の入力欄を一覧にし、各値を保存し直す。新しい鍵が使われた状態で書き直すための作業です。再入力する値は保管先から用意します。元の文字列は、管理画面の「設定済み」という表示からは取り出せません。
  5. 本番とは別の確認用サイトへ再保存後のデータを用意し、新しい鍵だけで各連携が動くか調べる。メールは確認用の送信先などへ試す。
  6. 必要な値を確認してから、稼働環境の設定から古い鍵を外す。

管理画面に「設定済み」と出るだけでは、正しく読み出して使えたことまでは確認できません。たとえばメール連携なら、確認用の宛先へ届いたかまで見ます。

EmDashには、どの古い鍵がまだ使われているかを一覧で報告する機能がありません。保存し直した項目と、その連携の動作確認を記録します。詳しい形式と生成方法は公式の鍵管理(別タブで開く)を参照してください。

外部サービスのキーを交換する場合

こちらは、サービス側で新しい認証情報を用意し、EmDashのプラグイン設定などへ入れ直す作業です。環境変数が優先される構成では、管理画面だけ直しても使われる値が変わらない場合があります。

どこから値を読んでいるか確認し、新しい接続で送信・取得ができてから、サービス側の古い認証情報を無効にします。更新方法や新旧を併用できる期間は、サービスごとに確認します。

古い鍵を失ってしまったら

対応する控えがあれば、それを復元します。控えがなければ、新しい鍵を作っても過去の暗号文は読めません。影響する外部サービスの認証情報を用意し直し、新しい鍵で設定を保存します。

一方、プレビュー用の秘密値を変えた場合は、発行済みの確認リンクが使えなくなり、新しく発行したリンクを使います。「鍵をなくしたら何が失われるか」を、種類ごとに判断しましょう。

交換後も、過去のDBバックアップを戻すために古い暗号化キーが必要な場合があります。稼働環境から外した古い鍵も、対応するバックアップの復元に必要な間は、復旧用の控えとして保管します。

登録の操作を先に練習したい場合は、手元と公開先の秘密情報を分ける実習へ進めます。EmDashの既存の暗号鍵には触れず、教材専用の値を使います。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。