diff --git a/src/Xamarin.Android.Tools.AndroidSdk/DownloadUtils.cs b/src/Xamarin.Android.Tools.AndroidSdk/DownloadUtils.cs index 2fc56cb4a41..38feae4ee36 100644 --- a/src/Xamarin.Android.Tools.AndroidSdk/DownloadUtils.cs +++ b/src/Xamarin.Android.Tools.AndroidSdk/DownloadUtils.cs @@ -111,9 +111,9 @@ static string ComputeHashString (HashAlgorithm hasher, Stream stream) /// Extracts a ZIP archive with Zip Slip protection. public static void ExtractZipSafe (string archivePath, string destinationPath, CancellationToken cancellationToken) { - using var archive = ZipFile.OpenRead (archivePath); var fullExtractRoot = Path.GetFullPath (destinationPath); + using var archive = ZipFile.OpenRead (archivePath); foreach (var entry in archive.Entries) { cancellationToken.ThrowIfCancellationRequested (); @@ -131,7 +131,7 @@ public static void ExtractZipSafe (string archivePath, string destinationPath, C if (!string.IsNullOrEmpty (entryDir)) Directory.CreateDirectory (entryDir); - entry.ExtractToFile (destinationFile, overwrite: true); + entry.ExtractToFile (destinationFile, overwrite: true); // CodeQL [SM02729] IsUnderDirectory canonicalizes both paths and enforces ordinal directory-boundary containment. } } diff --git a/src/Xamarin.Android.Tools.AndroidSdk/FileUtil.cs b/src/Xamarin.Android.Tools.AndroidSdk/FileUtil.cs index f324fbd6be4..7d6d61c7a2f 100644 --- a/src/Xamarin.Android.Tools.AndroidSdk/FileUtil.cs +++ b/src/Xamarin.Android.Tools.AndroidSdk/FileUtil.cs @@ -186,13 +186,18 @@ internal static bool IsTargetPathWritable (string targetPath, ActionChecks if a path is under a given directory. - internal static bool IsUnderDirectory (string path, string directory) + internal static bool IsUnderDirectory (string? path, string? directory) { if (string.IsNullOrEmpty (directory) || string.IsNullOrEmpty (path)) return false; - if (path.Equals (directory, StringComparison.OrdinalIgnoreCase)) + + var fullPath = Path.GetFullPath (path); + var fullDirectory = Path.GetFullPath (directory); + if (fullPath.Equals (fullDirectory, StringComparison.Ordinal)) return true; - return path.StartsWith (directory + Path.DirectorySeparatorChar, StringComparison.OrdinalIgnoreCase); + if (!fullDirectory.EndsWith (Path.DirectorySeparatorChar.ToString (), StringComparison.Ordinal)) + fullDirectory += Path.DirectorySeparatorChar; + return fullPath.StartsWith (fullDirectory, StringComparison.Ordinal); } // Returns .msi (Windows), .pkg (macOS), or null (Linux) @@ -271,4 +276,3 @@ internal static async Task SetExecutablePermissionsAsync (string directory, Acti #endif } } - diff --git a/tests/Xamarin.Android.Tools.AndroidSdk-Tests/DownloadUtilsTests.cs b/tests/Xamarin.Android.Tools.AndroidSdk-Tests/DownloadUtilsTests.cs index 67b05125436..bf6d5ac6752 100644 --- a/tests/Xamarin.Android.Tools.AndroidSdk-Tests/DownloadUtilsTests.cs +++ b/tests/Xamarin.Android.Tools.AndroidSdk-Tests/DownloadUtilsTests.cs @@ -163,18 +163,19 @@ public void ExtractZipSafe_ValidZip_ExtractsFiles () Assert.AreEqual ("hello world", File.ReadAllText (extractedFile)); } - [Test] - public void ExtractZipSafe_ZipSlip_Throws () + [TestCase ("../relative.txt")] + [TestCase ("../extracted-other/prefix.txt")] + [TestCase ("../EXTRACTED/case.txt")] + public void ExtractZipSafe_UnsafeRelativePath_Throws (string entryName) { - var zipPath = Path.Combine (tempDir, "evil.zip"); + var zipPath = Path.Combine (tempDir, "test.zip"); var extractPath = Path.Combine (tempDir, "extracted"); Directory.CreateDirectory (extractPath); using (var archive = ZipFile.Open (zipPath, ZipArchiveMode.Create)) { - // Create an entry with a path traversal - var entry = archive.CreateEntry ("../relative.txt"); + var entry = archive.CreateEntry (entryName); using var writer = new StreamWriter (entry.Open ()); - writer.Write ("malicious"); + writer.Write ("foo"); } var ex = Assert.Throws (() => @@ -182,6 +183,81 @@ public void ExtractZipSafe_ZipSlip_Throws () Assert.That (ex!.Message, Does.Contain ("outside target directory")); } + [Test] + public void ExtractZipSafe_PlatformSeparatorTraversal_Throws () + { + var zipPath = Path.Combine (tempDir, "test.zip"); + var extractPath = Path.Combine (tempDir, "extracted"); + Directory.CreateDirectory (extractPath); + + using (var archive = ZipFile.Open (zipPath, ZipArchiveMode.Create)) { + var entry = archive.CreateEntry ($"..{Path.DirectorySeparatorChar}relative.txt"); + using var writer = new StreamWriter (entry.Open ()); + writer.Write ("foo"); + } + + Assert.Throws (() => + DownloadUtils.ExtractZipSafe (zipPath, extractPath, CancellationToken.None)); + } + + [Test] + public void ExtractZipSafe_RootedPath_Throws () + { + var zipPath = Path.Combine (tempDir, "test.zip"); + var extractPath = Path.Combine (tempDir, "extracted"); + Directory.CreateDirectory (extractPath); + var pathRoot = Path.GetPathRoot (extractPath); + Assert.IsNotNull (pathRoot); + + using (var archive = ZipFile.Open (zipPath, ZipArchiveMode.Create)) { + var entry = archive.CreateEntry (Path.Combine (pathRoot, "rooted.txt")); + using var writer = new StreamWriter (entry.Open ()); + writer.Write ("foo"); + } + + Assert.Throws (() => + DownloadUtils.ExtractZipSafe (zipPath, extractPath, CancellationToken.None)); + } + + [Test] + public void ExtractZipSafe_TrailingSeparator_ExtractsFiles () + { + var zipPath = Path.Combine (tempDir, "test.zip"); + var extractPath = Path.Combine (tempDir, "extracted") + Path.DirectorySeparatorChar; + Directory.CreateDirectory (extractPath); + + using (var archive = ZipFile.Open (zipPath, ZipArchiveMode.Create)) { + var entry = archive.CreateEntry ("hello.txt"); + using var writer = new StreamWriter (entry.Open ()); + writer.Write ("hello world"); + } + + DownloadUtils.ExtractZipSafe (zipPath, extractPath, CancellationToken.None); + + Assert.AreEqual ("hello world", File.ReadAllText (Path.Combine (extractPath, "hello.txt"))); + } + + [Test] + public void ExtractZipSafe_SymbolicLinkMetadata_ExtractsRegularFile () + { + var zipPath = Path.Combine (tempDir, "test.zip"); + var extractPath = Path.Combine (tempDir, "extracted"); + Directory.CreateDirectory (extractPath); + + using (var archive = ZipFile.Open (zipPath, ZipArchiveMode.Create)) { + var entry = archive.CreateEntry ("link"); + entry.ExternalAttributes = unchecked ((0xA000 | 0x1FF) << 16); + using var writer = new StreamWriter (entry.Open ()); + writer.Write ("../outside.txt"); + } + + DownloadUtils.ExtractZipSafe (zipPath, extractPath, CancellationToken.None); + + var extractedFile = Path.Combine (extractPath, "link"); + Assert.IsTrue (File.Exists (extractedFile)); + Assert.IsFalse ((File.GetAttributes (extractedFile) & FileAttributes.ReparsePoint) != 0); + } + [Test] public void ExtractZipSafe_EmptyZip_NoFilesExtracted () { diff --git a/tests/Xamarin.Android.Tools.AndroidSdk-Tests/FileUtilTests.cs b/tests/Xamarin.Android.Tools.AndroidSdk-Tests/FileUtilTests.cs index c94d2cc29a7..88ff197842f 100644 --- a/tests/Xamarin.Android.Tools.AndroidSdk-Tests/FileUtilTests.cs +++ b/tests/Xamarin.Android.Tools.AndroidSdk-Tests/FileUtilTests.cs @@ -93,7 +93,7 @@ public void MoveWithRollback_SourceDoesNotExist_NoExistingTarget_Throws () [Test] public void IsUnderDirectory_ChildPath_ReturnsTrue () { - var parent = Path.Combine ($"{Path.DirectorySeparatorChar}opt", "programs"); + var parent = Path.Combine (tempDir, "programs"); var child = Path.Combine (parent, "java", "jdk-21"); Assert.IsTrue (FileUtil.IsUnderDirectory (child, parent)); } @@ -101,24 +101,32 @@ public void IsUnderDirectory_ChildPath_ReturnsTrue () [Test] public void IsUnderDirectory_ExactMatch_ReturnsTrue () { - var dir = Path.Combine ($"{Path.DirectorySeparatorChar}opt", "programs"); - Assert.IsTrue (FileUtil.IsUnderDirectory (dir, dir)); + var directory = Path.Combine (tempDir, "programs"); + Assert.IsTrue (FileUtil.IsUnderDirectory (directory, directory)); } [Test] public void IsUnderDirectory_SiblingPath_ReturnsFalse () { Assert.IsFalse (FileUtil.IsUnderDirectory ( - Path.Combine ($"{Path.DirectorySeparatorChar}opt", "data", "java"), - Path.Combine ($"{Path.DirectorySeparatorChar}opt", "programs"))); + Path.Combine (tempDir, "data", "java"), + Path.Combine (tempDir, "programs"))); } [Test] public void IsUnderDirectory_DifferentRoot_ReturnsFalse () { Assert.IsFalse (FileUtil.IsUnderDirectory ( - Path.Combine ($"{Path.DirectorySeparatorChar}other", "java"), - Path.Combine ($"{Path.DirectorySeparatorChar}opt", "programs"))); + Path.Combine (Path.GetPathRoot (tempDir), "other", "java"), + Path.Combine (tempDir, "programs"))); + } + + [Test] + public void IsUnderDirectory_PartialDirNameMatch_ReturnsFalse () + { + var parent = Path.Combine (tempDir, "programs"); + var sibling = Path.Combine (tempDir, "programs-extra", "java"); + Assert.IsFalse (FileUtil.IsUnderDirectory (sibling, parent)); } [TestCase (null, "/dir")] @@ -128,24 +136,24 @@ public void IsUnderDirectory_DifferentRoot_ReturnsFalse () [TestCase (null, null)] public void IsUnderDirectory_NullOrEmpty_ReturnsFalse (string path, string directory) { - Assert.IsFalse (FileUtil.IsUnderDirectory (path!, directory!)); + Assert.IsFalse (FileUtil.IsUnderDirectory (path, directory)); } [Test] - public void IsUnderDirectory_CaseInsensitive () + public void IsUnderDirectory_CaseSensitive () { - var parent = Path.Combine ($"{Path.DirectorySeparatorChar}opt", "Programs"); - var child = Path.Combine ($"{Path.DirectorySeparatorChar}opt", "PROGRAMS", "java"); - Assert.IsTrue (FileUtil.IsUnderDirectory (child, parent)); + var parent = Path.Combine (tempDir, "Programs"); + var child = Path.Combine (tempDir, "PROGRAMS", "java"); + Assert.IsFalse (FileUtil.IsUnderDirectory (child, parent)); } [Test] - public void IsUnderDirectory_PartialDirNameMatch_ReturnsFalse () + public void IsUnderDirectory_CanonicalCaseMismatch_ReturnsFalse () { - var parent = Path.Combine ($"{Path.DirectorySeparatorChar}opt", "programs"); - Assert.IsFalse (FileUtil.IsUnderDirectory ( - Path.Combine ($"{Path.DirectorySeparatorChar}opt", "programs-extra", "java"), - parent)); + var parent = Path.Combine (tempDir, "programs"); + var sibling = Path.Combine (parent, "..", "PROGRAMS", "java"); + Assert.IsFalse (FileUtil.IsUnderDirectory (sibling, parent)); } + } }