-
Notifications
You must be signed in to change notification settings - Fork 60.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Manage secret scanning push bypasses at the organization level [Publi…
…c Beta] #15792 (#52250) Co-authored-by: Joe Clark <[email protected]>
- Loading branch information
Showing
5 changed files
with
105 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
...code-security/security-overview/reviewing-requests-to-bypass-push-protection.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
--- | ||
title: Reviewing requests to bypass push protection | ||
shortTitle: Review bypass requests | ||
intro: 'You can use security overview to review requests to bypass push protection from contributors pushing to repositories across your organization.' | ||
permissions: '{% data reusables.security-overview.permissions %}' | ||
product: '{% data reusables.gated-features.security-overview %}' | ||
type: how_to | ||
topics: | ||
- Security overview | ||
- Advanced Security | ||
- Organizations | ||
- Teams | ||
- Secret scanning | ||
- Alerts | ||
versions: | ||
feature: security-overview-delegated-bypass-requests | ||
--- | ||
|
||
## About bypass requests | ||
|
||
If your organization has configured delegated bypass for push protection, a designated team of reviewers controls which organization members can push secrets to repositories in your organization, and which members must first make a "bypass request" in order to push the secret. | ||
|
||
On the "Bypass requests" page in security overview, reviewers can find, review (approve or deny) and manage these requests. | ||
|
||
For more information, see "[AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/managing-requests-to-bypass-push-protection)." | ||
|
||
## Reviewing bypass requests for an organization | ||
|
||
{% data reusables.organizations.navigate-to-org %} | ||
{% data reusables.organizations.security-overview %} | ||
1. In the sidebar, under "Requests", click **{% octicon "key" aria-hidden="true" %} Push protection bypass**. | ||
1. Select the **All statuses** dropdown menu, then click **Open** to view requests that are awaiting review, or that have been approved but for which the commits haven't been pushed to the repository yet. | ||
1. Click the request that you want to review. | ||
1. Review the details of the request. | ||
1. To allow the contributor to push the commit containing the secret, click **Approve bypass request**. Or, to require the contributor to remove the secret from the commit, click **Deny bypass request**. | ||
|
||
## Filtering requests | ||
|
||
You can filter requests by repository, approver (member who has reviewed the request), requester (contributor making the request), timeframe, and status. | ||
|
||
### Filtering by status | ||
|
||
The following statuses are assigned to a request: | ||
|
||
|Status|Description| | ||
|---------|-----------| | ||
|`Cancelled`| The request has been cancelled by the contributor.| | ||
|`Completed`|The request has been approved and the commit(s) have been pushed to the repository.| | ||
|`Denied`|The request has been reviewed and denied.| | ||
|`Expired`| The request has expired. Requests are valid for 7 days. | | ||
|`Open`| The request has either not yet been reviewed, or has been approved but the commit(s) have not been pushed to the repository. | | ||
|
||
## Further reading | ||
|
||
* "[AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection)" | ||
* "[AUTOTITLE](/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/enabling-delegated-bypass-for-push-protection)" |
5 changes: 5 additions & 0 deletions
5
data/features/security-overview-delegated-bypass-requests.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Reference: #15792 | ||
# Documentation for the bypass requests page for delegated bypass at the org-level (security overview) | ||
versions: | ||
ghec: '*' | ||
ghes: '>3.15' |
7 changes: 6 additions & 1 deletion
7
data/reusables/secret-scanning/push-protection-delegated-bypass-note.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,6 @@ | ||
Members {% ifversion push-protection-bypass-fine-grained-permissions %}with permission to review and manage bypass requests {% else %}of the bypass list{% endif %} are still protected from accidentally pushing secrets to a repository. If they attempt to push a commit containing a secret, their push is still blocked, but they can choose to bypass the block by specifying a reason for allowing the push. Members {% ifversion push-protection-bypass-fine-grained-permissions %}with permission to review and manage bypass requests {% else %}of the bypass list {% endif %}do not have to request bypass privileges from other members in order to override the block. | ||
Members {% ifversion push-protection-bypass-fine-grained-permissions %}with permission to review and manage bypass requests {% else %}of the bypass list{% endif %} are still protected from accidentally pushing secrets to a repository. If they attempt to push a commit containing a secret, their push is still blocked, but they can choose to bypass the block by specifying a reason for allowing the push. The following types of people can bypass push protection without requesting bypass privileges: | ||
|
||
* Organization owners | ||
* Security managers | ||
* Users in teams, default roles, or custom roles that have been added to the bypass list.{% ifversion push-protection-bypass-fine-grained-permissions %} | ||
* Users who are assigned (either directly or via a team) a custom role with the "review and manage secret scanning bypass requests" fine-grained permission.{% endif %} |