|
| 1 | +--- |
| 2 | +title: "Breaking change: 'dotnet restore' audits transitive packages" |
| 3 | +description: Learn about a breaking change in the .NET 9 SDK where 'dotnet restore' also produces security vulnerability warnings for transitive packages by default. |
| 4 | +ms.date: 11/14/2024 |
| 5 | +--- |
| 6 | +# 'dotnet restore' audits transitive packages |
| 7 | + |
| 8 | +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. |
| 9 | + |
| 10 | +## Previous behavior |
| 11 | + |
| 12 | +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. |
| 13 | + |
| 14 | +## New behavior |
| 15 | + |
| 16 | +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. |
| 17 | +If your project treats errors as warnings, this behavior can cause restore failures. |
| 18 | + |
| 19 | +## Version introduced |
| 20 | + |
| 21 | +.NET 9 Preview 6 |
| 22 | + |
| 23 | +## Type of breaking change |
| 24 | + |
| 25 | +This change is a [behavioral change](../../categories.md#behavioral-change). |
| 26 | + |
| 27 | +## Reason for change |
| 28 | + |
| 29 | +Packages with known vulnerabilities might cause your app to be exploitable, even if your project does not directly reference or use the vulnerable package. |
| 30 | +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. |
| 31 | + |
| 32 | +## Recommended action |
| 33 | + |
| 34 | +- 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. |
| 35 | + |
| 36 | +- 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. |
| 37 | + |
| 38 | +- 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. |
| 39 | + |
| 40 | + ```xml |
| 41 | + <ItemGroup> |
| 42 | + <NuGetAuditSuppress Include="url" /> |
| 43 | + </ItemGroup> |
| 44 | + ``` |
| 45 | + |
| 46 | +- If you want to only be warned of direct package references with known vulnerabilities, you can set `<NuGetAuditMode>` to `direct` in your project file. |
| 47 | + |
| 48 | + ```xml |
| 49 | + <PropertyGroup> |
| 50 | + <NuGetAuditMode>direct</NuGetAuditMode> |
| 51 | + </PropertyGroup> |
| 52 | + ``` |
| 53 | + |
| 54 | +## See also |
| 55 | + |
| 56 | +- [Audit for security vulnerabilities (`dotnet restore`)](../../../tools/dotnet-restore.md#audit-for-security-vulnerabilities) |
| 57 | +- [Auditing package dependencies for security vulnerabilities](/nuget/concepts/auditing-packages) |
| 58 | +- [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/) |
0 commit comments