Skip to content

Commit

Permalink
[March 24] Security overview beta (#18341)
Browse files Browse the repository at this point in the history
* Add 'Security Center' product name variable

* Update index with new Security Center category

* Revert "Update index with new Security Center category"

This reverts commit 74aee4b050639626d2b49d914e4ab7b8c0f63ddc.

* Update Code Security index

* Create index.md for Security Center

* Create Security Center reusables

Beta flag and gated feature

* update AE versioning

* Remove "Security Center" from titles and intros

* Remove "security center" from beta flag

* Add images

* Procedures for filtering and sorting

* Incorporate reviewer feedback

* Incorporate reviewer feedback

Three images will need to be updated

* Update images
  • Loading branch information
ethanpalm authored Mar 29, 2021
1 parent 7b4515f commit d2eaff2
Show file tree
Hide file tree
Showing 17 changed files with 153 additions and 0 deletions.
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.
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.
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.
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.
2 changes: 2 additions & 0 deletions content/code-security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ topics:
{% link_with_intro /security-advisories %}

{% link_with_intro /supply-chain-security %}

{% link_with_intro /security-overview %}
120 changes: 120 additions & 0 deletions content/code-security/security-overview/exploring-security-alerts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
---
title: Exploring security alerts
intro: 'You can view, filter, and sort security alerts for repositories owned by your organization or team in one place.'
product: '{% data reusables.gated-features.security-center %}'
versions:
free-pro-team: '*'
github-ae: 'next'
---

{% data reusables.security-center.beta %}

### About the security overview

You can use the security overview for a high-level view of the security status of your organization or to identify problematic repositories that require intervention. At the organization-level, the security overview displays aggregate and repository-specific security information for repositories owned by your organization. At the team-level, the security overview displays repository-specific security information for repositories that the team has admin privileges for. For more information, see "[Managing team access to an organization repository](/github/setting-up-and-managing-organizations-and-teams/managing-team-access-to-an-organization-repository)."

The security overview indicates whether {% data variables.product.prodname_GH_advanced_security %} features are enabled for repositories owned by your organization and consolidates alerts from {% data variables.product.prodname_advanced_security %} features, including {% data variables.product.prodname_code_scanning %} alerts, {% data variables.product.prodname_dependabot_alerts %}, and {% data variables.product.prodname_secret_scanning %} alerts. For more information, see "[About securing your repository](/code-security/getting-started/about-securing-your-repository)."

In the security overview, you can view, sort, and filter alerts to understand the security risks in your organization and in specific repositories. You can apply multiple filters to focus on areas of interest. For example, you can identify private repositories that have a high number of {% data variables.product.prodname_dependabot_alerts %} or repositories that have no {% data variables.product.prodname_code_scanning %} alerts.

![The security overview for an organization](/assets/images/help/organizations/security-overview.png)

For each repository in the security overview, you will see icons for each type of {% data variables.product.prodname_advanced_security %} feature and how many alerts there are of each type. If an {% data variables.product.prodname_advanced_security %} feature is not enabled for a repository, the icon for that feature will be grayed out.

![Icons in the security overview](/assets/images/help/organizations/security-overview-icons.png)

| Icon | Meaning |
| -------- | -------- |
| {% octicon "code-square" aria-label="Code scanning alerts" %} | {% data variables.product.prodname_code_scanning_capc %} alerts. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/code-security/secure-coding/about-code-scanning)." |
| {% octicon "key" aria-label="Secret scanning alerts" %} | {% data variables.product.prodname_secret_scanning_caps %} alerts. For more information, see "[About {% data variables.product.prodname_secret_scanning %}](/code-security/secret-security/about-secret-scanning)." |
| {% octicon "hubot" aria-label="Dependabot alerts" %} | {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)." |
| {% octicon "check" aria-label="Check" %} | The {% data variables.product.prodname_advanced_security %} feature is enabled, but does not raise alerts in this repository. |
| {% octicon "x" aria-label="x" %} | The {% data variables.product.prodname_advanced_security %} feature is not supported in this repository. |

By default, archived repositories are excluded from the security overview for an organization. You can apply filters to view archived repositories in the security overview. For more information, see "[Filtering the list of alerts](#filtering-the-list-of-alerts)."

The security overview displays active alerts raised by {% data variables.product.prodname_GH_advanced_security %} features. If there are no alerts in the security overview for a repository, undetected security vulnerabilities or code errors may still exist.

### Viewing the security overview for an organization

Organization owners 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**.
![Show more button](/assets/images/help/organizations/security-overview-show-more-button.png)
{% data reusables.organizations.filter-security-overview %}

### 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_profile %}
{% data reusables.profile.access_org %}
{% data reusables.organizations.specific_team %}
{% data reusables.organizations.team-security-overview %}
{% data reusables.organizations.filter-security-overview %}

### 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 {% data variables.product.prodname_advanced_security %} features. If one or more {% data variables.product.prodname_advanced_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 {% data variables.product.prodname_advanced_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 &gt and &lt 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 &gt and &lt comparison operators. |
| <code>dependabot-alerts:<em>n</em></code> | Display repositories that have *n* {% data variables.product.prodname_dependabot_alerts %}. This qualifier can use &gt and &lt comparison operators. |

#### Filter by whether {% data variables.product.prodname_advanced_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 |
| -------- | -------- |
| `is:public` | Display public repositories. |
| `is:internal` | Display internal repositories. |
| `is:private` | Display private 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 %}. |
13 changes: 13 additions & 0 deletions content/code-security/security-overview/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Viewing security alerts for repositories in your organization
shortTitle: Security overview
intro: 'View, sort, and filter the security alerts from across your organization in one place.'
product: '{% data reusables.gated-features.security-center %}'
versions:
free-pro-team: '*'
github-ae: 'next'
---

### Table of Contents

{% link_in_list /exploring-security-alerts %}
4 changes: 4 additions & 0 deletions data/reusables/gated-features/security-center.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{% if currentVersion == "github-ae@latest" %}
The security overview for your organization is available if you have a license for {% data variables.product.prodname_GH_advanced_security %}, which is free during the beta release.
{% else %}
The security overview for your organization is available if you have a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} {% data reusables.advanced-security.more-info-ghas %}
2 changes: 2 additions & 0 deletions data/reusables/organizations/filter-security-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +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)."
![The drop-down filter menus and Search repositories field in the security overview](/assets/images/help/organizations/security-overview-filter-alerts.png)
2 changes: 2 additions & 0 deletions data/reusables/organizations/security-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
1. Under your organization name, click {% octicon "shield" aria-label="The Security shield" %} **Security**.
![Organization security button](/assets/images/help/organizations/organization-security-tab.png)
2 changes: 2 additions & 0 deletions data/reusables/organizations/team-security-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
1. At the top of the team's page, click {% octicon "shield" aria-label="The security icon" %} **Security**.
![Team security overview](/assets/images/help/teams/org-team-page-security-overview.png)
5 changes: 5 additions & 0 deletions data/reusables/security-center/beta.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{% note %}

**Note:** The security overview is currently in beta and subject to change.

{% endnote %}
3 changes: 3 additions & 0 deletions data/variables/product.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ prodname_matching_fund: 'GitHub Sponsors Matching Fund'
prodname_GH_advanced_security: 'GitHub Advanced Security'
prodname_advanced_security: 'Advanced Security'

# Security Center
prodname_security_center: 'Security Center'

# Codespaces
prodname_codespaces: 'Codespaces'
prodname_vs_codespaces: 'Visual Studio Codespaces'
Expand Down

0 comments on commit d2eaff2

Please sign in to comment.