プロジェクト管理・開発
開発チームの秘密情報の扱い|APIキーやパスワードをコードに入れない仕組みと、漏れたときの無効化の手順
中級|盤面 4 枚・タスクボード 5 列(親タスク 4 件・子タスク 12 件)
中級:手法の名前は出てきますが、要点は盤面で説明しています。記入例を手がかりに、自分の状況に合わせて考えながら埋めます。
APIキーやデータベースのパスワード、証明書の秘密鍵を、コードや設定ファイル・チャット・チケットに書かずに扱うための決まりと、漏れたときに無効化して新しい値へ取り替える手順を、開発チームの全員で決めて共有します。秘密情報ごとに使う所・今の置き場所・持ち主を表にし、開発・検証・本番の環境ごとに置き場所を1つに決めます。ファイルから消しても過去のコミットに値が残ること、画面共有やエラーログに値が映ること、個人のパソコンの設定ファイルに本番の値が残ることも、漏れやすい落とし穴として2枚目で点検します。コミットしてしまった値は漏れたものとして扱い、履歴を書き換えるより先に発行元で無効化するのが基本です。秘密情報がコードに入り込む理由はなぜなぜ分析(5 Whys)で掘り、漏れたときの影響と取り替えやすさで並べてから、書かない決まり・管理の仕組み・コミット前の見張りを決めます。取り替えると止まるのが怖くて古い鍵を放置しないよう、止まる所の確かめ方を添えた取り替えの予定表も作ります。なお、人が覚えるログインのパスワードは定期的に変えず、漏れたときや心配なときに変えます。APIキーの管理のやり方をチームで決めたいときは、使っている外部サービスの管理画面でキーの一覧を開き、名前を書き写すところから始められます。盤面は4枚で、棚卸し・置き場所・原因・仕組みと手順の順に進みます。タスクボードは5列に、4枚に合わせた4つの親タスクと12の子タスクが入っています。
無料登録すると、マーケットプレイスからこのテンプレートをコピーして使えます
ホワイトボード プレビュー
ホワイトボードの文字をテキストで読む
開発チームの秘密情報の扱い
使い方(全4枚): ① 1枚目で秘密情報を棚卸しし、散らばりを書く(盤面①〜⑤) → ② 2枚目で環境ごとの置き場所を決め、落とし穴を点検する(盤面⑥〜⑨) → ③ 3枚目でコードに入る原因を掘り、防ぐ仕組みを決める(盤面⑩〜⑭) → ④ 4枚目で漏れたときの手順と取り替えの予定を作る(盤面⑮〜⑰)
1/4 秘密情報を棚卸し
① 目的と対象(ここから書く)
- 目的 例)APIキーとパスワードをコードとチャットから無くし、漏れても30分以内に止められるようにする
- 対象 例)決済・メール送信・データベースの3つと、リポジトリ2つ
- 期間ととりまとめ役 例)2週間。とりまとめは開発リーダー、点検は全員で分ける
② 秘密情報の一覧(1行に1つ・値そのものは書かない)
| 使う所 | 今の置き場所 | 持ち主 | 最後に替えた時期 | |
|---|---|---|---|---|
| 決済APIキー | 例)本番の注文処理 | 例)サーバーの環境変数 | 例)開発リーダー | 例)不明(記録なし) |
| DBのパスワード | 例)本番と検証のアプリ | 例)設定ファイルに直書き | 例)インフラ担当 | 例)1年以上前 |
| 証明書の秘密鍵 | 例)本番のWebサーバー | 例)サーバー内のファイル | 例)インフラ担当 | 例)前回の期限が切れる前に更新 |
| メール送信キー | 例)通知メールの送信 | 例)チャットに貼られたまま | 例)決めていない | 例)作った時から替えていない |
③ 散らばり:コードと設定ファイル
- 例)テスト用のコードにAPIキーが直書きされている
- 例)設定ファイルの見本に本物の値が入っている
- 見つけた所を「ファイル名・何の値か」で書く
④ 散らばり:チャットとチケット
- 例)作業の手順のチケットにパスワードが書いてある
- 例)チャットで「この鍵を使って」と値を貼った
- 見つけた所を「どの場所・いつごろ」で書く
⑤ 散らばり:個人の端末
- 例)ダウンロードしたままの証明書の鍵ファイルがデスクトップにある
- 例)メモアプリに証明書のパスワードを残している
- 見つけた所を「だれの端末・何の値か」で書く
2/4 置き場所を描く
⑥ 環境ごとの置き場所の決まり(②の秘密情報をどこへ移すか)
| 開発 | 検証 | 本番 | |
|---|---|---|---|
| 置き場所 | 例)各自の端末の設定ファイル(開発用の値だけ) | 例)秘密情報の管理サービス | 例)秘密情報の管理サービス |
| 読める人 | 例)開発メンバー全員 | 例)開発メンバーと検証担当 | 例)運用担当の2人とアプリ本体 |
| 渡し方 | 例)管理サービスから各自が取り出す | 例)配備の時に自動で読み込む | 例)実行時に読み込み、人には見せない |
| 書かない所 | 例)コード・チャット・チケット | 例)コード・チャット・チケット | 例)コード・チャット・チケット・個人の端末 |
⑦ 落とし穴:一度コミットした値は履歴に残る
- 起きること:例)ファイルから消しても過去のコミットに値が残り、リポジトリを見られる人はだれでも読める
- 確かめ方:例)②の秘密情報が過去にコミットされていないか、リポジトリの検索や秘密情報の検出機能の結果で確かめる
- 防ぐ一手:例)コミットされた値は漏れたものとして扱い、履歴を書き換えるより先に発行元で無効化して替える
- 点検結果:例)リポジトリ2つを確認。1件あり→⑮の手順で取り替えた
⑧ 落とし穴:画面やログに映る
- 起きること:例)画面共有・スクリーンショット・エラーログ・デバッグの出力に値がそのまま出る
- 確かめ方:例)ログの設定で秘密情報の項目が伏せ字になっているかを、設定画面とログの出力で確かめる
- 防ぐ一手:例)ログに出す前に伏せる設定を入れ、画面共有の前に設定ファイルを閉じる
- 点検結果:例)エラーログにDBの接続先と一緒にパスワードが出ていた→伏せる設定を追加
⑨ 落とし穴:個人の端末に置いた設定ファイル
- 起きること:例)個人のパソコンの設定ファイルに本番の値が残り、端末の紛失や異動のあとも使える
- 確かめ方:例)⑤に書いた端末と②の持ち主に、開発用の設定ファイルへ本番の値を入れていないかを聞き、発行元の管理画面でキーの名前・メモ・使われた記録を見る(見られる項目はサービスごとに違うので、その案内で確かめる)
- 防ぐ一手:例)個人の端末には開発用の値だけを置き、本番の値は管理サービスから実行時に読む
- 点検結果:例)2人の端末に本番のキーあり→削除し、そのキーを取り替えた
3/4 入り込む原因を掘る
⑩ なぜなぜ分析(③〜⑤と⑦〜⑨から1件を選び、なぜ入り込んだかを5回掘る)
- なぜ1 例)設定ファイルに本番のDBのパスワードが直書きされたのはなぜ?→手元ですぐ動かしたかった
- なぜ2 例)すぐ動かすのに直書きしたのはなぜ?→値をどこから読むかが決まっていなかった
- なぜ3 例)決まっていなかったのはなぜ?→置き場所を環境ごとに分けていなかった
- なぜ4 例)分けていなかったのはなぜ?→始めた頃は1人で開発していて困らなかった
- なぜ5 例)人が増えても見直さなかったのはなぜ?→秘密情報の扱いの担当がいなかった
- 根本原因 例)置き場所と渡し方の決まりが無く、だれも持ち主になっていない
⑪ ②の秘密情報を、漏れたときの影響×取り替えやすさで並べる
縦軸:漏れたときの影響(上ほど大きい)/横軸:取り替えやすさ(左ほどむずかしい・右ほどやさしい)
- 影響が大きく、替えにくい 先に、止めずに替える手順を作る 例)DBのパスワード(使うアプリが多い)
- 影響が大きく、替えやすい すぐに管理サービスへ移し、取り替える 例)決済APIキー(管理画面で新しいキーを発行できる)
- 影響が小さく、替えにくい 予定を組んで、順に移す 例)古い社内ツールの接続用パスワード
- 影響が小さく、替えやすい 次の取り替えのときにまとめて移す 例)開発用のメール送信キー
⑫ 書かない決まり
- 例)コード・チャット・チケットに値を書かない。書くのは「どこにあるか」だけ
- 例)設定ファイルの見本には、ダミーの値を入れる
- 決まりの担当と始める時期を書く
⑬ 管理の仕組み
- 例)秘密情報の管理サービスを1つ決め、置き場所をそこにまとめる
- 例)読める人を役割ごとに分け、本番は2人に限る
- 仕組みの担当と始める時期を書く
⑭ コミット前の見張り
- 例)コミットの前に秘密情報を見つける仕組みを全員の端末で動かす
- 例)コードレビューの確認項目に「値の直書きがないか」を入れる
- 見張りの担当と始める時期を書く
4/4 仕組みと手順を回す
⑮ 漏れたときの5段(⑪で影響が大きいとした秘密情報で当てはめる)
- 知らせる 気づいた人がすぐ伝える 例)チームの決めた連絡先へ、何が・どこに出たかを書く。責めない
- 無効化する 発行元で古い値を止める 例)決済サービスの管理画面で、漏れたキーを無効にする
- 新しい値に替える 新しい値を発行して置き場所を差し替える 例)新しいキーを管理サービスに入れ、本番を読み込み直す
- 跡を確かめる 使われた跡がないかを見る 例)発行元の利用履歴と請求額に、覚えのない使い方がないか確かめる
- 原因を残す なぜ出たかを残し、仕組みに戻す 例)⑩で掘り、⑫〜⑭の決まりを足す
⑯ 取り替えの予定表(⑪の右上と左上から順に)
| 次に替える時期 | 止まる所の確かめ方 | 担当 | |
|---|---|---|---|
| 決済APIキー | 例)今月の2週目 | 例)新旧2つのキーを並べて動かし、注文が通るのを見てから古い方を止める | 例)開発リーダー |
| DBのパスワード | 例)来月の1週目 | 例)使うアプリを②で数え、検証で先に替えてから本番 | 例)インフラ担当 |
| 証明書の秘密鍵 | 例)期限の1か月前 | 例)証明書を使うサーバーを②で数え、検証で入れ替えて接続できるのを見てから本番 | 例)インフラ担当 |
| メール送信キー | 例)今月中(チャットに貼られていたので早める) | 例)検証で通知メールが届くかを見る | 例)開発メンバー1人 |
⑰ 新しいメンバーへの説明(初日に渡す)
- 書かない所と置き場所 例)値はコード・チャット・チケットに書かず、⑥の置き場所から読む
- 落とし穴:取り替えると止まるのが怖くて放置 起きること 例)古いキーが何年も使われ、漏れても気づけない 確かめ方 例)⑯の担当と時期が空いていないかを見る 防ぐ一手 例)新旧を並べて動かしてから古い方を止める
- 漏れたかもと思ったら 例)責めないので、⑮の1段目の連絡先へすぐ知らせる
タスクボードの内容
未着手 16件
秘密情報を棚卸し
1枚目の盤面で、目的と対象を書き、秘密情報の一覧と散らばっている所を出す。一覧ができれば、2枚目以降はその一覧をもとに置き場所と原因を決められる。Ctrl+F(Mac は ⌘F)で『3/4』と入れると 3 枚目へ移動できます。
発行済みのキーを書き写す
使っている外部サービス(決済・メール送信・クラウドなど)の管理画面でAPIキーの一覧のページを開き、キーの名前と用途を盤面②の行に書き写す。15分ほどで、名前が3つ以上並べば完了。値そのものは書かない。
目的と対象を書く
盤面①に、目的・対象のサービスとリポジトリ・期間ととりまとめ役を書く。3つの付箋が埋まれば完了。
散らばりを3つの枠に書く
盤面③〜⑤に、コードと設定ファイル・チャットとチケット・個人の端末で秘密情報が置かれている所を書く。各枠に1件以上の実例が書けたら完了。
置き場所を描く
2枚目の盤面で、②の秘密情報を環境ごとにどこへ置くかを決め、3つの落とし穴を点検する。置き場所が1つに決まると、3枚目で防ぐ仕組みを選びやすくなる。
環境ごとの決まりを書く
盤面⑥の表に、開発・検証・本番それぞれの置き場所・読める人・渡し方・書かない所を書く。12のマスが埋まれば完了。
履歴とログを点検する
盤面⑦⑧で、過去のコミットに値が残っていないか、画面やログに値が映っていないかを確かめ、点検結果の付箋に書く。
端末の設定を点検する
盤面⑨で、⑤に書いた端末を手がかりに、開発用の設定ファイルへ本番の値が入っていないかを持ち主に聞いて確かめ、点検結果を書く。本番の値が見つかったら、そのキーは⑮の手順で取り替える。
入り込む原因を掘る
3枚目の盤面で、秘密情報がコードやチャットに入り込む理由を掘り、優先する秘密情報と防ぐ仕組みを決める。ここで決めた仕組みが4枚目の手順と予定の前提になる。
なぜを5回くり返す
盤面⑩で、③〜⑤と⑦〜⑨から1件を選び、なぜ入り込んだかを5回くり返して最後の段に根本原因を書く。
影響と替えやすさで並べる
盤面⑪で、②の秘密情報を漏れたときの影響と取り替えやすさで4つに分ける。右上と左上に置いたものが先に手を付ける対象になる。
防ぐ仕組みを決める
盤面⑫〜⑭に、書かない決まり・管理の仕組み・コミット前の見張りを1つずつ決めて書く。担当と始める時期まで書けたら完了。
仕組みと手順を回す
4枚目の盤面で、漏れたときに無効化して取り替える手順と、取り替えの予定と、新しいメンバーへの説明を作る。完成した手順はチームの文書に写し、タスクボードの「確認待ち」列で読み合わせを待つ。
漏れたときの5段を決める
盤面⑮の5つの段に、だれに知らせ・どこで無効化し・何を確かめるかを書く。⑪で影響が大きいとした秘密情報1つで当てはめて、迷う所が無ければ完了。
取り替えの予定を組む
盤面⑯の表に、秘密情報ごとの次の取り替え時期・止まる所の確かめ方・担当を書く。全行に時期が入れば完了。
新メンバー向けに書く
盤面⑰に、書かない所と置き場所・取り替えを放置しない理由・漏れたかもと思ったときの知らせ先を書く。新しいメンバーが初日に読めば足りる長さになれば完了。