Merge pull request #128 from dorssel/register

Reintroduce RegisterWithCryptoConfig

Author: dorssel

.gitignore

@@ -10,3 +10,4 @@ runtimes/
 TestResults/
 
 *.user
+*.lutconfig

Examples/ConsoleApp/Program.cs

@@ -17,6 +17,8 @@ static Program()
     static async Task Main()
     {
         {
+            Xmss.RegisterWithCryptoConfig();
+
             var oid = CryptoConfig.MapNameToOID("XMSS");
             Console.WriteLine($"Found OID for 'XMSS': {oid}");
 #pragma warning disable IL2026 // Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code

UnitTests/Internal.UnitTests/VersionTests.cs

@@ -2,6 +2,7 @@
 //
 // SPDX-License-Identifier: MIT
 
+using Dorssel.Security.Cryptography;
 using Dorssel.Security.Cryptography.Internal;
 
 namespace Internal.UnitTests;
@@ -38,4 +39,19 @@ public void XMSS_LIBRARY_GET_VERSION_PATCH()
     {
         Assert.AreEqual(0x56, Defines.XMSS_LIBRARY_GET_VERSION_PATCH(0x00123456));
     }
+
+    [TestMethod]
+    public void ThrowIfVersionsNotEqual()
+    {
+        Xmss.ThrowIfVersionsNotEqual(Defines.XMSS_LIBRARY_VERSION, Defines.XMSS_LIBRARY_VERSION);
+    }
+
+    [TestMethod]
+    public void ThrowIfVersionsNotEqual_Throws()
+    {
+        Assert.ThrowsException<DllNotFoundException>(() =>
+        {
+            Xmss.ThrowIfVersionsNotEqual(Defines.XMSS_LIBRARY_VERSION, uint.MaxValue);
+        });
+    }
 }

UnitTests/UnitTests/CryptoConfigTests.cs

@@ -11,6 +11,30 @@ namespace UnitTests;
 [TestClass]
 sealed class CryptoConfigTests
 {
+    [TestMethod]
+    public void IdAlgXmssHashsig()
+    {
+        Assert.IsNotNull(Xmss.IdAlgXmssHashsig.Value);
+        Assert.IsNotNull(Xmss.IdAlgXmssHashsig.FriendlyName);
+    }
+
+    [TestMethod]
+    public void RegisterWithCryptoConfig()
+    {
+        Xmss.RegisterWithCryptoConfig();
+
+        Assert.AreEqual(Xmss.IdAlgXmssHashsig.Value, CryptoConfig.MapNameToOID(Xmss.IdAlgXmssHashsig.FriendlyName!));
+    }
+
+    [TestMethod]
+    public void RegisterWithCryptoConfig_Twice()
+    {
+        Xmss.RegisterWithCryptoConfig();
+        Xmss.RegisterWithCryptoConfig();
+
+        Assert.AreEqual(Xmss.IdAlgXmssHashsig.Value, CryptoConfig.MapNameToOID(Xmss.IdAlgXmssHashsig.FriendlyName!));
+    }
+
     [TestMethod]
     public void Create()
     {
@@ -23,11 +47,10 @@ public void Create()
     [RequiresUnreferencedCode("Calls Dorssel.Security.Cryptography.Xmss.Create(String)")]
     public void Create_Name()
     {
-        Assert.IsNotNull(Xmss.IdAlgXmssHashsig.FriendlyName);
-        Assert.AreEqual("xmss", Xmss.IdAlgXmssHashsig.FriendlyName);
+        Xmss.RegisterWithCryptoConfig();
 
 #pragma warning disable SYSLIB0045 // Type or member is obsolete
-        using var xmss = Xmss.Create("xmss");
+        using var xmss = Xmss.Create(Xmss.IdAlgXmssHashsig.FriendlyName!);
 #pragma warning restore SYSLIB0045 // Type or member is obsolete
 
         Assert.IsNotNull(xmss);

Xmss/Xmss.cs

@@ -8,6 +8,7 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Formats.Asn1;
 using System.Runtime.InteropServices;
+using System.Runtime.Versioning;
 using System.Security.Cryptography;
 using System.Security.Cryptography.X509Certificates;
 using Dorssel.Security.Cryptography.Internal;
@@ -24,20 +25,15 @@ public sealed class Xmss
     #region Construction
     static Xmss()
     {
-        VerifyLibraryVersion();
-        TryRegisterWithCryptoConfig();
+        var runtimeVersion = SafeNativeMethods.xmss_library_get_version();
+        ThrowIfVersionsNotEqual(Defines.XMSS_LIBRARY_VERSION, runtimeVersion);
     }
 
-    /// <summary>
-    /// Throws if either the library cannot be loaded, or it does not expose the expected version (i.e., it is the wrong one).
-    /// </summary>
-    [ExcludeFromCodeCoverage(Justification = "Not testable.")]
-    static void VerifyLibraryVersion()
+    internal static void ThrowIfVersionsNotEqual(uint expected, uint actual)
     {
-        var runtimeVersion = SafeNativeMethods.xmss_library_get_version();
-        if (runtimeVersion != Defines.XMSS_LIBRARY_VERSION)
+        if (actual != expected)
         {
-            throw new DllNotFoundException($"XMSS library version mismatch ({runtimeVersion})");
+            throw new DllNotFoundException($"XMSS library version mismatch ({actual})");
         }
     }
 
@@ -72,22 +68,23 @@ public Xmss()
     /// <seealso href="https://www.ietf.org/archive/id/draft-ietf-lamps-x509-shbs-13.html#name-xmss-algorithm-identifier" />
     public static Oid IdAlgXmssHashsig { get; }  = new("1.3.6.1.5.5.7.6.34", "xmss");
 
-    static void RegisterWithCryptoConfig()
-    {
-        CryptoConfig.AddAlgorithm(typeof(Xmss), IdAlgXmssHashsig.FriendlyName!);
-        CryptoConfig.AddOID(IdAlgXmssHashsig.Value!, IdAlgXmssHashsig.FriendlyName!);
-    }
+    static readonly object RegistrationLock = new();
+    static bool TriedRegisterOnce;
 
-    [ExcludeFromCodeCoverage(Justification = "Not testable; WASM only.")]
-    static void TryRegisterWithCryptoConfig()
+    /// <summary>
+    /// TODO
+    /// </summary>
+    [UnsupportedOSPlatform("browser")]
+    public static void RegisterWithCryptoConfig()
     {
-        try
+        lock (RegistrationLock)
         {
-            RegisterWithCryptoConfig();
-        }
-        catch (PlatformNotSupportedException)
-        {
-            // CryptoConfig is unsupported for WASM.
+            if (!TriedRegisterOnce)
+            {
+                TriedRegisterOnce = true;
+                CryptoConfig.AddAlgorithm(typeof(Xmss), IdAlgXmssHashsig.FriendlyName!);
+                CryptoConfig.AddOID(IdAlgXmssHashsig.Value!, IdAlgXmssHashsig.FriendlyName!);
+            }
         }
     }
     #endregion