Merge pull request #130 from dorssel/ephemeral

Add ephemeral state manager

UnitTests/UnitTests/XmssEphemeralStateManagerTests.cs

@@ -0,0 +1,98 @@
+// SPDX-FileCopyrightText: 2025 Frans van Dorsselaer
+//
+// SPDX-License-Identifier: MIT
+
+using Dorssel.Security.Cryptography;
+
+namespace UnitTests;
+
+[TestClass]
+sealed class XmssEphemeralStateManagerTests
+{
+    [TestMethod]
+    public void Constructor()
+    {
+        _ = new XmssEphemeralStateManager();
+    }
+
+    [TestMethod]
+    public void Store()
+    {
+        var stateManager = new XmssEphemeralStateManager();
+        stateManager.Store(XmssKeyPart.Public, [1]);
+    }
+
+    [TestMethod]
+    public void StoreStoreStatefulPart()
+    {
+        var stateManager = new XmssEphemeralStateManager();
+        stateManager.Store(XmssKeyPart.PrivateStateful, [1]);
+
+        stateManager.StoreStatefulPart([1], [2]);
+    }
+
+    [TestMethod]
+    public void Load()
+    {
+        var data = new byte[] { 1, 2, 3 };
+
+        var stateManager = new XmssEphemeralStateManager();
+        stateManager.Store(XmssKeyPart.Public, data);
+
+        var read = new byte[data.Length];
+
+        Assert.ThrowsException<NotImplementedException>(() =>
+        {
+            stateManager.Load(XmssKeyPart.Public, read);
+        });
+    }
+
+    [TestMethod]
+    public void DeletePublicPart()
+    {
+        var stateManager = new XmssEphemeralStateManager();
+        stateManager.Store(XmssKeyPart.Public, [1]);
+
+        stateManager.DeletePublicPart();
+    }
+
+    [TestMethod]
+    public void DeletePublicPart_NotExists()
+    {
+        var stateManager = new XmssEphemeralStateManager();
+
+        stateManager.DeletePublicPart();
+    }
+
+    [TestMethod]
+    public void DeleteAll()
+    {
+        var stateManager = new XmssEphemeralStateManager();
+        stateManager.Store(XmssKeyPart.PrivateStateless, [1]);
+        stateManager.Store(XmssKeyPart.PrivateStateful, [2]);
+        stateManager.Store(XmssKeyPart.Public, [3]);
+
+        stateManager.DeleteAll();
+    }
+
+    [TestMethod]
+    public void DeleteAll_NotExist()
+    {
+        var stateManager = new XmssEphemeralStateManager();
+
+        stateManager.DeleteAll();
+    }
+
+    [TestMethod]
+    public async Task Use()
+    {
+        using var xmss = new Xmss();
+
+        xmss.GeneratePrivateKey(new XmssEphemeralStateManager(), XmssParameterSet.XMSS_SHA2_10_256, false);
+        await xmss.CalculatePublicKeyAsync();
+        var message = new byte[] { 1, 2, 3 };
+        var signature = xmss.Sign(message);
+
+        Assert.IsTrue(xmss.Verify(message, signature));
+    }
+}

Xmss/XmssEphemeralStateManager.cs

@@ -0,0 +1,38 @@
+// SPDX-FileCopyrightText: 2025 Frans van Dorsselaer
+//
+// SPDX-License-Identifier: MIT
+
+namespace Dorssel.Security.Cryptography;
+
+/// <summary>
+/// TODO
+/// </summary>
+public sealed class XmssEphemeralStateManager()
+    : IXmssStateManager
+{
+    /// <inheritdoc/>
+    public void Store(XmssKeyPart part, ReadOnlySpan<byte> data)
+    {
+    }
+
+    /// <inheritdoc/>
+    public void StoreStatefulPart(ReadOnlySpan<byte> expected, ReadOnlySpan<byte> data)
+    {
+    }
+
+    /// <inheritdoc/>
+    public void Load(XmssKeyPart part, Span<byte> destination)
+    {
+        throw new NotImplementedException();
+    }
+
+    /// <inheritdoc/>
+    public void DeletePublicPart()
+    {
+    }
+
+    /// <inheritdoc/>
+    public void DeleteAll()
+    {
+    }
+}

Xmss/XmssException.cs

@@ -10,31 +10,34 @@
 namespace Dorssel.Security.Cryptography;
 
 /// <summary>
-/// TODO
+/// The exception that is thrown when an error occurs during a cryptographic operation of the native XMSS library.
 /// </summary>
 public class XmssException
     : CryptographicException
 {
     /// <summary>
-    /// TODO
+    /// Initializes a new instance of the <see cref="XmssException"/> class with default properties.
     /// </summary>
     public XmssException()
     {
     }
 
     /// <summary>
-    /// TODO
+    /// Initializes a new instance of the <see cref="XmssException"/> class with a specified error message.
     /// </summary>
-    /// <param name="message">TODO</param>
+    /// <param name="message">The error message that explains the reason for the exception.</param>
     public XmssException(string message) : base(message)
     {
     }
 
     /// <summary>
-    /// TODO
+    /// Initializes a new instance of the <see cref="XmssException"/> class with a specified error message
+    /// and a reference to the inner exception that is the cause of this exception.
     /// </summary>
-    /// <param name="message">TODO</param>
-    /// <param name="innerException">TODO</param>
+    /// <param name="message">The error message that explains the reason for the exception.</param>
+    /// <param name="innerException">The exception that is the cause of the current exception.
+    ///     If the <paramref name="innerException"/> parameter is not <see langword="null"/>,
+    ///     the current exception is raised in a <see langword="catch"/> block that handles the inner exception.</param>
     public XmssException(string message, Exception innerException) : base(message, innerException)
     {
     }

Xmss/XmssStateManagerException.cs

@@ -2,34 +2,38 @@
 //
 // SPDX-License-Identifier: MIT
 
+using System.Security.Cryptography;
+
 namespace Dorssel.Security.Cryptography;
 
 /// <summary>
-/// TODO
+/// The exception that is thrown when an error occurs during a cryptographic operation that requires state management.
 /// </summary>
 public class XmssStateManagerException
-    : IOException
+    : CryptographicException
 {
     /// <summary>
-    /// TODO
+    /// Initializes a new instance of the <see cref="XmssStateManagerException"/> class with default properties.
     /// </summary>
     public XmssStateManagerException()
     {
     }
 
     /// <summary>
-    /// TODO
+    /// Initializes a new instance of the <see cref="XmssStateManagerException"/> class with a specified error message.
     /// </summary>
-    /// <param name="message">TODO</param>
+    /// <param name="message">The error message that explains the reason for the exception.</param>
     public XmssStateManagerException(string message) : base(message)
     {
     }
 
     /// <summary>
     /// TODO
     /// </summary>
-    /// <param name="message">TODO</param>
-    /// <param name="innerException">TODO</param>
+    /// <param name="message">The error message that explains the reason for the exception.</param>
+    /// <param name="innerException">The exception that is the cause of the current exception.
+    ///     If the <paramref name="innerException"/> parameter is not <see langword="null"/>,
+    ///     the current exception is raised in a <see langword="catch"/> block that handles the inner exception.</param>
     public XmssStateManagerException(string message, Exception innerException) : base(message, innerException)
     {
     }