Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions BootstrapMate.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@

<ItemGroup>
<PackageReference Include="YamlDotNet" Version="16.3.0" />
<PackageReference Include="System.Management" Version="10.0.12" />
</ItemGroup>

<ItemGroup>
Expand Down
26 changes: 20 additions & 6 deletions ReportManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;
using Microsoft.Win32;
using BootstrapMate.Core;

namespace BootstrapMate
Expand Down Expand Up @@ -109,18 +108,33 @@ private static string CurrentArchitecture()
var other => other.ToString().ToUpperInvariant()
};

/// <summary>Best-effort hardware serial number from the SMBIOS registry key.</summary>
/// <summary>Best-effort BIOS or motherboard serial, matching enrollment identity.</summary>
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;
}
}
}
30 changes: 30 additions & 0 deletions src/BootstrapMate.Core/HardwareSerialNumber.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
namespace BootstrapMate.Core;

/// <summary>Preserves a usable BIOS serial, falling back to the motherboard serial.</summary>
public static class HardwareSerialNumber
{
public static string? Resolve(Func<string?> readBios, Func<string?> 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<string?> read)
{
try
{
return Normalize(read());
}
catch
{
// Failure of one firmware source must not prevent trying the next.
return null;
}
}
}
59 changes: 59 additions & 0 deletions tests/BootstrapMate.Core.Tests/HardwareSerialNumberTests.cs
Original file line number Diff line number Diff line change
@@ -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")));
}
}
Loading