-
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.
initial structural changes, new procedural doc and small additions
- Loading branch information
Showing
7 changed files
with
156 additions
and
91 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
98 changes: 98 additions & 0 deletions
98
...nt/code-security/security-overview/filtering-alerts-in-the-security-overview.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,98 @@ | ||
| --- | ||
| title: Filtering alerts in the security overview | ||
| intro: 'Use filters to view specific categories of alerts' | ||
| product: '{% data reusables.gated-features.security-center %}' | ||
| versions: | ||
| fpt: '*' | ||
| ghes: '>3.1' | ||
| ghec: '*' | ||
| type: how_to | ||
| topics: | ||
| - Security overview | ||
| - Advanced Security | ||
| - Alerts | ||
| - Organizations | ||
| - Teams | ||
| shortTitle: Filtering alerts | ||
| --- | ||
|
|
||
| ## Filtering the list of alerts | ||
|
|
||
| ### Filter by level of risk for repositories | ||
|
|
||
| The level of risk for a repository is determined by the number and severity of alerts from security features. If one or more security features are not enabled for a repository, the repository will have an unknown level of risk. If a repository has no risks that are detected by security features, the repository will have a clear level of risk. | ||
|
|
||
| | Qualifier | Description | | ||
| | -------- | -------- | | ||
| | `risk:high` | Display repositories that are at high risk. | | ||
| | `risk:medium` | Display repositories that are at medium risk. | | ||
| | `risk:low` | Display repositories that are at low risk. | | ||
| | `risk:unknown` | Display repositories that are at an unknown level of risk. | | ||
| | `risk:clear` | Display repositories that have no detected level of risk. | | ||
|
|
||
| ### Filter by number of alerts | ||
|
|
||
| | Qualifier | Description | | ||
| | -------- | -------- | | ||
| | <code>code-scanning-alerts:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_code_scanning %} alerts. This qualifier can use > and < comparison operators. | | ||
| | <code>secret-scanning-alerts:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_secret_scanning %} alerts. This qualifier can use > and < comparison operators. | | ||
| | <code>dependabot-alerts:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_dependabot_alerts %}. This qualifier can use > and < comparison operators. | | ||
|
|
||
| ### Filter by whether security features are enabled | ||
|
|
||
| | Qualifier | Description | | ||
| | -------- | -------- | | ||
| | `enabled:code-scanning` | Display repositories that have {% data variables.product.prodname_code_scanning %} enabled. | | ||
| | `not-enabled:code-scanning` | Display repositories that do not have {% data variables.product.prodname_code_scanning %} enabled. | | ||
| | `enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. | | ||
| | `not-enabled:secret-scanning` | Display repositories that have {% data variables.product.prodname_secret_scanning %} enabled. | | ||
| | `enabled:dependabot-alerts` | Display repositories that have {% data variables.product.prodname_dependabot_alerts %} enabled. | | ||
| | `not-enabled:dependabot-alerts` | Display repositories that do not have {% data variables.product.prodname_dependabot_alerts %} enabled. | | ||
|
|
||
| ### Filter by repository type | ||
|
|
||
| | Qualifier | Description | | ||
| | -------- | -------- | | ||
| {%- ifversion fpt or ghes > 3.1 or ghec %} | ||
| | `is:public` | Display public repositories. | | ||
| {% elsif ghes or ghec or ghae %} | ||
| | `is:internal` | Display internal repositories. | | ||
| {%- endif %} | ||
| | `is:private` | Display private repositories. | | ||
| | `archived:true` | Display archived repositories. | | ||
| | `archived:true` | Display archived repositories. | | ||
|
|
||
| ### Filter by team | ||
|
|
||
| | Qualifier | Description | | ||
| | -------- | -------- | | ||
| | <code>team:<em>TEAM-NAME</em></code> | Displays repositories that *TEAM-NAME* has admin privileges for. | | ||
|
|
||
| ### Filter by topic | ||
|
|
||
| | Qualifier | Description | | ||
| | -------- | -------- | | ||
| | <code>topic:<em>TOPIC-NAME</em></code> | Displays repositories that are classified with *TOPIC-NAME*. | | ||
|
|
||
| ### Sort the list of alerts | ||
|
|
||
| | Qualifier | Description | | ||
| | -------- | -------- | | ||
| | `sort:risk` | Sorts the repositories in your security overview by risk. | | ||
| | `sort:repos` | Sorts the repositories in your security overview alphabetically by name. | | ||
| | `sort:code-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_code_scanning %} alerts. | | ||
| | `sort:secret-scanning-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_secret_scanning %} alerts. | | ||
| | `sort:dependabot-alerts` | Sorts the repositories in your security overview by number of {% data variables.product.prodname_dependabot_alerts %}. | | ||
|
|
||
| ### Filter by repository | ||
|
|
||
| | Qualifier | Description | | ||
| | -------- | -------- | | ||
| | `repository:REPOSITORY-NAME` | Displays alerts for the specified repository | | ||
|
|
||
| ### Filter by secret types | ||
|
|
||
| | Qualifier | Description | | ||
| | -------- | -------- | | ||
| | `secret-type:SERVICE_PROVIDER` | Displays alerts for secrets issued by the specified provider | | ||
| | `secret-type:CUSTOM-PATTERN` | Displays alerts for secrets matching the specified custom pattern. For more information, see "[Defining custom patterns for secret scanning](/code-security/secret-scanning/defining-custom-patterns-for-secret-scanning)." | |
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
53 changes: 53 additions & 0 deletions
53
content/code-security/security-overview/viewing-the-security-overview.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,53 @@ | ||
| --- | ||
| title: Viewing the security overview | ||
| intro: 'Navigate to the different views available in the security overview' | ||
| permissions: Organization owners and security managers can access the security overview for organizations. Members of a team can see the security overview for repositories that the team has admin privileges for. | ||
| product: '{% data reusables.gated-features.security-center %}' | ||
| versions: | ||
| fpt: '*' | ||
| ghes: '>3.1' | ||
| ghec: '*' | ||
| type: how_to | ||
| topics: | ||
| - Security overview | ||
| - Advanced Security | ||
| - Alerts | ||
| - Organizations | ||
| - Teams | ||
| shortTitle: View the security overview | ||
| --- | ||
|
|
||
| ## Viewing the security overview for an organization | ||
|
|
||
| Organization owners and security managers can view the security overview for an organization. | ||
|
|
||
| {% data reusables.organizations.navigate-to-org %} | ||
| {% data reusables.organizations.security-overview %} | ||
| 1. To view aggregate information about alert types, click **Show more**. | ||
|  | ||
| {% data reusables.organizations.filter-security-overview %} | ||
|
|
||
| {% ifversion ghec or ghes > 3.3 %} | ||
|
|
||
| ## Viewing alerts across your organization | ||
|
|
||
| Organization owners and security managers can view subsets of alerts for an organization | ||
|
|
||
| {% data reusables.organizations.navigate-to-org %} | ||
| {% data reusables.organizations.security-overview %} | ||
| 1. In the security sidebar, select the subset of alerts you want to view. | ||
|  | ||
| 2. Optionally, filter the list of alerts. Each view has its own selection of available filters. You can click multiple filters in the drop-down filter menus to narrow your search. You can also type search qualifiers in the search field. For more information about the available qualifiers, see "[Filtering alerts in the security overview](/code-security/security-overview/filtering-alerts-in-the-security-overview)." | ||
|  | ||
|
|
||
| {% endif %} | ||
|
|
||
| ## Viewing the security overview for a team | ||
|
|
||
| Members of a team can see the security overview for repositories that the team has admin privileges for. | ||
|
|
||
| {% data reusables.profile.access_org %} | ||
| {% data reusables.user_settings.access_org %} | ||
| {% data reusables.organizations.specific_team %} | ||
| {% data reusables.organizations.team-security-overview %} | ||
| {% data reusables.organizations.filter-security-overview %} |
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,2 +1,2 @@ | ||
| 1. Optionally, filter the list of alerts. You can click multiple filters in the drop-down filter menus to narrow your search. You can also type search qualifiers in the **Search repositories** field. For more information about the available qualifiers, see "[Filtering the list of alerts](#filtering-the-list-of-alerts)." | ||
| 1. Optionally, filter the list of alerts. You can click multiple filters in the drop-down filter menus to narrow your search. You can also type search qualifiers in the **Search repositories** field. For more information about the available qualifiers, see "[Filtering alerts in the security overview](/code-security/security-overview/filtering-alerts-in-the-security-overview)." | ||
|  |