-
Notifications
You must be signed in to change notification settings - Fork 6k
NuGetAuditMode breaking changes #45556
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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
121 changes: 63 additions & 58 deletions
121
...sdk/9.0/nugetaudit-transitive-packages.md → ...dk/10.0/nugetaudit-transitive-packages.md
This file contains hidden or 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,58 +1,63 @@ | ||
| --- | ||
| title: "Breaking change: 'dotnet restore' audits transitive packages" | ||
| description: Learn about a breaking change in the .NET 9 SDK where 'dotnet restore' also produces security vulnerability warnings for transitive packages by default. | ||
| ms.date: 11/14/2024 | ||
| --- | ||
| # 'dotnet restore' audits transitive packages | ||
|
|
||
| The [`dotnet restore` command](../../../tools/dotnet-restore.md), which restores the dependencies and tools of a project, now produces security vulnerability warnings for transitive packages by default. | ||
|
|
||
| ## Previous behavior | ||
|
|
||
| In .NET 8, [NuGetAudit](../8.0/dotnet-restore-audit.md) was introduced to emit warnings for packages with known security vulnerabilities. By default, only direct package references were audited, however, it was possible to change the `NuGetAuditMode` property to include all packages. | ||
|
|
||
| ## New behavior | ||
|
|
||
| Starting in .NET 9, `NuGetAuditMode` defaults to `all` if it hasn't been explicitly set. This setting means that *transitive packages* (dependencies of packages your project directly references) with known vulnerabilities now cause warnings to be reported. | ||
| If your project treats warnings as errors, this behavior can cause restore failures. | ||
|
|
||
| ## Version introduced | ||
|
|
||
| .NET 9 Preview 6 | ||
|
|
||
| ## Type of breaking change | ||
|
|
||
| This change is a [behavioral change](../../categories.md#behavioral-change). | ||
|
|
||
| ## Reason for change | ||
|
|
||
| Packages with known vulnerabilities might cause your app to be exploitable, even if your project does not directly reference or use the vulnerable package. | ||
| New features in .NET 9 also make it easier to investigate the package graph and to suppress advisories that aren't relevant to how your app uses the vulnerable package. | ||
|
|
||
| ## Recommended action | ||
|
|
||
| - To explicitly reduce the probability of this change breaking your build due to warnings, you can consider your usage of `<TreatWarningsAsErrors>` and use `<WarningsNotAsErrors>NU1901;NU1902;NU1903;NU1904</WarningsNotAsErrors>` to ensure known security vulnerabilities are still allowed in your environment. | ||
|
|
||
| - Use tools such as `dotnet nuget why` to find the top-level package that caused the transitive package with the known vulnerability to be included, and try to upgrade it to see if the transitive vulnerability goes away. If not, promote the transitive package to a top-level package by adding a `PackageReference` for it, and upgrade it to a newer version. | ||
|
|
||
| - If you want to suppress a specific advisory, you can add `<NuGetAuditSuppress Include="url" />` item to your project file, where `url` is the URL reported in NuGet's warning message. | ||
|
|
||
| ```xml | ||
| <ItemGroup> | ||
| <NuGetAuditSuppress Include="url" /> | ||
| </ItemGroup> | ||
| ``` | ||
|
|
||
| - If you want to only be warned of direct package references with known vulnerabilities, you can set `<NuGetAuditMode>` to `direct` in your project file. | ||
|
|
||
| ```xml | ||
| <PropertyGroup> | ||
| <NuGetAuditMode>direct</NuGetAuditMode> | ||
| </PropertyGroup> | ||
| ``` | ||
|
|
||
| ## See also | ||
|
|
||
| - [Audit for security vulnerabilities (`dotnet restore`)](../../../tools/dotnet-restore.md#audit-for-security-vulnerabilities) | ||
| - [Auditing package dependencies for security vulnerabilities](/nuget/concepts/auditing-packages) | ||
| - [NuGetAudit 2.0: Elevating Security and Trust in Package Management](https://devblogs.microsoft.com/nuget/nugetaudit-2-0-elevating-security-and-trust-in-package-management/) | ||
| --- | ||
| title: "Breaking change: 'dotnet restore' audits transitive packages" | ||
| description: Learn about a breaking change in the .NET 10 SDK where 'dotnet restore' also produces security vulnerability warnings for transitive packages by default. | ||
| ms.date: 03/28/2025 | ||
| --- | ||
| # 'dotnet restore' audits transitive packages | ||
|
|
||
| The [`dotnet restore` command](../../../tools/dotnet-restore.md), which restores the dependencies of a project, now produces security vulnerability warnings for transitive packages by default when the project targets .NET 10 or a later version. | ||
|
|
||
| ## Previous behavior | ||
|
|
||
| [NuGetAudit](../8.0/dotnet-restore-audit.md) was introduced in .NET 8 to emit warnings for packages with known security vulnerabilities. | ||
| By default, only direct package references were audited, however, it was possible to change the `NuGetAuditMode` property to include all packages. | ||
|
|
||
| In .NET 9 preview 6, NuGetAuditMode's default was changed to `all` for all projects, and this change was reverted back to `direct` in the .NET 9.0.101 SDK. | ||
|
|
||
| ## New behavior | ||
|
|
||
| When projects target .NET 10 or higher, then `NuGetAuditMode` defaults to `all` if it hasn't been explicitly set. | ||
| This setting means that *transitive packages* (dependencies of packages your project directly references) with known vulnerabilities now cause warnings to be reported. | ||
| If your project treats warnings as errors, this behavior can cause restore failures. | ||
|
|
||
| If your project targets .NET 9 or lower, the default for `NuGetAuditMode` remains `direct`. | ||
|
|
||
| ## Version introduced | ||
|
|
||
| .NET 10 Preview 3 | ||
|
|
||
| ## Type of breaking change | ||
|
|
||
| This change is a [behavioral change](../../categories.md#behavioral-change). | ||
|
|
||
| ## Reason for change | ||
|
|
||
| Packages with known vulnerabilities might cause your app to be exploitable, even if your project does not directly reference or directly use the vulnerable package. | ||
|
|
||
| ## Recommended action | ||
|
|
||
| - To prevent audit warnings being treated as errors, even when using `<TreatWarningsAsErrors>`, you can use `<WarningsNotAsErrors>NU1901;NU1902;NU1903;NU1904;$(WarningsNotAsErrors)</WarningsNotAsErrors>`. | ||
|
|
||
| - Use tools such as `dotnet nuget why` to find the top-level package that caused the transitive package with the known vulnerability to be included, and try to upgrade it to see if the transitive vulnerability goes away. If not, promote the transitive package to a top-level package by adding a `PackageReference` for it, and upgrade it to a newer version. | ||
|
|
||
| - If you want to suppress a specific advisory, you can add `<NuGetAuditSuppress Include="url" />` item to your project file, where `url` is the URL reported in NuGet's warning message. | ||
|
|
||
| ```xml | ||
| <ItemGroup> | ||
| <NuGetAuditSuppress Include="url" /> | ||
| </ItemGroup> | ||
| ``` | ||
|
|
||
| - If you want to only be warned of direct package references with known vulnerabilities, you can set `<NuGetAuditMode>` to `direct` in your project file. | ||
|
|
||
| ```xml | ||
| <PropertyGroup> | ||
| <NuGetAuditMode>direct</NuGetAuditMode> | ||
| </PropertyGroup> | ||
| ``` | ||
|
|
||
| ## See also | ||
|
|
||
| - [Audit for security vulnerabilities (`dotnet restore`)](../../../tools/dotnet-restore.md#audit-for-security-vulnerabilities) | ||
| - [Auditing package dependencies for security vulnerabilities](/nuget/concepts/auditing-packages) | ||
| - [NuGetAudit 2.0: Elevating Security and Trust in Package Management](https://devblogs.microsoft.com/nuget/nugetaudit-2-0-elevating-security-and-trust-in-package-management/) |
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.