Assessing the impact of GitHub Secret Protection

Measure how GitHub Secret Protection reduces secret exposure across your organization, so you can demonstrate value and identify areas to strengthen your security posture.

Dans cet article

Introduction

After enabling GitHub Secret Protection (GHSP) for your organization, you'll want to assess its impact and understand how it's protecting your organization. This tutorial walks you through accessing secret-related data and interpreting the results to measure GHSP performance.

In this tutorial, you'll learn how to:

  • Access your organization's security overview to view secret scanning data
  • Review the secret risk assessment (SRA) report
  • Compare and analyze the data to assess GHSP's impact

If you don't have a historic SRA report from before your GHSP rollout, you can still assess GHSP's effectiveness. Skip ahead to Step 4: Analyze security overview data trends.

Prerequisites

  • You need to have the organization owner or security manager role.
  • Secret Protection must be enabled for your organization.

Step 1: Access the organization-level security overview

The security overview provides real-time data about Alertes de détection de secrets across your organization.

  1. Sur GitHub, accédez à la page principale de l’organisation.
  2. Sous le nom de votre organisation, cliquez sur l’onglet Security and quality .
  3. On the security overview page, click the Risk tab to view secret scanning data. The overview shows:
    • Total number of open Alertes de détection de secrets
    • Alert trends over time
    • Breakdown by repository
    • Alert severity distribution

Step 2: View your secret risk assessment report

If you previously ran a SRA report, you can access the report to establish a baseline.

  1. Sur GitHub, accédez à la page principale de l’organisation.
  2. Sous le nom de votre organisation, cliquez sur l’onglet Security and quality .
  3. Dans la barre latérale, sous « Sécurité », cliquez sur Évaluations.
  4. Review the key metrics from the assessment, including:
    • Number of exposed secrets detected
    • Types of secrets found
    • Repositories with the highest risk
    • Recommended remediation actions

Remarque

The SRA report represents a point-in-time snapshot of your secret exposure before or during your GHSP implementation.

Step 3: Compare SRA data with current security overview

The SRA report is a point-in-time snapshot taken before or during your GHSP rollout, while the security overview shows real-time data that updates as alerts are opened and resolved. To make a meaningful comparison, you need to ensure both datasets cover the same secret types.

Filter to comparable pattern types

The SRA report only detects provider patterns and generic patterns. The security overview, however, may also include results from custom patterns you've configured since enabling GHSP. To ensure an accurate comparison, filter the security overview to the same pattern types the SRA covers.

Using the UI

In the security overview Risk tab, use the filter bar to narrow results to provider and generic patterns only, excluding any custom patterns.

Using the API

Alternatively, you can use the REST API to programmatically retrieve alerts filtered by secret type. For example, to list only default (provider) Alertes de détection de secrets for a repository:

Shell
gh api \
  -H "Accept: application/vnd.github+json" \
  /orgs/ORG/secret-scanning/alerts --paginate

This returns alerts for default patterns only. To also include generic patterns in your results, pass the specific token names using the secret_type parameter.

For more information, see Points de terminaison d’API REST pour l’analyse de secrets.

Build your comparison

  1. Using the filtered data, create a comparison table with these key metrics:

    MetricSRA report (Baseline)Current security overview (Filtered)Change
    Total exposed secrets[SRA number][Current number][Difference]
    Critical alerts[SRA number][Current number][Difference]
    Affected repositories[SRA number][Current number][Difference]

  2. Calculate the percentage change for each metric:

    • Positive impact indicators: Reduction in total exposed secrets, fewer critical alerts
    • Areas for improvement: New alerts appearing, specific repositories with increasing trends

  3. Note any significant differences in:

    • Secret types being detected
    • Repository coverage
    • Alert resolution rates

Even without an SRA report, you can assess GHSP effectiveness by analyzing trends in the security overview.

  1. Sur GitHub, accédez à la page principale de l’organisation.

  2. Sous le nom de votre organisation, cliquez sur l’onglet Security and quality .

  3. In the security overview Risk tab, look at the trend graph showing Alertes de détection de secrets over time.

  4. Identify patterns:

    • Declining trend: Indicates successful remediation and prevention
    • Plateau: May suggest steady state or need for increased awareness
    • Rising trend: May indicate increased detection coverage or new secret introduction

  5. Click on individual repositories to drill down into specific alert details.

  6. Review the alert resolution rate:

    • Navigate to the Security and quality tab for your organization.
    • Under "Findings", Click Secret scanning.
    • Check how many alerts have been closed versus the number of alerts that remain open.
    • Select the alert type you're interested in.
    • Assess average time to resolution.

Step 5: Interpret the results and take action

Based on your analysis, determine the next steps.

  • Document the improvement to demonstrate GHSP value
  • Identify successful practices to replicate across other repositories
  • Consider expanding GHSP coverage to additional repositories or organizations

If you're seeing areas for improvement

  • Review repositories with increasing alerts or slow resolution times
  • Provide additional training to development teams
  • Assess whether custom patterns need to be configured
  • Check if push protection is enabled to prevent new secrets from being introduced

Ongoing monitoring

  • Schedule regular reviews (weekly or monthly) of the security overview
  • Set up notifications for new Alertes de détection de secrets
  • Track metrics over time to demonstrate continuous improvement

Further reading