Skip to content

Commit b3ac074

Browse files
mchammer01am-steadCopilotzackfernmyarb
authored
Code security configurations available at the enterprise level (#53229)
Co-authored-by: Anne-Marie <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Zack Fernandes <[email protected]> Co-authored-by: Melanie Yarbrough <[email protected]>
1 parent 5a579b8 commit b3ac074

22 files changed

+402
-6
lines changed

content/admin/managing-code-security/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ topics:
1111
children:
1212
- /managing-github-advanced-security-for-your-enterprise
1313
- /managing-supply-chain-security-for-your-enterprise
14+
- /securing-your-enterprise
1415
redirect_from:
1516
- /admin/code-security
1617
---
17-
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: About security configurations
3+
shortTitle: Security configurations
4+
intro: 'Security configurations are collections of security settings that you can apply across your enterprise.'
5+
product: '{% data reusables.gated-features.security-configurations-enterprise %}'
6+
versions:
7+
feature: security-configuration-enterprise-level
8+
topics:
9+
- Advanced Security
10+
- Enterprise
11+
- Security
12+
---
13+
14+
## About {% data variables.product.prodname_security_configurations %}
15+
16+
{% data variables.product.prodname_security_configurations_caps %} simplify the rollout of {% data variables.product.company_short %} security products at scale by helping you define collections of security settings and apply them across your enterprise.
17+
18+
{% ifversion security-configurations-cloud %}
19+
20+
We recommend securing your enterprise with the {% data variables.product.prodname_github_security_configuration %}, then evaluating the security findings on your repositories before configuring {% data variables.product.prodname_custom_security_configurations %}. For more information, see "[AUTOTITLE](/admin/managing-code-security/securing-your-enterprise/applying-the-github-recommended-security-configuration-to-your-enterprise)."
21+
22+
{% endif %}
23+
24+
With {% data variables.product.prodname_custom_security_configurations %}, you can create collections of enablement settings for {% data variables.product.company_short %}'s security products to meet the specific security needs of your enterprise. For example, you can create a different {% data variables.product.prodname_custom_security_configuration %} for each organization or group of similar organizations to reflect their different levels of security requirements and compliance obligations. For more information, see "[AUTOTITLE](/admin/managing-code-security/securing-your-enterprise/creating-a-custom-security-configuration-for-your-enterprise)."
25+
26+
{% ifversion security-configurations-ghes-only %}
27+
28+
When creating a security configuration, keep in mind that:
29+
* Only features installed by a site administrator on your {% data variables.product.prodname_ghe_server %} instance will appear in the UI.
30+
* {% data variables.product.prodname_GH_advanced_security %} features will only be visible if your enterprise or {% data variables.product.prodname_ghe_server %} instance holds a {% data variables.product.prodname_GH_advanced_security %} license.
31+
* Certain features, like {% data variables.product.prodname_dependabot_security_updates %} and {% data variables.product.prodname_code_scanning %} default setup, also require that {% data variables.product.prodname_actions %} is installed on the {% data variables.product.prodname_ghe_server %} instance.
32+
33+
{% endif %}
34+
35+
{% data reusables.security-configurations.emu-note %}
36+
37+
{% data reusables.security-configurations.security-features-use-actions %}
38+
39+
## Preserving default settings for new repositories
40+
41+
If you had default security settings in place for newly created repositories, {% data variables.product.github %} will preserve these settings by automatically creating a "New repository default settings" security configuration for your enterprise. The configuration matches your previous enterprise-level default settings for new repositories as of December, 2024.
42+
43+
The "New repository default settings" configuration will automatically get applied to any newly created repositories in your enterprise, if no organization-level defaults are set.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Applying a custom security configuration to your enterprise
3+
shortTitle: Apply custom configuration
4+
intro: 'You can apply your {% data variables.product.prodname_custom_security_configuration %} to organizations and repositories in your organization to meet the specific security needs of your enterprise.'
5+
permissions: '{% data reusables.permissions.security-configuration-enterprise-enable %}'
6+
versions:
7+
feature: security-configuration-enterprise-level
8+
topics:
9+
- Advanced Security
10+
- Organizations
11+
- Security
12+
---
13+
14+
## About applying a {% data variables.product.prodname_custom_security_configuration %}
15+
16+
After you create a {% data variables.product.prodname_custom_security_configuration %}, you need to apply it to repositories in your enterprise to enable the configuration's settings on those repositories.
17+
18+
{% data reusables.security-configurations.security-features-use-actions %}
19+
20+
## Applying your {% data variables.product.prodname_custom_security_configuration %} to repositories in your enterprise
21+
22+
{% data reusables.enterprise-accounts.access-enterprise %}
23+
{% data reusables.enterprise-accounts.settings-tab %}
24+
1. In the left sidebar, click **Code security**.
25+
1. To the right of the configuration you want to apply, select the **Apply to** {% octicon "triangle-down" aria-hidden="true" %} dropdown menu, then click **All repositories** or **All repositories without configurations**.
26+
{% data reusables.security-configurations.apply-configuration-by-default %}
27+
28+
{% data reusables.security-configurations.apply-configuration %}
29+
30+
{% data reusables.security-configurations.failure-handling-enterprise %}
31+
32+
## Next steps
33+
34+
To learn how to edit your {% data variables.product.prodname_custom_security_configuration %}, see "[AUTOTITLE](/admin/managing-code-security/securing-your-enterprise/editing-a-custom-security-configuration)."
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: Applying the GitHub-recommended security configuration to your enterprise
3+
shortTitle: Apply recommended configuration
4+
intro: 'Secure your code with the security enablement settings created, managed, and recommended by {% data variables.product.github %}.'
5+
permissions: '{% data reusables.permissions.security-configuration-enterprise-enable %}'
6+
versions:
7+
ghec: '*'
8+
topics:
9+
- Advanced Security
10+
- Enterprise
11+
- Security
12+
---
13+
14+
## About the {% data variables.product.prodname_github_security_configuration %}
15+
16+
The {% data variables.product.prodname_github_security_configuration %} is a set of industry best practices and features that provide a robust, baseline security posture for enterprises. This configuration is created and maintained by subject matter experts at {% data variables.product.github %}, with the help of multiple industry leaders and experts. The {% data variables.product.prodname_github_security_configuration %} is designed to successfully reduce the security risks for low- and high-impact repositories. We recommend you apply this configuration to all the repositories in your enterprise.
17+
18+
{% data reusables.security-configurations.github-recommended-warning-enterprise %}
19+
20+
## Applying the {% data variables.product.prodname_github_security_configuration %} to repositories in your enterprise
21+
22+
{% data reusables.enterprise-accounts.access-enterprise %}
23+
{% data reusables.enterprise-accounts.settings-tab %}
24+
1. In the left sidebar, click **Code security**.
25+
1. In the "{% data variables.product.company_short %} recommended" row of the configurations table for your enterprise, select the **Apply to** {% octicon "triangle-down" aria-hidden="true" %} dropdown menu, then click **All repositories** or **All repositories without configurations**.
26+
{% data reusables.security-configurations.apply-configuration-by-default %}
27+
28+
{% data reusables.security-configurations.apply-configuration %}
29+
30+
{% data reusables.security-configurations.failure-handling-enterprise %}
31+
32+
## Enforcing the {% data variables.product.prodname_github_security_configuration %}
33+
34+
{% data reusables.enterprise-accounts.access-enterprise %}
35+
{% data reusables.enterprise-accounts.settings-tab %}
36+
1. In the left sidebar, click **Code security**.
37+
1. In the "Configurations" section, select "{% data variables.product.company_short %} recommended".
38+
1. In the "Policy" section, next to "Enforce configuration", select **Enforce** from the dropdown menu.
39+
40+
{% data reusables.code-scanning.custom-security-configuration-enforcement-edge-cases-enterprise %}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Configuring additional secret scanning settings for your enterprise
3+
shortTitle: Configure additional settings
4+
intro: 'Learn how to configure additional {% data variables.product.prodname_secret_scanning %} settings for your enterprise.'
5+
permissions: '{% data reusables.permissions.security-configuration-enterprise-enable %}'
6+
versions:
7+
feature: security-configuration-enterprise-level
8+
topics:
9+
- Advanced Security
10+
- Enterprise
11+
- Security
12+
---
13+
14+
## About additional settings for {% data variables.product.prodname_secret_scanning %}
15+
16+
There are some additional {% data variables.product.prodname_secret_scanning %} settings that cannot be applied to repositories using {% data variables.product.prodname_security_configurations %}, so you must configure these settings separately:
17+
18+
* [Configuring a resource link for push protection](/admin/managing-code-security/securing-your-enterprise/configuring-additional-secret-scanning-settings-for-your-enterprise#configuring-a-resource-link-for-push-protection){% ifversion secret-scanning-ai-generic-secret-detection %}
19+
* [Configuring AI detection to find additional secrets](/admin/managing-code-security/securing-your-enterprise/configuring-additional-secret-scanning-settings-for-your-enterprise#configuring-ai-detection-to-find-additional-secrets){% endif %}
20+
21+
These additional settings only apply to repositories with both {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_secret_scanning %} enabled.
22+
23+
## Accessing the additional settings for {% data variables.product.prodname_secret_scanning %}
24+
25+
{% data reusables.enterprise-accounts.access-enterprise %}
26+
{% data reusables.enterprise-accounts.settings-tab %}
27+
1. In the left sidebar, click **Code security**.
28+
1. Scroll down the page to the "Additional settings" section.
29+
30+
### Configuring a resource link for push protection
31+
32+
To provide context for developers when {% data variables.product.prodname_secret_scanning %} blocks a commit, you can display a link with more information on why the commit was blocked.
33+
34+
1. Under "Additional settings", to the right of "Resource link for push protection", click **{% octicon "pencil" aria-hidden="true" %}**.
35+
1. In the text box, type the link to the desired resource, then click **{% octicon "check" aria-label="Save" %}**.
36+
37+
{% ifversion secret-scanning-ai-generic-secret-detection %}
38+
39+
### Configuring AI detection to find additional secrets
40+
41+
{% data variables.secret-scanning.copilot-secret-scanning %}'s {% data variables.secret-scanning.generic-secret-detection %} is an AI-powered expansion of {% data variables.product.prodname_secret_scanning %} that scans and creates alerts for unstructured secrets, such as passwords.
42+
43+
1. Under "Additional settings", to the right of "Use AI detection to find additional secrets", ensure the setting is toggled to "On".
44+
45+
{% data reusables.secret-scanning.copilot-secret-scanning-generic-secrets-subscription-note %}
46+
47+
To learn more about generic secrets, see "[AUTOTITLE](/code-security/secret-scanning/copilot-secret-scanning/responsible-ai-generic-secrets)."
48+
49+
{% endif %}

0 commit comments

Comments
 (0)