BinSkim .NET Updates to version 9 #1024

AllDwarf · 2024-12-19T16:48:27Z

[WIP] BinSkim .NET Updates to version 9

Overview

This pull request focuses on updating the BinSkim project to incorporate the latest .NET updates. The goal is to ensure compatibility with the newest .NET features and improve overall performance and security.

Changes

Updated the project to target the latest .NET version.

Benefits

Enhanced Compatibility: Ensures that the BinSkim project is compatible with the latest .NET version, taking advantage of new features and improvements.

Testing

Verified that the project builds successfully with the latest .NET version.
Ran all existing tests to ensure no regressions were introduced.
Conducted manual testing to confirm that the functionality remains intact.
Additional Notes
If you encounter any issues or have questions about these updates, please feel free to reach out.

src/BinaryParsers/ElfBinary/Dwarf/DwarfMemoryReader.cs

+            catch (Exception ex)
+            {
+                throw new InvalidOperationException("Failed to read string from memory.", ex);
+            }


…and platform checks Add static keyword to lambdas in AnalyzeCommandTests.cs Modified lambda expressions in AnalyzeCommandTests.cs to be static. This change ensures that the lambdas do not capture variables from the enclosing scope, potentially improving performance and clarity. Fixing version constant file Refactor project to target .NET 9.0 and remove obsolete configurations Update ADO build configuration to target .NET 9.0 and add .vscode to .gitignore Update GitHub workflows to target .NET 9.0 and improve formatting steps Update .gitignore and improve Build scripts for .NET 9.0 compatibility Directory.Packages.props fixes

…m support

Removed `using System.Runtime.Versioning;` and `[SupportedOSPlatform("windows")]` from `MSDiaComWrapper.cs` and `Pdb.cs`. Replaced `Marshal.GetObjectForIUnknown` with `ResourceReleaser.GetObjectForIUnknown` in `MSDiaComWrapper.cs`. Removed `OperatingSystem.IsWindows()` checks in `Pdb.cs` and ensured `PlatformSpecificHelpers.ThrowIfNotOnWindows()` still enforces Windows-only execution in `Init` methods. Simplified codebase by removing redundant platform checks.

mkacmar · 2025-01-30T22:55:32Z

BuildAndTest.cmd

+echo         public const string FileVersion = "%MAJOR%.%MINOR%.%PATCH%" + ".0";>> %VERSION_CONSTANTS%
+echo         public const string Version = AssemblyVersion + Prerelease;>> %VERSION_CONSTANTS%
+echo     }>> %VERSION_CONSTANTS%
+echo  }>> %VERSION_CONSTANTS%


It seems there's an extra space at the start of the line here.

mkacmar · 2025-01-30T22:59:13Z

README.md

-| **`--help`** | Table of argument information. |
-| **`--version`** | BinSkim version details. |
-| **`value pos. 0`** | One or more specifiers to a file, directory, or filter pattern that resolves to one or more binaries to analyze. |
+| Argument (short form, long form)       | Meaning                                                                                                                                                                                                                                                                                                                                                         |


Is there any tooling in the repository that checks for correct indentation of Markdown? If not I suspect the indentation gets out of sync very quickly.

If possible - I'd suggest dealing with Markdown formatting outside of this PR.

mkacmar

There are some configs under .vscode/ you want to change too.

mkacmar · 2025-01-30T23:02:46Z

global.json

Do we no longer needs this?

mkacmar · 2025-01-30T23:11:18Z

src/BinaryParsers/ElfBinary/Dwarf/DwarfMemoryReader.cs

@@ -121,13 +121,18 @@ public ulong ReadLength(out bool is64bit)
        /// <summary>
        /// Reads the string from the current position in the stream.
        /// </summary>
-        [HandleProcessCorruptedStateExceptions]


I may be reading the docs wrong, but with HandleProcessCorruptedStateExceptions being removed - are you still trying to catch CSEs with the try-catch block?

mkacmar · 2025-01-30T23:17:00Z

src/Test.UnitTests.BinaryParsers/PEBinary/PEBinaryTests.cs

@@ -212,6 +213,7 @@ public void PEBinary_IsDotNetNativeBootstrapExe()
        }

        [Fact]
+        [SupportedOSPlatform("windows")]


It seems to me there are other places with a runtime check for PlatformSpecificHelpers.RunningOnWindows(), but without SupportedOSPlatform("windows") - do you want to make these more consistent?

mkacmar · 2025-01-30T23:52:01Z

src/Test.UnitTests.BinSkim.Driver/MultithreadedAnalyzeCommandTests.cs

@@ -237,7 +237,7 @@ public void MultithreadedAnalyzeCommand_InitializeGlobalContextFromOptions_Quiet
            Assert.IsType<Sarif.Driver.AggregatingLogger>(context.Logger);

            var aggregatingLogger = (Sarif.Driver.AggregatingLogger)context.Logger;
-            Assert.Equal(0, aggregatingLogger.Loggers.Count);
+            Assert.Empty(aggregatingLogger.Loggers);


Let's call it a nitpick, but unless this is required for the update itself, it would be great to tackle these type of changes in a separate PR.

mkacmar · 2025-01-30T23:58:52Z

src/Test.FunctionalTests.BinSkim.Driver/UpdateBaselines.ps1

@@ -16,8 +15,7 @@ function Build-Tool()
 }


-function Build-Baselines($sourceExtension)
-{
+function Build-Baselines($sourceExtension) {


Nitpick - this is now inconsistent with GenerateTests.ps1, I'd perhaps leave the formatting for PowerShell scripts to a different PR.

mkacmar · 2025-01-31T00:02:48Z

src/Test.ConcurrencyTests/rewriteUnitTests.ps1

It seems quite a lot of stuff got bundled into 7af574f - IMO if we're dropping Test.ConcurrencyTests altogether a separate PR would be great, but perhaps at least a separate commit with some reasoning why?

mkacmar · 2025-01-31T00:10:42Z

src/Directory.Packages.props

Nitpick: It seems there's a mix of major, minor and patch updates - I assume not all of them are strictly .NET update related (I'd be surprised if some of these patch level updates would be). I think it's fine to update dependencies in general, but too many changes here make it a bit tricky to review these. Separate PR in a regular dependency update cycle would be great in the future.

mkacmar · 2025-01-31T00:13:35Z

README.md

-| **`--help`** | Table of argument information. |
-| **`--version`** | BinSkim version details. |
-| **`value pos. 0`** | One or more specifiers to a file, directory, or filter pattern that resolves to one or more binaries to analyze. |
+| Argument (short form, long form)       | Meaning                                                                                                                                                                                                                                                                                                                                                         |


If possible - I'd suggest dealing with Markdown formatting outside of this PR.

AllDwarf changed the title ~~BinSkim .NET Updates to version 9~~ [WIP] BinSkim .NET Updates to version 9 Dec 19, 2024

mkacmar assigned AllDwarf Jan 9, 2025

AllDwarf force-pushed the users/marekaldorf/BinSkim_dotnet_updates branch from 3d1696b to 990a79d Compare January 9, 2025 15:45

AllDwarf force-pushed the users/marekaldorf/BinSkim_dotnet_updates branch 2 times, most recently from 8c0ae1d to c90c64e Compare January 21, 2025 10:43

AllDwarf changed the title ~~[WIP] BinSkim .NET Updates to version 9~~ BinSkim .NET Updates to version 9 Jan 21, 2025

AllDwarf marked this pull request as ready for review January 21, 2025 10:46

AllDwarf requested a review from a team as a code owner January 21, 2025 10:46

github-advanced-security bot found potential problems Jan 21, 2025

View reviewed changes

src/BinaryParsers/ElfBinary/Dwarf/DwarfMemoryReader.cs Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Jan 21, 2025

View reviewed changes

src/BinaryParsers/ElfBinary/Dwarf/DwarfMemoryReader.cs

Comment on lines +132 to +135

catch (Exception ex)

{

throw new InvalidOperationException("Failed to read string from memory.", ex);

}

Check notice

Code scanning / CodeQL

Generic catch clause Note

Generic catch clause.

AllDwarf added 2 commits January 21, 2025 20:59

Dotnet update to 9

7af574f

AllDwarf force-pushed the users/marekaldorf/BinSkim_dotnet_updates branch from c72a5f2 to 0884878 Compare January 21, 2025 20:00

AllDwarf added 3 commits January 21, 2025 21:02

Fix formatting in VersionConstants.cs by removing unnecessary whitespace

a4c7b91

Update ADO build configuration to allow all branches for PRs

aba28fe

Remove platform-specific exceptions in PDB handling for cross-platfor…

ba6cc90

…m support

AllDwarf mentioned this pull request Jan 24, 2025

Update BinSkim to use Net8 #1037

Closed

AllDwarf added this to the Release v4.3.2 milestone Jan 24, 2025

mkacmar reviewed Jan 30, 2025

View reviewed changes

mkacmar reviewed Jan 31, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BinSkim .NET Updates to version 9 #1024

BinSkim .NET Updates to version 9 #1024

AllDwarf commented Dec 19, 2024

mkacmar Jan 30, 2025

mkacmar Jan 30, 2025 •

edited

Loading

mkacmar Jan 31, 2025

mkacmar left a comment

mkacmar Jan 30, 2025

mkacmar Jan 30, 2025

mkacmar Jan 30, 2025

mkacmar Jan 30, 2025

mkacmar Jan 30, 2025

mkacmar Jan 31, 2025

mkacmar Jan 31, 2025

mkacmar Jan 31, 2025

BinSkim .NET Updates to version 9 #1024

Are you sure you want to change the base?

BinSkim .NET Updates to version 9 #1024

Conversation

AllDwarf commented Dec 19, 2024

[WIP] BinSkim .NET Updates to version 9

Overview

Changes

Benefits

Testing

Choose a reason for hiding this comment

mkacmar Jan 30, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkacmar left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mkacmar Jan 30, 2025 •

edited

Loading