Skip to content

Latest commit

 

History

History
130 lines (82 loc) · 10.5 KB

about-github-advanced-security.md

File metadata and controls

130 lines (82 loc) · 10.5 KB
title intro product versions topics redirect_from shortTitle
About GitHub Advanced Security
{% data variables.product.prodname_dotcom %} makes extra security features available to customers under an {% data variables.product.prodname_advanced_security %} license.{% ifversion fpt or ghec %} These features are also enabled for public repositories on {% data variables.product.prodname_dotcom_the_website %}.{% endif %}
{% data reusables.gated-features.ghas %}
fpt ghes ghec
*
*
*
Security
/github/getting-started-with-github/about-github-advanced-security
/github/getting-started-with-github/learning-about-github/about-github-advanced-security
GitHub Advanced Security

About {% data variables.product.prodname_GH_advanced_security %}

{% data variables.product.prodname_dotcom %} 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 %}. Other security features require a {% data variables.product.prodname_GH_advanced_security %} (GHAS){% ifversion fpt or ghec %} license to run on repositories apart from public repositories on {% data variables.product.prodname_dotcom_the_website %}{% endif %}.

{% data reusables.advanced-security.ghas-trial %}

{% ifversion ghes %}For information about buying a license for {% data variables.product.prodname_GH_advanced_security %}, see "AUTOTITLE."{% elsif ghec %}For information about buying a license for {% data variables.product.prodname_GH_advanced_security %}, see "AUTOTITLE."{% elsif fpt %}To purchase a {% data variables.product.prodname_GH_advanced_security %} license, you must be using {% data variables.product.prodname_enterprise %}. For information about upgrading to {% data variables.product.prodname_enterprise %} with {% data variables.product.prodname_GH_advanced_security %}, see "AUTOTITLE" and "AUTOTITLE."{% endif %}

{% ifversion ghas-for-azure-devops %} {% note %}

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

{% endnote %} {% endif %}

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

A {% data variables.product.prodname_GH_advanced_security %} license provides the following additional features{% ifversion fpt %} for private repositories:{% else %}:{% endif %}

  • {% 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. For more information, 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.product_name %}. For more information, see "AUTOTITLE."

  • {% data variables.product.prodname_secret_scanning_caps %} - Detect secrets, for example keys and tokens, that have been checked into {% ifversion fpt %}private repositories{% else %} the repository{% endif %}.{% ifversion secret-scanning-push-protection %} 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 %} For more information, see "AUTOTITLE" and "AUTOTITLE."{% else %} For more information, see "AUTOTITLE."{% endif %}

{% ifversion dependabot-auto-triage-rules %}

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

{% endif %}

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

{% ifversion fpt or ghec %} The table below summarizes the availability of {% data variables.product.prodname_GH_advanced_security %} features for public and private repositories.

{% rowheaders %}

Public repository Private repository
without {% data variables.product.prodname_advanced_security %}
Private repository
with {% data variables.product.prodname_advanced_security %}
Code scanning {% 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" %}
Secret scanning {% octicon "check" aria-label="Yes" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
{% data variables.dependabot.custom_rules_caps %} {% octicon "check" aria-label="Yes" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}
Dependency review {% octicon "check" aria-label="Yes" %} {% octicon "x" aria-label="No" %} {% octicon "check" aria-label="Yes" %}

{% endrowheaders %}

{% endif %}

For information about {% data variables.product.prodname_advanced_security %} features that are in development, see "{% data variables.product.prodname_dotcom %} public roadmap." For an overview of all security features, see "AUTOTITLE."

{% ifversion fpt or ghec %} {% data variables.product.prodname_GH_advanced_security %} features are enabled for all public repositories on {% data variables.product.prodname_dotcom_the_website %}. Organizations that use {% data variables.product.prodname_ghe_cloud %} with {% data variables.product.prodname_advanced_security %} can additionally enable these features for private and internal repositories. {% ifversion fpt %}For more information, see the {% data variables.product.prodname_ghe_cloud %} documentation. {% endif %}

{% ifversion ghes or ghec %}

Deploying GitHub Advanced Security in your enterprise

To learn about what you need to know to plan your {% data variables.product.prodname_GH_advanced_security %} deployment at a high level and to review the rollout phases we recommended, see "AUTOTITLE."

{% endif %}

{% ifversion not fpt %}

Enabling {% data variables.product.prodname_advanced_security %} features

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

{% note %}

Note: {% data reusables.security-configurations.security-configurations-beta-note-short %}

{% endnote %}

{% endif %} {%- ifversion ghes %} The site administrator must enable {% data variables.product.prodname_advanced_security %} for {% data variables.location.product_location %} before you can use these features. For more information, see "AUTOTITLE.

Once your system is set up, you can enable and disable these features at the organization or repository level.

{%- elsif ghec %} For public repositories these features are permanently on and can only be disabled if you change the visibility of the project so that the code is no longer public.

For other repositories, once you have a license for your enterprise account, you can enable and disable these features at the organization or repository level.

{%- endif %} For more information, see "AUTOTITLE" and "AUTOTITLE."

{% ifversion ghec or ghes %} If you have an enterprise account, license use for the entire enterprise is shown on your enterprise license page. For more information, see "AUTOTITLE." {% endif %}

{% endif %}

{% ifversion github-certification %}

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

You can highlight your code security knowledge by earning a {% data variables.product.prodname_GH_advanced_security %} certificate with {% data variables.product.prodname_certifications %}. The certification validates your expertise in vulnerability identification, workflow security, and robust security implementation. For more information, see "AUTOTITLE."

{% endif %}

{% ifversion ghec or ghes %}

Further reading

{% endif %} {% endif %}