A Swiss Army knife for developers.
C# blazorcross-platformcsharpdesktopdesktop-appdesktop-applicationdeveloper-toolsextensiblefluentfluent-designlinuxmacosmicasyntax-highlightingtypescriptwindowswindows-10windows-11winui
Updated extensions manager to handle CWE-22 & CWE-23 (#1643)
Benjamin TITEUX02fb7d46d9c6
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.ymlindex 001b9a242..d024a3cae 100644--- a/.github/workflows/ci.yml+++ b/.github/workflows/ci.yml@@ -38,13 +38,13 @@ jobs:run: ./build.cmd RunTestsmacos-latest:name: macOS- runs-on: macos-14+ runs-on: macos-15timeout-minutes: 30steps:- - name: Set to use Xcode 15.1+ - name: Set to use Xcode 26.1.1uses: maxim-lobanov/setup-xcode@v1with:- xcode-version: '15.1'+ xcode-version: '26.1.1'- uses: actions/checkout@v3- name: 'Cache: .nuke/temp, ~/.nuget/packages'uses: actions/cache@v3diff --git a/.gitignore b/.gitignoreindex 620c9a209..54076e8c4 100644--- a/.gitignore+++ b/.gitignore@@ -441,4 +441,7 @@ bld/[Oo]bj/# [Oo]ut/[Ll]og/-[Ll]ogs/\ No newline at end of file+[Ll]ogs/++# TestData+!**/**/TestData/**\ No newline at end of filediff --git a/src/Directory.Packages.props b/src/Directory.Packages.propsindex 8fe950a5f..81830c909 100644--- a/src/Directory.Packages.props+++ b/src/Directory.Packages.props@@ -34,7 +34,7 @@<PackageVersion Include="NuGet.Packaging" Version="6.9.1" /><PackageVersion Include="Nuke.Common" Version="8.0.0" /><PackageVersion Include="OneOf" Version="3.0.271" />- <PackageVersion Include="SixLabors.ImageSharp" Version="3.1.5" />+ <PackageVersion Include="SixLabors.ImageSharp" Version="3.1.12" /><PackageVersion Include="System.Text.Json" Version="8.0.5" /><PackageVersion Include="System.CommandLine" Version="2.0.0-beta4.22272.1" /><PackageVersion Include="System.ComponentModel.Composition" Version="$(DotNetVersion)" />diff --git a/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionInstallationManager.cs b/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionInstallationManager.csindex aabefdeba..11ac1f5e4 100644--- a/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionInstallationManager.cs+++ b/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionInstallationManager.cs@@ -98,7 +98,7 @@ public static class ExtensionInstallationManagerif (Directory.Exists(potentialExtensionInstallationPath)){// Extension is already installed.- return new(AlreadyInstalled: true, nuspecReader, ExtensionInstallationPath: string.Empty);+ return new(true, nuspecReader, string.Empty);}}@@ -112,11 +112,22 @@ public static class ExtensionInstallationManager{if (!pathToExclude.Any(path => packagedFile.Contains(path, StringComparison.CurrentCultureIgnoreCase))){- reader.ExtractFile(packagedFile, Path.Combine(extensionInstallationPath, packagedFile), null);+ // Security: Prevent path traversal vulnerability (CWE-22 & CWE-23).+ string fullTargetPath = Path.GetFullPath(Path.Combine(extensionInstallationPath, packagedFile));+ string fullPluginPath = Path.GetFullPath(extensionInstallationPath);++ if (!fullTargetPath.StartsWith(fullPluginPath + Path.DirectorySeparatorChar, StringComparison.OrdinalIgnoreCase))+ {+ Directory.Delete(extensionInstallationPath, true);+ logger.LogCritical("Security violation: Extension '{packagedFile}' contains path traversal sequence", nuspecReader.GetId());+ return new(nuspecReader, $"Security violation: Extension '{nuspecReader.GetId()}' contains path traversal sequence");+ }++ reader.ExtractFile(packagedFile, fullTargetPath, null);}}- return new(AlreadyInstalled: false, nuspecReader, extensionInstallationPath);+ return new(false, nuspecReader, extensionInstallationPath);}internal static async Task<bool> CheckForAnyUpdateAsync(IWebClientService webClientService)diff --git a/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionInstallationResult.cs b/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionInstallationResult.csindex 57181ce61..c43f8e8b2 100644--- a/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionInstallationResult.cs+++ b/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionInstallationResult.cs@@ -2,6 +2,25 @@namespace DevToys.Blazor.BuiltInTools.ExtensionsManager;-internal record ExtensionInstallationResult(bool AlreadyInstalled, NuspecReader NuspecReader, string ExtensionInstallationPath)+internal class ExtensionInstallationResult{+ internal bool HasSucceeded => string.IsNullOrWhiteSpace(ErrorMessage);+ internal bool AlreadyInstalled { get; }+ internal NuspecReader NuspecReader { get; }+ internal string ExtensionInstallationPath { get; } = string.Empty;+ internal string ErrorMessage { get; } = string.Empty;++ internal ExtensionInstallationResult(NuspecReader nuspecReader, string errorMessage)+ {+ ErrorMessage = errorMessage;+ NuspecReader = nuspecReader;+ }++ internal ExtensionInstallationResult(bool alreadyInstalled, NuspecReader nuspecReader, string extensionInstallationPath)+ {+ AlreadyInstalled = alreadyInstalled;+ NuspecReader = nuspecReader;+ ExtensionInstallationPath = extensionInstallationPath;+ }}+diff --git a/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManager.Designer.cs b/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManager.Designer.csindex d222df922..bf1d7ee3e 100644--- a/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManager.Designer.cs+++ b/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManager.Designer.cs@@ -8,10 +8,11 @@// </auto-generated>//-------------------------------------------------------------------------------namespace DevToys.Blazor.BuiltInTools.ExtensionsManager {+namespace DevToys.Blazor.BuiltInTools.ExtensionsManager+{using System;--++/// <summary>/// A strongly-typed resource class, for looking up localized strings, etc./// </summary>@@ -22,186 +23,237 @@ namespace DevToys.Blazor.BuiltInTools.ExtensionsManager {[global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "17.0.0.0")][global::System.Diagnostics.DebuggerNonUserCodeAttribute()][global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()]- internal class ExtensionsManager {-+ internal class ExtensionsManager+ {+private static global::System.Resources.ResourceManager resourceMan;-+private static global::System.Globalization.CultureInfo resourceCulture;-+[global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]- internal ExtensionsManager() {+ internal ExtensionsManager()+ {}-+/// <summary>/// Returns the cached ResourceManager instance used by this class./// </summary>[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]- internal static global::System.Resources.ResourceManager ResourceManager {- get {- if (object.ReferenceEquals(resourceMan, null)) {+ internal static global::System.Resources.ResourceManager ResourceManager+ {+ get+ {+ if (object.ReferenceEquals(resourceMan, null))+ {global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("DevToys.Blazor.BuiltInTools.ExtensionsManager.ExtensionsManager", typeof(ExtensionsManager).Assembly);resourceMan = temp;}return resourceMan;}}-+/// <summary>/// Overrides the current thread's CurrentUICulture property for all/// resource lookups using this strongly typed resource class./// </summary>[global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)]- internal static global::System.Globalization.CultureInfo Culture {- get {+ internal static global::System.Globalization.CultureInfo Culture+ {+ get+ {return resourceCulture;}- set {+ set+ {resourceCulture = value;}}-+/// <summary>/// Looks up a localized string similar to Manage extensions in DevToys./// </summary>- internal static string AccessibleName {- get {+ internal static string AccessibleName+ {+ get+ {return ResourceManager.GetString("AccessibleName", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to Add and manage third-party extensions in DevToys./// </summary>- internal static string Description {- get {+ internal static string Description+ {+ get+ {return ResourceManager.GetString("Description", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to The extension '{0}' is already installed. If you are trying to update an extension that is already installed, please uninstall the older version first../// </summary>- internal static string ExtensionAlreadyInstalledDescription {- get {+ internal static string ExtensionAlreadyInstalledDescription+ {+ get+ {return ResourceManager.GetString("ExtensionAlreadyInstalledDescription", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to Unable to install this extension./// </summary>- internal static string ExtensionAlreadyInstalledTitle {- get {+ internal static string ExtensionAlreadyInstalledTitle+ {+ get+ {return ResourceManager.GetString("ExtensionAlreadyInstalledTitle", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to {0} - {1}./// </summary>- internal static string ExtensionTitleInList {- get {+ internal static string ExtensionTitleInList+ {+ get+ {return ResourceManager.GetString("ExtensionTitleInList", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to Find more extensions online./// </summary>- internal static string FindMoreExtension {- get {+ internal static string FindMoreExtension+ {+ get+ {return ResourceManager.GetString("FindMoreExtension", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to Install an extension./// </summary>- internal static string InstallExtension {- get {+ internal static string InstallExtension+ {+ get+ {return ResourceManager.GetString("InstallExtension", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to Create an extension for DevToys./// </summary>- internal static string LearnDevelopExtension {- get {+ internal static string LearnDevelopExtension+ {+ get+ {return ResourceManager.GetString("LearnDevelopExtension", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to OK./// </summary>- internal static string OKButtonText {- get {+ internal static string OKButtonText+ {+ get+ {return ResourceManager.GetString("OKButtonText", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to Please close all DevToys windows and restart the app to apply the modifications../// </summary>- internal static string RestartRequiredInfoBarDescription {- get {+ internal static string RestartRequiredInfoBarDescription+ {+ get+ {return ResourceManager.GetString("RestartRequiredInfoBarDescription", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to Restart is require for changes to take effect./// </summary>- internal static string RestartRequiredInfoBarTitle {- get {+ internal static string RestartRequiredInfoBarTitle+ {+ get+ {return ResourceManager.GetString("RestartRequiredInfoBarTitle", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to Manage extensions./// </summary>- internal static string ShortDisplayTitle {- get {+ internal static string ShortDisplayTitle+ {+ get+ {return ResourceManager.GetString("ShortDisplayTitle", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to Third-party extensions can modify the functionality of existing tools and access your computer without your permission. This may expose your data to the internet or install unwanted software on your device. We strongly recommend that you exercise caution and only install extensions that you trust. DevToys authors are not responsible for any damages or losses caused by extensions../// </summary>- internal static string WarningThirdPartyExtensionUsageDescription {- get {+ internal static string WarningThirdPartyExtensionUsageDescription+ {+ get+ {return ResourceManager.GetString("WarningThirdPartyExtensionUsageDescription", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to I understand./// </summary>- internal static string WarningThirdPartyExtensionUsageIUnderstand {- get {+ internal static string WarningThirdPartyExtensionUsageIUnderstand+ {+ get+ {return ResourceManager.GetString("WarningThirdPartyExtensionUsageIUnderstand", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to Terms and Conditions./// </summary>- internal static string WarningThirdPartyExtensionUsageTermsConditions {- get {+ internal static string WarningThirdPartyExtensionUsageTermsConditions+ {+ get+ {return ResourceManager.GetString("WarningThirdPartyExtensionUsageTermsConditions", resourceCulture);}}-+/// <summary>/// Looks up a localized string similar to Warning./// </summary>- internal static string WarningThirdPartyExtensionUsageTitle {- get {+ internal static string WarningThirdPartyExtensionUsageTitle+ {+ get+ {return ResourceManager.GetString("WarningThirdPartyExtensionUsageTitle", resourceCulture);}}++ /// <summary>+ /// Looks up a localized string similar to Warning.+ /// </summary>+ internal static string SecurityPathTraversalErrorMessage+ {+ get+ {+ return ResourceManager.GetString("SecurityPathTraversalErrorMessage", resourceCulture);+ }+ }}}diff --git a/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManager.resx b/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManager.resxindex 51416c53f..5db8f757b 100644--- a/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManager.resx+++ b/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManager.resx@@ -1,6 +1,6 @@<?xml version="1.0" encoding="utf-8"?><root>- <!--+ <!--Microsoft ResX SchemaVersion 2.0@@ -166,4 +166,7 @@<data name="WarningThirdPartyExtensionUsageTitle" xml:space="preserve"><value>Warning</value></data>-</root>\ No newline at end of file+ <data name="SecurityPathTraversalErrorMessage" xml:space="preserve">+ <value>Security violation: Extension {0}' contains path traversal sequence</value>+ </data>+</root>diff --git a/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManagerGuiTool.cs b/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManagerGuiTool.csindex 9daa37af4..ce6107825 100644--- a/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManagerGuiTool.cs+++ b/src/app/dev/DevToys.Blazor/BuiltInTools/ExtensionsManager/ExtensionsManagerGuiTool.cs@@ -157,6 +157,12 @@ internal sealed class ExtensionsManagerGuiTool : IGuiToolfor (int i = 0; i < nugetPackages.Length; i++){ExtensionInstallationResult result = await ExtensionInstallationManager.InstallExtensionAsync(nugetPackages[i]);+ if (!result.HasSucceeded)+ {+ // Extension is not installed.+ await ShowExtensionErrorMessageBoxAsync(result.NuspecReader.GetId());+ return;+ }if (result.AlreadyInstalled){@@ -363,6 +369,32 @@ internal sealed class ExtensionsManagerGuiTool : IGuiTool}}+ private async Task ShowExtensionErrorMessageBoxAsync(string extensionTitle)+ {+ await _view.Value.OpenDialogAsync(+ Stack()+ .Vertical()++ .WithChildren(+ Label()+ .Style(UILabelStyle.Subtitle)+ .Text(ExtensionsManager.ExtensionAlreadyInstalledTitle),+ Label()+ .Style(UILabelStyle.Body)+ .Text(string.Format(ExtensionsManager.SecurityPathTraversalErrorMessage, extensionTitle))),++ Button("extension-error-dialog-ok-button")+ .AlignHorizontally(UIHorizontalAlignment.Right)+ .Text(ExtensionsManager.OKButtonText)+ .OnClick(OnCloseDialogButtonClick),+ isDismissible: true);++ void OnCloseDialogButtonClick()+ {+ _view.Value.CurrentOpenedDialog?.Close();+ }+ }+private static string SizeWithUnit(long value, int decimalPlaces = 1){Guard.IsGreaterThan(decimalPlaces, 0);diff --git a/src/app/dev/DevToys.Blazor/DevToys.Blazor.csproj b/src/app/dev/DevToys.Blazor/DevToys.Blazor.csprojindex 90736a6d4..3e413b9d5 100644--- a/src/app/dev/DevToys.Blazor/DevToys.Blazor.csproj+++ b/src/app/dev/DevToys.Blazor/DevToys.Blazor.csproj@@ -30,6 +30,12 @@<ProjectReference Include="..\DevToys.Localization\DevToys.Localization.csproj" /></ItemGroup>+ <ItemGroup>+ <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">+ <_Parameter1>DevToys.UnitTests</_Parameter1>+ </AssemblyAttribute>+ </ItemGroup>+<ItemGroup><!-- TypeScript --><ConfigFiles Include="tsconfig.json" />diff --git a/src/app/tests/DevToys.UnitTests/Blazor/BuiltInTools/ExtensionInstallationManagerTests.cs b/src/app/tests/DevToys.UnitTests/Blazor/BuiltInTools/ExtensionInstallationManagerTests.csnew file mode 100644index 000000000..546001f16--- /dev/null+++ b/src/app/tests/DevToys.UnitTests/Blazor/BuiltInTools/ExtensionInstallationManagerTests.cs@@ -0,0 +1,96 @@+using System;+using System.IO;+using System.Reflection;+using System.Threading.Tasks;+using DevToys.Blazor.BuiltInTools.ExtensionsManager;+using Microsoft.Extensions.Logging;++namespace DevToys.UnitTests.Blazor.BuiltInTools;++public class ExtensionInstallationManagerTests+{+ private static readonly Assembly assembly = Assembly.GetExecutingAssembly();+ private readonly string _assemblyDirectory = Path.GetDirectoryName(assembly.Location);++ [Fact]+ public async Task InstallExtensionAsyncShouldReturnFailedResultWhenPackageIsInvalid()+ {+ string packageDirectory = Path.Combine(_assemblyDirectory, "Packages");+ try+ {+ LoggingExtensions.LoggerFactory ??= LoggerFactory.Create(builder => { });++ Directory.CreateDirectory(packageDirectory);+ string filePath = Path.Combine("TestData", "cve-invalid-package.nupkg");+ ExtensionInstallationManager.PreferredExtensionInstallationFolder = packageDirectory;+ ExtensionInstallationManager.ExtensionInstallationFolders = [packageDirectory];+ SandboxedFileReader fileReader = GetSandboxedFileReaderFromFilePath(filePath);++ ExtensionInstallationResult result = await ExtensionInstallationManager.InstallExtensionAsync(fileReader);++ result.Should().NotBeNull();+ result.AlreadyInstalled.Should().BeFalse();+ result.NuspecReader.Should().NotBeNull();+ result.ExtensionInstallationPath.Should().BeNullOrEmpty();+ result.HasSucceeded.Should().BeFalse();+ result.ErrorMessage.Should().Be("Security violation: Extension 'DevToys.PoC.ZipSlip' contains path traversal sequence");+ }+ finally+ {+ Directory.Delete(packageDirectory, true);+ }+ }++ [Fact]+ public async Task InstallExtensionAsyncShouldReturnSucceededResultWhenPackageIsValid()+ {+ string packageDirectory = Path.Combine(_assemblyDirectory, "Packages");+ try+ {+ LoggingExtensions.LoggerFactory ??= LoggerFactory.Create(builder => { });+ Directory.CreateDirectory(packageDirectory);++ string filePath = Path.Combine("TestData", "valid-package.nupkg");+ ExtensionInstallationManager.PreferredExtensionInstallationFolder = packageDirectory;+ ExtensionInstallationManager.ExtensionInstallationFolders = [packageDirectory];+ SandboxedFileReader fileReader = GetSandboxedFileReaderFromFilePath(filePath);++ ExtensionInstallationResult result = await ExtensionInstallationManager.InstallExtensionAsync(fileReader);++ result.Should().NotBeNull();+ result.AlreadyInstalled.Should().BeFalse();+ result.NuspecReader.Should().NotBeNull();+ result.ExtensionInstallationPath.Should().NotBeNullOrEmpty();+ result.HasSucceeded.Should().BeTrue();+ result.ErrorMessage.Should().BeNullOrEmpty();+ }+ finally+ {+ Directory.Delete(packageDirectory, true);+ }+ }++ private SandboxedFileReader GetSandboxedFileReaderFromFilePath(string filePath)+ {+ FileInfo fileInfo = GetFile(filePath);+ if (!fileInfo.Exists)+ {+ throw new FileNotFoundException("Unable to find the indicated file.", fileInfo.FullName);+ }++ return SandboxedFileReader.FromFileInfo(fileInfo);+ }++ private FileInfo GetFile(string filePath)+ {+ try+ {+ string resourcePath = Path.Combine(_assemblyDirectory, filePath);+ return new(resourcePath);+ }+ catch+ {+ throw new FileNotFoundException(filePath);+ }+ }+}diff --git a/src/app/tests/DevToys.UnitTests/DevToys.UnitTests.csproj b/src/app/tests/DevToys.UnitTests/DevToys.UnitTests.csprojindex e385bab63..7de3e8de9 100644--- a/src/app/tests/DevToys.UnitTests/DevToys.UnitTests.csproj+++ b/src/app/tests/DevToys.UnitTests/DevToys.UnitTests.csproj@@ -44,4 +44,11 @@</EmbeddedResource></ItemGroup>+ <ItemGroup>+ <EmbeddedResource Include="TestData\**" />+ <Content Include="TestData\**">+ <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>+ </Content>+ </ItemGroup>+</Project>diff --git a/src/app/tests/DevToys.UnitTests/TestData/cve-invalid-package.nupkg b/src/app/tests/DevToys.UnitTests/TestData/cve-invalid-package.nupkgnew file mode 100644index 000000000..314823c27Binary files /dev/null and b/src/app/tests/DevToys.UnitTests/TestData/cve-invalid-package.nupkg differdiff --git a/src/app/tests/DevToys.UnitTests/TestData/valid-package.nupkg b/src/app/tests/DevToys.UnitTests/TestData/valid-package.nupkgnew file mode 100644index 000000000..f80a91c78Binary files /dev/null and b/src/app/tests/DevToys.UnitTests/TestData/valid-package.nupkg differ