コンテンツにスキップ

データソース

Gitleaksのデータソース設定について説明します

他者の環境に対してのスキャンはNGです

発見した場合、強制的にデータ削除する可能性があります

GitHubリポジトリをスキャンする

  1. メニューよりCode > Gitleaksをクリックします
  2. 画面右側のNEWをクリックします
  3. 以下の項目を入力しEDITをクリックしてください
    • Name*: Gitleaks設定名
    • Type*: GitHubの種類 OrganizationまたはUserを指定します
    • Base URL*: GHESを利用する場合は設定する必要があります。詳細は下記を参照してください
    • TargetResouce*: GitHubのOrganization名またはUser名を入力します
    • RepositoryPattern: 上記のTargetResource配下でスキャンしたいリポジトリ名を指定します。(部分一致)
      • 空欄の場合は、TargetResource配下のリポジトリすべてが対象になります。
    • GitHubUser: スキャンする際の認証情報(ユーザ名)を登録します
    • PersonalAccessToken(PAT): スキャンする際の認証情報(Token)を登録します
      • 認証情報を登録しない場合はInternal/Privateリポジトリのスキャンはできません。
      • 認証情報はRISKEN上で暗号化して保存されます
      • 認証情報登録後に設定済みのTokenは閲覧できません(xxxxのようなマスク値で表示されます)
      • OAuthのスコープは reporead:org (Organizationのスキャン時)を指定してください
      • Scope
    • リポジトリの可視性: スキャン対象にする可視性 を選択してください(Internal/Privateを対象にする場合はPATの登録が必要です)
      • Public: インターネットに公開されているリポジトリをスキャンします
      • Internal: Enterprise内のリポジトリをスキャンします
      • Private: プライベートリポジトリをスキャンします
    • Gitleask設定
Limitation

以下の条件に該当するリポジトリはスキャン対象外になります

  • リポジトリのステータスが以下のもの
    • Archived
    • Disabled
    • Forkリポジトリ
      • Forkリポジトリ とは一般的にはオリジナルリポジトリへの貢献(修正の提案)のために作成されるリポジトリです
  • リポジトリのサイズによる制限があります(詳細はシステム管理者に問い合わせてください)
  • RISKEN環境からcloneできないもの

GitHub Enterprise Serverをスキャンする

オプションでGitHub Enterprise Server(GHES)をサポートしています

ただし、GHES上のリポジトリをスキャンする場合は以下のステップが必要です

  1. 利用中のGEHS環境にて、GitHub v3 APIアクセスに対してIP制限をしている場合はRISKEN環境のIPを許可する必要があります(IPアドレスはRISKEN管理者にお問い合わせください)
  2. GitHubのスキャン設定で Base URL を設定してください(e.g. http(s)://hostname/api/v3/)
Back to top