Documentation Index
Fetch the complete documentation index at: https://factory-docs-auto-sync-jp-docs.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Droid Shieldとは?
Droid Shieldは、コミットしてリモートにプッシュする前に、未コミットの変更を自動的にスキャンして潜在的なシークレットを検出する組み込みセキュリティ機能です。APIキー、トークン、パスワードなどの機密認証情報がバージョン管理履歴に誤って公開されることを防ぐセーフティネットとして機能します。Droid Shieldの動作原理
Droidを使用してgit commitまたはgit push操作を実行すると、Droid Shieldは自動的に以下を行います:
- 差分をスキャン - 追加される行のみを分析(削除や変更されていない行は対象外)
- シークレットを検出 - パターンマッチングを使用して潜在的な認証情報を識別
- 実行をブロック - シークレットが検出された場合、git操作を停止
- 検出結果を報告 - 潜在的なシークレットが見つかった正確な場所を表示
Droid ShieldはDroid経由で実行されたgit操作のみをスキャンします。Droidの外で手動実行したgitコマンドには影響しません。
Droid Shieldが検出する対象
Droid Shieldは、以下を含む幅広い認証情報パターンをスキャンします:APIキーとトークン
Factory APIキー、GitHubトークン、GitLabトークン、npmトークン、AWS、Google Cloud、Stripe、SendGridなどのAPIキー。
認証情報
(JWT、OAuth、セッショントークンなど)と、認証情報が埋め込まれたURL。
秘密鍵
(SSH秘密鍵、PGP鍵、ageシークレットキー、OpenSSH鍵など)およびその他の暗号鍵形式。
サービス固有のシークレット
(Slack Webhookとトークン、Twilio認証情報、Mailchimpキー、Square OAuthシークレット、Azureストレージキーなど)。
検出アルゴリズム
Droid Shieldは、ランダム性検証を伴うスマートパターンマッチングを使用します:- パターンマッチング - フォーマットによる認証情報の識別
- ランダム性チェック - キャプチャされた値が実際のシークレットのように見えるかを検証
- コンテキスト認識 - 変数名と代入パターンを考慮して誤検出を減らす
Droid Shieldが起動するタイミング
Droid Shieldは以下のgit操作中に自動的に起動します:git commit- コミット作成前にステージされた変更をスキャンgit push- リモートにプッシュされるコミットをスキャン
Droid Shield設定の管理
CLIでの操作
設定メニューからDroid Shieldのオン/オフを切り替えることができます:droidを実行/settingsを入力- **「Droid Shield」**設定を切り替え
- 変更は即座に有効になります
Droid Shieldは保護のためデフォルトで有効です。有効のままにしておくことを強く推奨します。
シークレットが検出された場合の対処法
Droid Shieldが潜在的なシークレットを検出すると、以下のようなエラーメッセージが表示されます:推奨される対処方法
シークレットを削除
- ハードコードされた認証情報の代わりに環境変数を使用する
- シークレットを安全な認証情報ストアに移動する
- 機密ファイルを
.gitignoreに追加する - シークレットがすでにコミットされている場合は、git filter-branchまたはBFG Repo-Cleanerを使用する
誤検出の場合
Droid Shieldは慎重を期すために保守的なパターンを使用します。検出が誤検出だと思われる場合:- 実際のシークレットでないことを確認 - その値が機密情報でないことを再確認
- 手動コミットを使用 - Droid以外でgit操作を直接実行
- パターンを報告 - 繰り返し発生する誤検出がある場合はsupport@factory.aiまでご連絡ください
ベストプラクティス
環境変数を使用
環境変数を使用
すべてのシークレットを環境変数または安全な認証情報マネージャーに保存し、ソースファイルには絶対にハードコードしないでください。
Droid Shieldを有効にしておく
Droid Shieldを有効にしておく
Droid Shieldは重要な安全レイヤーを提供します。特にチーム環境では常に有効にしておいてください。
コミット前に確認
コミット前に確認
Droid Shieldがあっても、コミット前に変更を手動で確認し、機密データが含まれていないことを確認してください。
チームに周知
チームに周知
すべてのチームメンバーがDroid Shieldの仕組みと、有効に保つ重要性を理解していることを確認してください。
制限事項
Droid Shieldは検出ツールであり、保証ではありません。 一般的なシークレットパターンの多くを検出できますが、以下は検出できません:
- パターンデータベースにないカスタムシークレット形式
- 認識可能なパターンに従わないシークレット
- 難読化またはエンコードされた認証情報
- ビジネスロジックの脆弱性やコードセキュリティの問題
関連リソース
セキュリティ概要
Factoryの包括的なセキュリティ機能とベストプラクティスについて学びます。
設定
Droid Shieldの設定を含むDroid設定を構成します。
サポートが必要ですか?
セキュリティに関する質問
セキュリティチームへのお問い合わせ: security@factory.ai
誤検知
継続的な誤検知パターンを報告するには、support@factory.aiまでお問い合わせください。
