Skip to content

Commit b4b6c80

Browse files
authored
[EDI] Editing a custom security configuration (#59842)
1 parent 562d747 commit b4b6c80

File tree

10 files changed

+47
-32
lines changed

10 files changed

+47
-32
lines changed

content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/applying-the-github-recommended-security-configuration-to-your-enterprise.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ The {% data variables.product.prodname_github_security_configuration %} includes
4141
{% data reusables.enterprise-accounts.advanced-security-tab %}
4242
1. In the "Configurations" section, select "{% data variables.product.company_short %} recommended".
4343
1. In the "Policy" section, next to "Enforce configuration", select **Enforce** from the dropdown menu.
44-
1. Click **Save configuration** to save your change to the {% data variables.product.prodname_github_security_configuration %}.
4544

46-
{% data reusables.code-scanning.custom-security-configuration-enforcement-edge-cases-enterprise %}
45+
{% data reusables.code-scanning.security-configuration-enforcement-edge-cases %}
46+
47+
1. Click **Save configuration** to save your change to the {% data variables.product.prodname_github_security_configuration %}.

content/code-security/how-tos/secure-at-scale/configure-enterprise-security/establish-complete-coverage/creating-a-custom-security-configuration-for-your-enterprise.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ When creating a security configuration, keep in mind that:
8484
{% data reusables.security-configurations.default-configuration-exception-repo-transfers %}
8585
* **Enforce configuration**. Block repository owners from changing features that are enabled or disabled by the configuration (features that are not set aren't enforced). Select **Enforce** from the dropdown menu.
8686

87-
1. To finish creating your {% data variables.product.prodname_custom_security_configuration %}, click **Save configuration**.
87+
{% data reusables.code-scanning.security-configuration-enforcement-edge-cases %}
8888

89-
{% data reusables.code-scanning.custom-security-configuration-enforcement-edge-cases-enterprise %}
89+
{% data reusables.code-scanning.save-custom-configuration %}
9090

9191
## Creating a {% data variables.product.prodname_GHAS %} configuration
9292

@@ -124,9 +124,9 @@ When creating a security configuration, keep in mind that:
124124
{% data reusables.security-configurations.default-configuration-exception-repo-transfers %}
125125
* **Enforce configuration**. Block repository owners from changing features that are enabled or disabled by the configuration (features that are not set aren't enforced). Select **Enforce** from the dropdown menu.
126126

127-
1. To finish creating your {% data variables.product.prodname_custom_security_configuration %}, click **Save configuration**.
127+
{% data reusables.code-scanning.security-configuration-enforcement-edge-cases %}
128128

129-
{% data reusables.code-scanning.custom-security-configuration-enforcement-edge-cases-enterprise %}
129+
{% data reusables.code-scanning.save-custom-configuration %}
130130

131131
{% else %}
132132

@@ -156,9 +156,9 @@ When creating a security configuration, keep in mind that:
156156

157157
1. Optionally, in the "Policy" section, you can enforce the configuration and block repository owners from changing features that are enabled or disabled by the configuration (features that are not set aren't enforced). Next to "Enforce configuration", select **Enforce** from the dropdown menu.
158158

159-
{% data reusables.code-scanning.custom-security-configuration-enforcement-edge-cases-enterprise %}
159+
{% data reusables.code-scanning.security-configuration-enforcement-edge-cases %}
160160

161-
1. To finish creating your {% data variables.product.prodname_custom_security_configuration %}, click **Save configuration**.
161+
{% data reusables.code-scanning.save-custom-configuration %}
162162

163163
{% endif %}
164164

content/code-security/how-tos/secure-at-scale/configure-enterprise-security/manage-your-coverage/editing-a-custom-security-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ After creating and applying a {% data variables.product.prodname_custom_security
3535
1. Edit the enablement settings of your {% data variables.product.prodname_custom_security_configuration %} as desired.
3636
1. In the "Policy" section, you can modify the configuration's enforcement status. Enforcing a configuration will block repository owners from changing features that are enabled or disabled by the configuration, but features that are not set aren't enforced. Next to "Enforce configuration", select **Enforce** or **Don't enforce** from the dropdown menu.
3737

38-
{% data reusables.code-scanning.custom-security-configuration-enforcement-edge-cases-enterprise %}
38+
{% data reusables.code-scanning.security-configuration-enforcement-edge-cases %}
3939

4040
1. To apply your changes, click **Update configuration**.

content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/applying-the-github-recommended-security-configuration-in-your-organization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The {% data variables.product.prodname_github_security_configuration %} is a col
5454
1. In the "Security configurations" section, select "{% data variables.product.company_short %} recommended".
5555
1. In the "Policy" section, next to "Enforce configuration", select **Enforce** from the dropdown menu.
5656

57-
{% data reusables.code-scanning.custom-security-configuration-enforcement-edge-cases %}
57+
{% data reusables.code-scanning.security-configuration-enforcement-edge-cases %}
5858

5959
## Next steps
6060

content/code-security/how-tos/secure-at-scale/configure-organization-security/establish-complete-coverage/creating-a-custom-security-configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ With {% data variables.product.prodname_custom_security_configurations %}, you c
7373
{% data reusables.security-configurations.default-configuration-exception-repo-transfers %}
7474
* **Enforce configuration**. Block repository owners from changing features that are enabled or disabled by the configuration (features that are not set aren't enforced). Select **Enforce** from the dropdown menu.
7575

76-
1. To finish creating your {% data variables.product.prodname_custom_security_configuration %}, click **Save configuration**.
76+
{% data reusables.code-scanning.security-configuration-enforcement-edge-cases %}
7777

78-
{% data reusables.code-scanning.custom-security-configuration-enforcement-edge-cases-enterprise %}
78+
{% data reusables.code-scanning.save-custom-configuration %}
7979

8080
## Creating a {% data variables.product.prodname_GHAS %} configuration
8181

@@ -114,7 +114,7 @@ With {% data variables.product.prodname_custom_security_configurations %}, you c
114114
{% data reusables.security-configurations.default-configuration-exception-repo-transfers %}
115115
* **Enforce configuration**. Block repository owners from changing features that are enabled or disabled by the configuration (features that are not set aren't enforced). Select **Enforce** from the dropdown menu.
116116

117-
1. To finish creating your {% data variables.product.prodname_custom_security_configuration %}, click **Save configuration**.
117+
{% data reusables.code-scanning.save-custom-configuration %}
118118

119119
{% else %}
120120

@@ -149,9 +149,9 @@ With {% data variables.product.prodname_custom_security_configurations %}, you c
149149
{% data reusables.security-configurations.default-configuration-exception-repo-transfers %}
150150
1. Optionally, in the "Policy" section, you can enforce the configuration and block repository owners from changing features that are enabled or disabled by the configuration (features that are not set aren't enforced). Next to "Enforce configuration", select **Enforce** from the dropdown menu.
151151

152-
{% data reusables.code-scanning.custom-security-configuration-enforcement-edge-cases %}
152+
{% data reusables.code-scanning.security-configuration-enforcement-edge-cases %}
153153

154-
1. To finish creating your {% data variables.product.prodname_custom_security_configuration %}, click **Save configuration**.
154+
{% data reusables.code-scanning.save-custom-configuration %}
155155

156156
{% endif %}
157157

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Editing a custom security configuration
33
shortTitle: Edit custom configuration
4-
intro: Change the enablement settings in your {% data variables.product.prodname_custom_security_configuration %} to better meet the security needs of your repositories.
4+
intro: Meet the security needs of your repositories by editing your {% data variables.product.prodname_custom_security_configuration %}.
55
permissions: '{% data reusables.permissions.security-org-enable %}'
66
versions:
77
feature: security-configurations
@@ -15,21 +15,6 @@ redirect_from:
1515
contentType: how-tos
1616
---
1717

18-
## About editing a {% data variables.product.prodname_custom_security_configuration %}
19-
20-
After creating and applying a {% data variables.product.prodname_custom_security_configuration %}, you may need to edit the enablement settings for that configuration to better secure your repositories. Any changes you make to the enablement settings of a {% data variables.product.prodname_security_configuration %} will automatically populate to all linked repositories.
21-
22-
To determine if your {% data variables.product.prodname_custom_security_configuration %} is meeting your security needs, see [AUTOTITLE](/code-security/securing-your-organization/managing-the-security-of-your-organization/interpreting-security-findings).
23-
24-
{% ifversion security-configurations-cloud %}
25-
26-
> [!NOTE]
27-
> The {% data variables.product.prodname_github_security_configuration %} is managed by {% data variables.product.company_short %} and cannot be edited. If you would like to customize your security enablement settings, you need to create a {% data variables.product.prodname_custom_security_configuration %}. For more information, see [AUTOTITLE](/code-security/securing-your-organization/enabling-security-features-in-your-organization/creating-a-custom-security-configuration).
28-
29-
{% endif %}
30-
31-
## Modifying your {% data variables.product.prodname_custom_security_configuration %}
32-
3318
{% data reusables.profile.access_org %}
3419
{% data reusables.organizations.org_settings %}
3520
{% data reusables.security-configurations.view-configurations-page %}
@@ -41,6 +26,6 @@ To determine if your {% data variables.product.prodname_custom_security_configur
4126
1. Edit the enablement settings of your {% data variables.product.prodname_custom_security_configuration %} as desired.
4227
1. In the "Policy" section, you can modify the configuration's enforcement status. Enforcing a configuration will block repository owners from changing features that are enabled or disabled by the configuration, but features that are not set aren't enforced. Next to "Enforce configuration", select **Enforce** or **Don't enforce** from the dropdown menu.
4328

44-
{% data reusables.code-scanning.custom-security-configuration-enforcement-edge-cases %}
29+
{% data reusables.code-scanning.security-configuration-enforcement-edge-cases %}
4530

4631
1. To apply your changes, click **Update configuration**.

content/code-security/reference/security-at-scale/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,6 @@ topics:
1616
contentType: reference
1717
children:
1818
- /available-filters-for-security-overview
19+
- /security-configuration-enforcement
1920
- /troubleshoot-security-configurations
2021
---
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Security configuration enforcement
3+
intro: Understand the complexities of enforcing {% data variables.product.prodname_security_configurations %}.
4+
versions:
5+
feature: security-configurations
6+
contentType: reference
7+
topics:
8+
- Code Security
9+
- Secret Protection
10+
- Organizations
11+
- Security
12+
---
13+
14+
{% data variables.product.prodname_security_configurations_caps %} can be enforced, meaning repository owners cannot change the enablement status of features that are enabled or disabled by the configuration.
15+
16+
## Situations that break enforcement
17+
18+
Some situations can break the enforcement of {% data variables.product.prodname_security_configurations %}. For example, the enablement of {% data variables.product.prodname_code_scanning %} will not apply to a repository if:
19+
* {% data variables.product.prodname_actions %} is initially enabled on the repository, but is then disabled in the repository.
20+
* {% data variables.product.prodname_actions %} required by {% data variables.product.prodname_code_scanning %} configurations are not available in the repository.{% ifversion ghes %}
21+
* Self-hosted runners with the label `code-scanning` are not available.{% endif %}
22+
* The definition for which languages should not be analyzed using {% data variables.product.prodname_code_scanning %} default setup is changed.
23+
24+
## Enforcement and the REST API
25+
26+
If a user in your organization or enterprise attempts to change the enablement status of a feature in an enforced configuration using the REST API, the API call will appear to succeed, but no enablement statuses will change.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1. To finish creating your {% data variables.product.prodname_custom_security_configuration %}, click **Save configuration**.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
> [!NOTE] Some situations can break the enforcement of {% data variables.product.prodname_security_configurations %}. See [AUTOTITLE](/code-security/reference/security-at-scale/security-configuration-enforcement).

0 commit comments

Comments
 (0)