コードに秘密情報を残さない

WiFiパスワード、APIトークン、秘密鍵はすべて秘密情報です。アクセスを許可するものは、スケッチ内に決してそのまま置かないでください。🔑

フラッシュメモリは通信経由で読み出される可能性があります。コード内の平文のキーは、チップダンプを1回取得されるだけで、誰にでもコピーされてしまいます。

秘密情報を一度コミットすると、それは履歴に永久に残ります。削除した後でも、古いコミットには露出したキーが残っています。

認証情報をsecrets.hのような小さなファイルに入れ、バージョン管理の対象外にします。この秘密情報用ヘッダーによって、スケッチを共有可能なまま、キーをGitHubから遠ざけられます。

秘密情報のファイルを.gitignoreに追加し、誤ってコミットされないようにします。この1行で、現実に起こるキー漏洩の大半を防げます。

キーを埋め込む代わりに、デバイスが初回起動したときに一度だけ入力します。設定ページ経由のプロビジョニングにより、秘密情報をソースコードから完全に切り離せます。

ESP32には、実行時の秘密情報を保存できるフラッシュ上のキーバリューストアNVSがあります。トークンを一度書き込めば、起動するたびに読み戻せます。

共有のマスターキーではなく、各ユニットに固有の認証情報を与えます。デバイスごとのキーを使えば、他のデバイスに影響を与えずに、盗まれた1台のキーだけを無効化できます。

定期的にキーを変更し、漏洩したキーはすぐに無効化できるよう計画します。ローテーションによって、盗まれた1つの秘密情報が使える期間を制限できます。

各トークンには、本当に必要なアクセス権だけを与えます。最小権限とは、デバイスのキーが漏洩しても、自分のトピックだけを読み取れ、アカウント全体にはアクセスできないようにすることです。

ツールを使えば、キーがリモートリポジトリに到達する前に検出できます。ワークフローにシークレットスキャナーを組み込むことで、偶発的な漏洩を未然に防げます。

秘密情報をコードに埋め込んではいけません。gitignoreに追加したヘッダーを使い、セットアップ時にプロビジョニングし、NVSに保存し、ローテーションできるデバイスごとのキーを使用します。🔐