Skip to content

Latest commit

 

History

History
126 lines (86 loc) · 12.5 KB

File metadata and controls

126 lines (86 loc) · 12.5 KB
title About security overview
shortTitle Security overview
intro You can gain insights into the overall security landscape of your organization or enterprise and identify repositories that require intervention using security overview.
product {% data reusables.gated-features.security-overview-general %}{% ifversion secret-risk-assessment %} {% data variables.secret-scanning.secret-risk-assessment-cta-product %}{% endif %}
redirect_from
/code-security/security-overview/exploring-security-alerts
/code-security/security-overview/about-the-security-overview
/code-security/security-overview/about-security-overview
/code-security/security-overview
versions
fpt ghes ghec
*
*
*
contentType concepts
category
Secure at scale

{% ifversion fpt %}

Security overview provides insights into the security of code stored in repositories in your organization.

  • All organizations on {% data variables.product.prodname_team %} can use the free {% data variables.product.prodname_secret_risk_assessment %} to evaluate the exposure of their organization to leaked secrets, see AUTOTITLE.
  • {% data variables.product.prodname_team %} accounts that purchase {% data variables.product.prodname_GH_cs_or_sp %} have access to views with additional insights.

The information below describes the views available to organizations with {% data variables.product.prodname_GH_cs_or_sp %} that you can use to identify trends in detection, remediation, and prevention of security alerts and dig deep into the current state of your repositories.

{% elsif ghec or ghes %}

Security overview contains focused views where you can explore trends in detection, remediation, and prevention of security alerts and dig deep into the current state of your codebases.

{% ifversion ghec %} All organizations on {% data variables.product.prodname_enterprise %} can use:

  • {% data variables.product.prodname_secret_risk_assessment_caps %} to evaluate the exposure of their organization to leaked secrets, see AUTOTITLE.
  • {% data variables.product.prodname_dependabot %} data to evaluate the security of their supply chain in all repositories. {% else %} All organizations on {% data variables.product.prodname_enterprise %} can use {% data variables.product.prodname_dependabot %} data to evaluate the security of their supply chain in all repositories. {% endif %}

In addition, data for {% data variables.product.prodname_AS %} features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, is shown for organizations and enterprises that use {% data variables.product.prodname_GHAS_cs_or_sp %}{% ifversion ghec %}, and for public repositories{% endif %}, see AUTOTITLE and AUTOTITLE.

{% endif %}

About the views

Note

All views show information and metrics for the default branches of the repositories you have permission to view in an organization or enterprise.

The views are interactive with filters that allow you to look at the aggregated data in detail and identify sources of high risk, see security trends, and see the impact of pull request analysis on blocking security vulnerabilities entering your code. As you apply multiple filters to focus on narrower areas of interest, all data and metrics across the view change to reflect your current selection. For more information, see AUTOTITLE.

{% ifversion security-overview-export-data %} {% data reusables.security-overview.download-csv-files %} For more information, see AUTOTITLE. {% endif %}

There are dedicated views for each type of security alert. You can limit your analysis to a specific type of alert, and then narrow the results further with a range of filters specific to each view. For example, in the {% data variables.product.prodname_secret_scanning %} alert view, you can use the "Secret type" filter to view only {% data variables.secret-scanning.alerts %} for a specific secret, like a {% data variables.product.prodname_dotcom %} {% data variables.product.pat_generic %}.

Note

Security overview displays active alerts raised by security features. If there are no alerts shown in security overview for a repository, undetected security vulnerabilities or code errors may still exist or the feature may not be enabled for that repository.

About security overview for organizations

The application security team at your company can use the different views for both broad and specific analyses of your organization's security status. For example, the team can use the "Overview" dashboard view to track your organization's security landscape and progression. {% ifversion pre-security-configurations %}You can also use security overview to find a set of repositories and enable or disable security features for them all at the same time. For more information, see AUTOTITLE.{% endif %}

You can find security overview on the Security tab for any organization. Each view shows a summary of the data that you have access to. As you add filters, all data and metrics across the view change to reflect the repositories or alerts that you've selected.

Security overview has multiple views that provide different ways to explore enablement and alert data.

  • Overview: visualize trends in Detection, Remediation, and Prevention of security alerts. For information about accessing and using the dashboard, see AUTOTITLE. For detailed explanations of metrics and calculations, see AUTOTITLE.
  • Risk and Alert views: explore the risk from security alerts of all types or focus on a single alert type and identify your risk from specific vulnerable dependencies, code weaknesses, or leaked secrets, see AUTOTITLE.
  • Coverage: assess the adoption of security features across repositories in the organization, see AUTOTITLE.{% ifversion ghas-products %}{% ifversion secret-risk-assessment %}
  • Assessments: regardless of the enablement status of {% data variables.product.prodname_AS %} features, organizations on {% data variables.product.prodname_team %} and {% data variables.product.prodname_enterprise %} can run a free report to scan the code in the organization for leaked secrets, see AUTOTITLE.{% endif %}{% endif %}{% ifversion security-campaigns %}
  • Campaigns: coordinate and measure targeted remediation efforts, grouping related security tasks across repositories, assigning owners, and tracking progress toward defined risk‑reduction goals.{% endif %}
  • Enablement trends: see how quickly different teams are adopting security features.{% ifversion security-overview-org-codeql-pr-alerts %}
  • CodeQL pull request alerts: assess the impact of running CodeQL on pull requests and how development teams are resolving code scanning alerts, see AUTOTITLE.{% endif %}{% ifversion dependabot-metrics %} {% data variables.product.prodname_dependabot %} dashboard: prioritize and track critical vulnerabilities by identifying, remediating, and measuring security improvements across repositories.{% endif %}
  • {% data variables.product.prodname_secret_scanning_caps %} insights: find out which types of secret are blocked by push protection{% ifversion security-overview-delegated-bypass-requests %} and which teams are bypassing push protection{% endif %}, see AUTOTITLE{% ifversion security-overview-delegated-bypass-requests %} and AUTOTITLE{% endif %}.

{% ifversion security-campaigns %} You also create and manage security campaigns to remediate alerts from security overview, see AUTOTITLE and AUTOTITLE. {% endif %}

About security overview for enterprises

You can find security overview on the Security tab for your enterprise. Each page displays aggregated and repository-specific security information for your enterprise.

Security overview for enterprises has multiple views that provide different ways to explore data, including an overview dashboard that visualizes alert trends. For information about the dashboard, see AUTOTITLE and AUTOTITLE.

Access to data in security overview

What you can see in security overview depends on your role and permissions in the organization or enterprise.

In general:

  • Organization owners and security managers can view security data across all repositories in their organization.
  • Organization members can view data only for repositories where they have access to security alerts.
  • Enterprise owners can view aggregated security data in the enterprise-level security overview for organizations where they are an organization owner or security manager. To see repository-level details, they must have the appropriate role within the organization.

Security overview displays data only for repositories you have permission to view, and some views or actions may be limited based on your role.

For detailed, role-by-role permission information, including which views are available and how repository access affects visibility, see AUTOTITLE.

Understanding dashboard data accuracy

The overview dashboard displays metrics based on the current state of your repositories and the historical state of security alerts. This data model has important implications for data consistency:

Data changes over time: Dashboard metrics can change for the same historical time period when viewed at different times. This occurs when repositories are deleted, security advisories are modified, or other changes affect the underlying data. If you need consistent data for compliance reports or auditing purposes, use the audit log instead. See AUTOTITLE.

Alert data is historical; repository attributes are current: The dashboard tracks security alerts based on their historical state during the selected time period. However, repository filters (such as archived/active status) reflect the current state of repositories.

For example, if you archive a repository today, any open alerts in that repository are automatically closed. If you then view the overview dashboard for last week:

  • The repository only appears when you filter to show archived repositories (its current state)
  • The alerts from that repository appear as open (their state during last week)

This design ensures alert trends accurately reflect security activity during the time period you're analyzing, while repository filters help you focus on your current repository structure.

Further reading