GitGuardian

GitGuardianは、ソースコードリポジトリ内のAPIキーやパスワードなどの機密情報を検出するサイバーセキュリティサービスです。Gitリポジトリをスキャンし、ポリシー違反のアラートを送信し、ハッカーが悪用する前に組織がセキュリティイシューを修正するのを支援します。

GitGuardianポリシーに基づいてコミットを拒否するようにGitLabを設定できます。

GitGuardianインテグレーションをセットアップするには:

GitGuardian APIトークンを作成

前提要件:

APIトークンを作成するには:

GitGuardianアカウントにサインインします。
サイドバーのAPIセクションに移動します。
APIセクションのサイドバーで、パーソナルアクセストークンページに移動します。
トークンを作成を選択します。トークン作成ダイアログが開きます。
トークン情報を提供します:
- 目的を識別するために、APIトークンにわかりやすい名前を付けます。たとえばGitLab integration tokenなどです。
- 適切な有効期限を選択します。
- scan scope（スキャンスコープ）チェックボックスを選択します。これは、インテグレーションに必要な唯一のものです。
トークンを作成を選択します。
トークンを生成したら、クリップボードにコピーします。このトークンは機密情報であるため、安全に保管してください。

これで、インテグレーションに使用できるGitGuardian APIトークンが正常に作成されました。

前提要件:

APIトークンを作成してコピーしたら、GitLabがコミットを拒否するように設定します:

プロジェクトのインテグレーションを有効にするには:

GitLabは、GitGuardianポリシーに基づいてコミットを拒否する準備ができました。

必要に応じて、GitGuardianシークレット検出をスキップできます。プッシュ内のすべてのコミットに対してシークレット検出をスキップするオプションは、ネイティブシークレット検出のオプションと同じです。次のいずれかの操作を行います:

プッシュが遅延したり、タイムアウトしたりする可能性があります。GitGuardianインテグレーションを使用する場合:
- プッシュはサードパーティに送信されます。
- GitLabは、GitGuardianまたはGitGuardianプロセスの接続を制御できません。
GitGuardian APIの制限により、インテグレーションは1 MBを超えるサイズのファイルを無視します。それらはスキャンされません。
プッシュされたファイルのファイル名が256文字を超える場合、プッシュは失敗します。
詳細については、GitGuardian APIドキュメントを参照してください。

以下のトラブルシューティング手順は、これらの問題の一部を軽減する方法を示しています。

GitGuardianインテグレーションを使用すると、次の問題が発生する可能性があります。

HTTP 500エラーが発生する可能性があります。

この問題は、変更されたファイルが多いコミットのリクエストがタイムアウトした場合に発生します。

この問題が、1つのコミットで50個を超えるファイルを変更した場合に発生した場合:

HTTP 400エラーが発生し、Filename: ensure this value has at most 256 charactersと表示されることがあります。

この問題は、そのコミットでプッシュしている変更されたファイルの一部に、(パスではなく) 256文字より長いファイル名がある場合に発生します。

回避策は、可能であればファイル名を短くすることです。たとえば、フレームワークによって自動的に生成されたためにファイル名を短縮できない場合は、インテグレーションを無効にして、再度プッシュしてみてください。必要に応じて、後でインテグレーションを再度有効にすることを忘れないでください。