close
Skip to content

Latest commit

 

History

History
200 lines (126 loc) · 16 KB

File metadata and controls

200 lines (126 loc) · 16 KB
title About GitHub Advanced Security
intro {% data variables.product.github %} makes extra security features available to customers {% ifversion ghas-products %}who purchase {% data variables.product.prodname_GH_code_security %} or {% data variables.product.prodname_GH_secret_protection %}{% else %}under a {% data variables.product.prodname_GHAS %} license{% endif %}.{% ifversion fpt or ghec %} Some features are enabled for public repositories by default.{% endif %}
product {% data reusables.gated-features.ghas-ghec %}
versions
fpt ghes ghec
*
*
*
redirect_from
/github/getting-started-with-github/about-github-advanced-security
/github/getting-started-with-github/learning-about-github/about-github-advanced-security
shortTitle GitHub Advanced Security
category
Explore GitHub plans and features

About {% data variables.product.prodname_GHAS %} {% ifversion ghas-products %}products{% endif %}

{% data variables.product.github %} has many features that help you improve and maintain the quality of your code. Some of these are included in all plans, such as dependency graph and {% data variables.product.prodname_dependabot_alerts %}.

{% ifversion ghas-products %}

Other security features require you to purchase one of {% data variables.product.github %}'s {% data variables.product.prodname_AS %} products:

{% data reusables.advanced-security.ghas-products-bullets+ghas %}

{% ifversion fpt or ghec %}Some of these features, such as {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, are enabled for public repositories by default. To run the feature on your private or internal repositories, you must purchase the relevant {% data variables.product.prodname_GHAS %} product.{% endif %}

You must be on a {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %} plan in order to purchase {% data variables.product.prodname_GH_code_security %} or {% data variables.product.prodname_GH_secret_protection %}. For more information, see AUTOTITLE and AUTOTITLE.

{% else %}

Other security features require a {% data variables.product.prodname_GHAS %} (GHAS) license. For information about buying a license for {% data variables.product.prodname_GHAS %}, see AUTOTITLE.

{% endif %}

{% ifversion ghas-products %}

{% data variables.product.prodname_GH_code_security %}

You get the following features with {% data variables.product.prodname_GH_code_security %}:

  • {% data variables.product.prodname_code_scanning_caps %}: Search for potential security vulnerabilities and coding errors in your code using {% data variables.product.prodname_codeql %} or a third-party tool.

  • {% data variables.product.prodname_codeql_cli %}: Run {% data variables.product.prodname_codeql %} processes locally on software projects or to generate {% data variables.product.prodname_code_scanning %} results for upload to {% data variables.product.github %}.{% ifversion code-scanning-autofix %}

  • {% data variables.copilot.copilot_autofix_short %}: Get automatically generated fixes for {% data variables.product.prodname_code_scanning %} alerts.{% endif %}{% ifversion security-campaigns %}

  • Security campaigns: Reduce security debt at scale.{% endif %}

  • {% data variables.dependabot.custom_rules_caps %} for {% data variables.product.prodname_dependabot %}: Manage your {% data variables.product.prodname_dependabot_alerts %} at scale, by automating which alerts you want to ignore, snooze, or trigger a {% data variables.product.prodname_dependabot %} security update for.

  • Dependency review: Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request.

  • Security overview: Understand the distribution of risk across your organization.

{% ifversion fpt or ghec %}

The table below summarizes the availability of {% data variables.product.prodname_GH_code_security %} features for public and private repositories.

{% rowheaders %}

Public repository
without {% data variables.product.prodname_GH_code_security %}
Private repository
without {% data variables.product.prodname_GH_code_security %}
Public or private repository
with {% data variables.product.prodname_GH_code_security %}
{% data variables.product.prodname_code_scanning_caps %} {% octicon "check" aria-label="Yes" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
{% data variables.product.prodname_codeql_cli %} {% octicon "check" aria-label="Yes" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
{% ifversion code-scanning-autofix %}
{% data variables.copilot.copilot_autofix_short %} {% octicon "check" aria-label="Yes" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
{% endif %}
{% ifversion security-campaigns %}
Security campaigns {% octicon "x" aria-label="No" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
{% endif %}
{% data variables.dependabot.custom_rules_caps %} {% octicon "x" aria-label="No" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
Dependency review {% octicon "x" aria-label="No" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
Security overview {% octicon "x" aria-label="No" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
{% endrowheaders %}

{% endif %}

For more information about features, see AUTOTITLE.

{% data variables.product.prodname_GH_secret_protection %}

You get the following features with {% data variables.product.prodname_GH_secret_protection %}:

{% data reusables.secret-protection.product-list %}

{% ifversion ghas-products-cloud %}

The table below summarizes the availability of {% data variables.product.prodname_GH_secret_protection %} features for public and private repositories.

{% rowheaders %}

Public repository
without {% data variables.product.prodname_GH_secret_protection %}
Private repository
without {% data variables.product.prodname_GH_secret_protection %}
Public or private repository
with {% data variables.product.prodname_GH_secret_protection %}
Secret scanning {% octicon "check" aria-label="Yes" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
Push protection {% octicon "check" aria-label="Yes" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
{% ifversion secret-scanning-ai-generic-secret-detection %}
Copilot secret scanning {% octicon "x" aria-label="No" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
{% endif %}
Custom patterns {% octicon "x" aria-label="No" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
Delegated bypass for push protection {% octicon "x" aria-label="No" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
{% ifversion security-campaigns-secrets %}
Security campaigns {% octicon "x" aria-label="No" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
{% endif %}
Security overview {% octicon "x" aria-label="No" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}

{% endrowheaders %}

{% endif %}

For more information about individual features, see AUTOTITLE.

{% else %}

About {% data variables.product.prodname_GHAS %} features

A {% data variables.product.prodname_GHAS %} license provides the following additional features:

  • {% data variables.product.prodname_code_scanning_caps %} - Search for potential security vulnerabilities and coding errors in your code using {% data variables.product.prodname_codeql %} or a third-party tool. See AUTOTITLE and AUTOTITLE.

  • {% data variables.product.prodname_codeql_cli %} - Run {% data variables.product.prodname_codeql %} processes locally on software projects or to generate {% data variables.product.prodname_code_scanning %} results for upload to {% data variables.product.github %}. See AUTOTITLE.

  • {% data variables.product.prodname_secret_scanning_caps %} - Detect secrets, for example keys and tokens, that have been checked into the repository. If push protection is enabled, {% data variables.product.prodname_dotcom %} also detects secrets when they are pushed to your repository. {% ifversion secret-scanning-enable-by-default-for-public-repos %}{% data variables.secret-scanning.user_alerts_caps %} and push protection are available and free of charge for all {% ifversion ghec %}user-owned {% endif %}public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} See AUTOTITLE and AUTOTITLE.

  • {% data variables.dependabot.custom_rules_caps %} - {% data reusables.dependabot.dependabot-custom-rules-ghas %}

  • Dependency review - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. See AUTOTITLE.

{% endif %}

{% ifversion ghas-products %}

Run a free security risk assessment

Get started with security risk assessments {% octicon "link-external" height:16 %}

Organizations on {% data variables.product.prodname_team %} and {% data variables.product.prodname_enterprise %} can run free security risk assessments to understand their exposure to security vulnerabilities:

{% ifversion secret-risk-assessment %}

  • Secret leaks: Scan your organization for leaked secrets and see how many could have been prevented by {% data variables.product.prodname_GH_secret_protection %}. See AUTOTITLE. {% endif %} {% ifversion code-security-risk-assessment %}
  • Code vulnerabilities: Scan up to 20 of your most active repositories and see how many vulnerabilities could be automatically fixed with {% data variables.copilot.copilot_autofix_short %} if you enable {% data variables.product.prodname_GH_code_security %}. See AUTOTITLE. {% endif %}

{% endif %}

Deploying {% ifversion ghas-products %}{% data variables.product.prodname_GH_code_security %} and {% data variables.product.prodname_GH_secret_protection %}{% else %}{% data variables.product.prodname_GHAS %} in your enterprise{% endif %}

To learn about what you need to know to plan your deployment of {% ifversion ghas-products %}{% data variables.product.prodname_GH_code_security %} and {% data variables.product.prodname_GH_secret_protection %}{% else %}{% data variables.product.prodname_GHAS %}{% endif %} at a high level and to review the rollout phases we recommended, see AUTOTITLE.

Enabling features

{% ifversion ghes < 3.15 %} A site administrator must enable {% data variables.product.prodname_AS %} for {% data variables.location.product_location %} before you can use these features. See AUTOTITLE. {% endif %}

{% ifversion security-configurations %} {% data reusables.security-configurations.enable-security-features-with-gh-config %} {% endif %}

{% ifversion security-configurations %}{% else %}Once your system is set up, you can enable and disable these features at the organization or repository level. See AUTOTITLE and AUTOTITLE.{% endif %}

If you are on a {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %} plan, license use for the entire team or enterprise is shown on your license page. {% ifversion fpt or ghec %}See AUTOTITLE.{% endif %}

{% ifversion disable-ghas-button %}

Managing {% data variables.product.prodname_GHAS %}

Enterprise owners can manage {% data variables.product.prodname_GHAS %} licensing and access for their enterprise, including disabling {% data variables.product.prodname_GHAS %} across all repositories and preventing future re-enablement. See AUTOTITLE.

For information about managing your {% data variables.product.prodname_GHAS %} license, see AUTOTITLE.

{% endif %}

{% ifversion copilot-chat-ghas-alerts %}

Leveraging {% data variables.copilot.copilot_chat %} to understand security alerts

Additionally, with a {% data variables.copilot.copilot_enterprise %} license, you can ask {% data variables.copilot.copilot_chat %} for help to better understand security alerts in repositories in your organization ({% data variables.product.prodname_code_scanning %}, {% data variables.product.prodname_secret_scanning %}, and {% data variables.product.prodname_dependabot_alerts %}). See AUTOTITLE. {% endif %}

{% ifversion github-certification %}

About {% data variables.product.prodname_GHAS %} Certification

You can highlight your knowledge by earning a {% data variables.product.prodname_GHAS %} certificate with {% data variables.product.prodname_certifications %}. The certification validates your expertise in vulnerability identification, workflow security, and robust security implementation. See AUTOTITLE.

{% endif %}

About {% data variables.product.prodname_GHAS %} with Azure Repos

If you want to use {% data variables.product.prodname_GHAS %} with Azure Repos, see {% data variables.product.prodname_GHAS %} & Azure DevOps in our resources site. For documentation, see Configure {% data variables.product.prodname_ghas_azdo %} in Microsoft Learn.

Further reading