From 2c0782efa5cf77fa84af6ec42c19b6b17e93f949 Mon Sep 17 00:00:00 2001 From: Rod Christiansen Date: Wed, 28 Oct 2026 17:19:00 -0700 Subject: [PATCH] Use motherboard serial when BIOS reporting identity is invalid #69 --- BootstrapMate.csproj | 1 + ReportManager.cs | 26 ++++++-- .../HardwareSerialNumber.cs | 30 ++++++++++ .../HardwareSerialNumberTests.cs | 59 +++++++++++++++++++ 4 files changed, 110 insertions(+), 6 deletions(-) create mode 100644 src/BootstrapMate.Core/HardwareSerialNumber.cs create mode 100644 tests/BootstrapMate.Core.Tests/HardwareSerialNumberTests.cs diff --git a/BootstrapMate.csproj b/BootstrapMate.csproj index 9582363..d8e02aa 100644 --- a/BootstrapMate.csproj +++ b/BootstrapMate.csproj @@ -43,6 +43,7 @@ + diff --git a/ReportManager.cs b/ReportManager.cs index 29d6f68..3d400c4 100644 --- a/ReportManager.cs +++ b/ReportManager.cs @@ -5,7 +5,6 @@ using System.Text; using System.Text.Json; using System.Threading.Tasks; -using Microsoft.Win32; using BootstrapMate.Core; namespace BootstrapMate @@ -109,18 +108,33 @@ private static string CurrentArchitecture() var other => other.ToString().ToUpperInvariant() }; - /// Best-effort hardware serial number from the SMBIOS registry key. + /// Best-effort BIOS or motherboard serial, matching enrollment identity. private static string? SerialNumber() + => HardwareSerialNumber.Resolve( + () => ReadSerialNumber("Win32_BIOS"), + () => ReadSerialNumber("Win32_BaseBoard")); + + private static string? ReadSerialNumber(string className) { try { - using var key = Registry.LocalMachine.OpenSubKey(@"HARDWARE\DESCRIPTION\System\BIOS"); - return key?.GetValue("SystemSerialNumber") as string; + using var searcher = new System.Management.ManagementObjectSearcher($"SELECT SerialNumber FROM {className}"); + using var results = searcher.Get(); + foreach (var obj in results) + { + using (obj) + { + var serial = HardwareSerialNumber.Normalize(obj["SerialNumber"]?.ToString()); + if (serial != null) + return serial; + } + } } - catch + catch (Exception ex) { - return null; + Logger.Warning($"{className} serial lookup for reporting failed: {ex.Message}"); } + return null; } } } diff --git a/src/BootstrapMate.Core/HardwareSerialNumber.cs b/src/BootstrapMate.Core/HardwareSerialNumber.cs new file mode 100644 index 0000000..d3f3a49 --- /dev/null +++ b/src/BootstrapMate.Core/HardwareSerialNumber.cs @@ -0,0 +1,30 @@ +namespace BootstrapMate.Core; + +/// Preserves a usable BIOS serial, falling back to the motherboard serial. +public static class HardwareSerialNumber +{ + public static string? Resolve(Func readBios, Func readBaseBoard) + => TryRead(readBios) ?? TryRead(readBaseBoard); + + public static string? Normalize(string? value) + { + var serial = value?.Trim(); + return string.IsNullOrEmpty(serial) || + string.Equals(serial, "Default String", StringComparison.OrdinalIgnoreCase) || + string.Equals(serial, "System Serial Number", StringComparison.OrdinalIgnoreCase) + ? null : serial; + } + + private static string? TryRead(Func read) + { + try + { + return Normalize(read()); + } + catch + { + // Failure of one firmware source must not prevent trying the next. + return null; + } + } +} diff --git a/tests/BootstrapMate.Core.Tests/HardwareSerialNumberTests.cs b/tests/BootstrapMate.Core.Tests/HardwareSerialNumberTests.cs new file mode 100644 index 0000000..da2e544 --- /dev/null +++ b/tests/BootstrapMate.Core.Tests/HardwareSerialNumberTests.cs @@ -0,0 +1,59 @@ +using Xunit; +using BootstrapMate.Core; + +namespace BootstrapMate.Core.Tests; + +public class HardwareSerialNumberTests +{ + [Fact] + public void ValidBiosSerialIsTrimmedAndDoesNotReadMotherboard() + { + var boardQueried = false; + var serial = HardwareSerialNumber.Resolve(() => " BIOS-123 ", () => + { + boardQueried = true; + return "BOARD-123"; + }); + Assert.Equal("BIOS-123", serial); + Assert.False(boardQueried); + } + + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData(" ")] + [InlineData("Default String")] + [InlineData(" dEfAuLt StRiNg ")] + [InlineData("System Serial Number")] + [InlineData(" system serial number ")] + public void InvalidBiosSerialUsesTrimmedMotherboardSerial(string? bios) + { + Assert.Equal("BOARD-123", HardwareSerialNumber.Resolve(() => bios, () => " BOARD-123 ")); + } + + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData(" ")] + [InlineData(" Default String ")] + [InlineData(" system serial number ")] + public void InvalidMotherboardSerialIsNotAnIdentity(string? board) + { + Assert.Null(HardwareSerialNumber.Resolve(() => "Default String", () => board)); + } + + [Fact] + public void BiosReadFailureStillTriesMotherboard() + { + Assert.Equal("BOARD-123", HardwareSerialNumber.Resolve( + () => throw new InvalidOperationException("BIOS unavailable"), () => "BOARD-123")); + } + + [Fact] + public void BothReadFailuresReturnNoIdentity() + { + Assert.Null(HardwareSerialNumber.Resolve( + () => throw new InvalidOperationException("BIOS unavailable"), + () => throw new InvalidOperationException("Motherboard unavailable"))); + } +}