ハイライト
APIキーの再表示が可能になりました。Dashboardで生成後、画面を離れて翌週戻ってきても、クリックひとつでキーを再確認できます。また、API playgroundの使い勝手を改善し、curlの再現コマンドがそのまま実行できるようになりました。
新機能
APIキーの再表示
一般的なSaaS APIでは、キーは一度しか表示されません。紛失した場合は再生成し、古いキーを使用しているすべてのサービスを更新して再デプロイする必要があります。よくある手間です。
この仕様を見直し、変更しました。
今後作成されるキーには、再表示用のコピーが保持されます。Dashboardを開き、任意のキーの横にある目のアイコンをクリックして確認すると、完全なpk_live_...の値が表示されます。15秒後に自動で非表示になり、ページから消去されます。すべての再表示操作は監査ログに記録されます。
設計上の重要ポイントは以下のとおりです。
- リクエストを認証するパスは従来どおり不可逆ハッシュを使用しており、変更はありません。再表示可能なコピーは、別の暗号化アーティファクト(AES-256-GCM)として個別に保存されます。暗号化キーをローテーションした場合でも、認証処理には影響しません。
- 本変更以前に作成されたキーは再表示できません。読み戻すための暗号化コピーが存在しないためです。ハッシュによる認証パスにより、これまでのキーも永続的に動作し続けます。Dashboardには小さな鍵マークと「再生成して有効化」のヒントが表示され、どのキーが新機能に対応しているかを確認できます。
- アクセス制御は他のキーAPIの権限に準拠します。自身が作成したキーは再表示できます。組織管理者は組織内の任意のキーを再表示できます。Team-write権限を持つメンバーはチームのキーを再表示できます。Read-onlyロールは再表示できません。
- 組織管理者がチームメンバーの代理で作成したキーも、同一のルールで再表示可能です。この機能は作成時のインターフェースではなく、キー自体に紐づいて機能します。
パスワードマネージャーにFourAのキーを個別に保存しておく必要はなくなりました。
curl再現コマンドの直接実行
playgroundで構築した各リクエストには、コピー&ペースト可能なcurlコマンドがサイドパネルに表示されます。UI上でリクエストを調整し、curlをコピーして、スクリプト、チームメンバーのターミナル、またはバグレポートにそのまま貼り付けるというシンプルなワークフローを想定しています。
今週までは、キーが入るべき箇所にプレースホルダー(PASTE_PLAINTEXT_FOR_my-key)が含まれていたため、実行前に手動で入力する必要がありました。これでは再現コマンドではなく、単なるテンプレートでした。
この手順を解消しました。再表示に対応したキーでは、playgroundのcurlパネルに「表示」ボタンが配置されます。クリックすると実際のプレーンテキストがcurl内に挿入され、コマンド全体をコピーしてターミナルに貼り付ければそのまま実行できます。もう一度クリックすると非表示に戻ります。再表示は対象セッションのメモリ上でのみ保持され、ディスクには書き込まれません。また、curlパネルはキーのドロップダウン選択と連動しているため、キーを切り替えても他のキーに漏洩することはありません。なお、古い非対応キーについてはプレーンテキストを復元できないため、引き続きプレースホルダーが表示されます。
実行中リクエストのキャンセルボタン
低速なターゲットサイトに対してPlaygroundからリクエストを送信した場合、これまではタイムアウトを待つしかありませんでした。そこで、ローディングパネルにキャンセルボタンを追加しました。クリックするとリクエストは正常に中断され、レスポンス領域には不安を煽るようなエラーではなく「Request canceled.」と表示されて待機状態に戻ります。
些細な改善ですが、Playgroundはデモの域を超え、実用的なツールとして使えるようになりました。不安定なサイトを調査する際も、無駄に待たされることなく、中断してリクエストを調整し、再試行できます。
内部の仕組み
初回リリース後、cURLの表示ボタンに関して3つの細かな改修を行いました。エラートーストに機械的なエラーコードではなくわかりやすいメッセージを表示するようにした点、別の例外が発生した場合にボタンが「Revealing…」のままスタックしないようにした点、そして表示に対応していないキーでボタンが表示されたままになるCSSの詳細度バグを修正した点です。
これらの問題に遭遇していたなら、すでに修正されています。遭遇していなかったとしても、気にする必要はありません。
生成して、コピーし、貼り付けて、忘れる。後から戻ってきても、ダッシュボードが記憶しています。