Skip to content

Commit e7a56f3

Browse files
Code Scanning - Add section to highlight alert variants / additional paths (#61026)
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent be61aa7 commit e7a56f3

3 files changed

Lines changed: 7 additions & 1 deletion

File tree

333 KB
Loading

content/code-security/concepts/code-scanning/about-code-scanning-alerts.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ If you configure {% data variables.product.prodname_code_scanning %} using {% da
6464

6565
When {% data variables.product.prodname_code_scanning %} reports data-flow alerts, {% data variables.product.prodname_dotcom %} shows you how data moves through the code. {% data variables.product.prodname_code_scanning_caps %} allows you to identify the areas of your code that leak sensitive information, and that could be the entry point for attacks by malicious users.
6666

67+
In some cases, the same vulnerability can be reached through multiple code paths, for example, when several different functions pass user input to the same unsafe operation. {% data variables.product.prodname_code_scanning_caps %} groups these related paths under a single alert rather than creating separate alerts for each path, so you can see the full scope of the vulnerability in one place.
68+
6769
{% data reusables.code-scanning.track-alert-in-issue %}
6870

6971
### About alerts from multiple configurations

content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/assessing-code-scanning-alerts-for-your-repository.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,14 @@ By default, the {% data variables.product.prodname_code_scanning %} alerts page
3131

3232
{% data reusables.code-scanning.explore-alert %}
3333
{% data reusables.code-scanning.alert-default-branch %}
34-
1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used.
34+
1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used. The path view shows each step in the data flow as a numbered list, from the point where user-provided data enters the code (the source) to the point where it's used in a potentially unsafe operation (the sink).
3535

3636
![Screenshot of a {% data variables.product.prodname_code_scanning %} alert. The "Show paths" and "Show more" links are outlined in dark orange.](/assets/images/help/repository/code-scanning-alert-details.png)
3737

38+
Some alerts identify multiple paths through the code that could trigger the same vulnerability. When an alert has multiple paths, a dropdown appears above the path view showing the number of paths available. You can select each path from the dropdown to review it individually.
39+
40+
![Screenshot of a {% data variables.product.prodname_code_scanning %} alert detail page showing the paths dropdown with "3 paths available".](/assets/images/help/repository/multiple-paths-available.png)
41+
3842
1. Alerts from {% data variables.product.prodname_codeql %} analysis include a description of the problem. Click **Show more** for guidance on how to fix your code.
3943
{% data reusables.security.alert-assignee-step %}
4044

0 commit comments

Comments
 (0)