Merge pull request #132 from dorssel/purge

Rename DeleteAll to Purge
dorssel · Jan 4, 2025 · 9045ae6 · 9045ae6
2 parents d587aca + 0b8b689
commit 9045ae6
Show file tree

Hide file tree

Showing 24 changed files with 221 additions and 140 deletions.
diff --git a/Examples/WebAssembly/LocalStorageStateManager.cs b/Examples/WebAssembly/LocalStorageStateManager.cs
@@ -64,7 +64,7 @@ public void DeletePublicPart()
         LocalStorage.RemoveItem(GetKey(XmssKeyPart.Public));
     }
 
-    public void DeleteAll()
+    public void Purge()
     {
         LocalStorage.RemoveItems([
             GetKey(XmssKeyPart.PrivateStateless),

diff --git a/Examples/WebAssembly/Pages/Home.razor b/Examples/WebAssembly/Pages/Home.razor
@@ -95,15 +95,15 @@ else
     void DestroyKey()
     {
         Xmss.Dispose();
-        new LocalStorageStateManager(LocalStorage, KeyName).DeleteAll();
+        new LocalStorageStateManager(LocalStorage, KeyName).Purge();
         MessageToSign = string.Empty;
         Signature = Array.Empty<byte>();
         Xmss = new Xmss();
     }
 
     void CreateKey()
     {
-        new LocalStorageStateManager(LocalStorage, KeyName).DeleteAll();
+        new LocalStorageStateManager(LocalStorage, KeyName).Purge();
         Xmss.GeneratePrivateKey(new LocalStorageStateManager(LocalStorage, KeyName), XmssParameterSet.XMSS_SHA2_10_256, false);
     }
 

diff --git a/UnitTests/Internal.UnitTests/XmssExceptionTests.cs b/UnitTests/Internal.UnitTests/XmssExceptionTests.cs
@@ -48,4 +48,37 @@ public void ThrowIfNotOkay_Okay()
     {
         XmssException.ThrowIfNotOkay(XmssError.XMSS_OKAY);
     }
+
+    [TestMethod]
+    public void ThrowFaultDetectedIf_False()
+    {
+        XmssException.ThrowFaultDetectedIf(false);
+    }
+
+    [TestMethod]
+    public void ThrowFaultDetectedIf_True()
+    {
+        Assert.ThrowsException<XmssException>(() =>
+        {
+            XmssException.ThrowFaultDetectedIf(true);
+        });
+    }
+
+    [TestMethod]
+    public void ThrowFaultDetectedIf_Null()
+    {
+        XmssException.ThrowFaultDetectedIf(null);
+    }
+
+    [TestMethod]
+    public void ThrowFaultDetectedIf_Exception()
+    {
+        var inner = new InvalidOperationException();
+
+        var exception = Assert.ThrowsException<XmssException>(() =>
+        {
+            XmssException.ThrowFaultDetectedIf(inner);
+        });
+        Assert.AreEqual(inner, exception.InnerException);
+    }
 }
diff --git a/UnitTests/UnitTests/CalculateTests.cs b/UnitTests/UnitTests/CalculateTests.cs
@@ -12,7 +12,7 @@ sealed class CalculateTests
     [TestMethod]
     public async Task CalculatePublicKeyAsync_AndImport()
     {
-        var stateManager = new MemoryStateManager();
+        var stateManager = new MockStateManager();
 
         // generate
         {
@@ -49,7 +49,7 @@ public async Task CalculatePublicKeyAsync_AndImport()
     [TestMethod]
     public async Task CalculatePublicKeyAsync_Report_AndGenerateAgain()
     {
-        var stateManager = new MemoryStateManager();
+        var stateManager = new MockStateManager();
 
         // generate
         {
@@ -84,7 +84,7 @@ await Assert.ThrowsExceptionAsync<InvalidOperationException>(async () =>
     [TestMethod]
     public async Task CalculatePublicKeyAsync_DeletePublicFails()
     {
-        var stateManager = new MemoryStateManager();
+        var stateManager = new MockStateManager();
 
         // generate
         {

diff --git a/UnitTests/UnitTests/CryptoConfigTests.cs b/UnitTests/UnitTests/CryptoConfigTests.cs
@@ -66,7 +66,7 @@ public void Create_Name()
     public void SignatureAlgorithm(XmssParameterSet parameterSet)
     {
         using var xmss = new Xmss();
-        xmss.GeneratePrivateKey(new MemoryStateManager(), parameterSet, false);
+        xmss.GeneratePrivateKey(new MockStateManager(), parameterSet, false);
 
         Assert.IsFalse(string.IsNullOrEmpty(xmss.SignatureAlgorithm));
     }

diff --git a/UnitTests/UnitTests/GenerateTests.cs b/UnitTests/UnitTests/GenerateTests.cs
@@ -23,7 +23,7 @@ public void GeneratePrivateKey(XmssParameterSet parameterSet)
         Assert.IsFalse(xmss.HasPrivateKey);
         Assert.IsFalse(xmss.HasPublicKey);
 
-        xmss.GeneratePrivateKey(new MemoryStateManager(), parameterSet, true);
+        xmss.GeneratePrivateKey(new MockStateManager(), parameterSet, true);
 
         Assert.IsTrue(xmss.HasPrivateKey);
         Assert.IsFalse(xmss.HasPublicKey);
@@ -37,13 +37,13 @@ public void GeneratePrivateKey_AfterPrivateKey()
         Assert.IsFalse(xmss.HasPrivateKey);
         Assert.IsFalse(xmss.HasPublicKey);
 
-        xmss.GeneratePrivateKey(new MemoryStateManager(), XmssParameterSet.XMSS_SHA2_10_256, false);
+        xmss.GeneratePrivateKey(new MockStateManager(), XmssParameterSet.XMSS_SHA2_10_256, false);
 
         Assert.IsTrue(xmss.HasPrivateKey);
         Assert.IsFalse(xmss.HasPublicKey);
         Assert.AreEqual(XmssParameterSet.XMSS_SHA2_10_256, xmss.ParameterSet);
 
-        xmss.GeneratePrivateKey(new MemoryStateManager(), XmssParameterSet.XMSS_SHA2_16_256, false);
+        xmss.GeneratePrivateKey(new MockStateManager(), XmssParameterSet.XMSS_SHA2_16_256, false);
 
         Assert.IsTrue(xmss.HasPrivateKey);
         Assert.IsFalse(xmss.HasPublicKey);
@@ -53,12 +53,12 @@ public void GeneratePrivateKey_AfterPrivateKey()
     [TestMethod]
     public void GeneratePrivateKey_StoreStatelessFails()
     {
-        var stateManager = new MemoryStateManager();
+        var stateManager = new MockStateManager();
         using var xmss = new Xmss();
 
         stateManager.Setup();       // Load stateful (verify not exists)
         stateManager.Setup();       // Load stateless (verify not exists)
-        stateManager.Setup();       // DeleteAll
+        stateManager.Setup();       // Purge
         stateManager.Setup(false);  // Store stateless
 
         Assert.ThrowsException<XmssStateManagerException>(() =>
@@ -71,14 +71,14 @@ public void GeneratePrivateKey_StoreStatelessFails()
     [TestMethod]
     public void GeneratePrivateKey_StoreStatelessAndRollbackFail()
     {
-        var stateManager = new MemoryStateManager();
+        var stateManager = new MockStateManager();
         using var xmss = new Xmss();
 
         stateManager.Setup();       // Load stateful (verify not exists)
         stateManager.Setup();       // Load stateless (verify not exists)
-        stateManager.Setup();       // DeleteAll
+        stateManager.Setup();       // Purge
         stateManager.Setup(false);  // Store stateless
-        stateManager.Setup(false);  // DeleteAll
+        stateManager.Setup(false);  // Purge
 
         Assert.ThrowsException<AggregateException>(() =>
         {

diff --git a/UnitTests/UnitTests/ImportTests.cs b/UnitTests/UnitTests/ImportTests.cs
@@ -19,7 +19,7 @@ sealed class ImportTests
     [DataRow(XmssParameterSet.XMSS_SHAKE256_20_256)]
     public void ImportPrivateKey(XmssParameterSet parameterSet)
     {
-        var stateManager = new MemoryStateManager();
+        var stateManager = new MockStateManager();
 
         {
             using var tmpXmss = new Xmss();
@@ -41,8 +41,8 @@ public void ImportPrivateKey(XmssParameterSet parameterSet)
     [TestMethod]
     public void ImportPrivateKey_AfterPrivateKey()
     {
-        var stateManager1 = new MemoryStateManager();
-        var stateManager2 = new MemoryStateManager();
+        var stateManager1 = new MockStateManager();
+        var stateManager2 = new MockStateManager();
 
         {
             using var tmpXmss = new Xmss();
@@ -75,7 +75,7 @@ public void ImportPrivateKey_AfterPrivateKey()
     public void ImportPrivateKey_Invalid()
     {
         using var xmss = new Xmss();
-        var stateManager = new MemoryStateManager();
+        var stateManager = new MockStateManager();
         xmss.GeneratePrivateKey(stateManager, XmssParameterSet.XMSS_SHA2_10_256, false);
 
         // corrupt blob such that not even the parameter set is valid
@@ -144,7 +144,7 @@ public void ImportRfcPublicKey_WrongSize()
     public void ImportRfcPublicKey_AfterPrivateKey()
     {
         using var xmss = new Xmss();
-        xmss.GeneratePrivateKey(new MemoryStateManager(), XmssParameterSet.XMSS_SHA2_10_256, false);
+        xmss.GeneratePrivateKey(new MockStateManager(), XmssParameterSet.XMSS_SHA2_10_256, false);
 
         Assert.IsTrue(xmss.HasPrivateKey);
         Assert.IsFalse(xmss.HasPublicKey);

diff --git a/UnitTests/UnitTests/MemoryStateManager.cs → UnitTests/UnitTests/MockStateManager.cs b/UnitTests/UnitTests/MemoryStateManager.cs → UnitTests/UnitTests/MockStateManager.cs
@@ -6,7 +6,7 @@
 
 namespace UnitTests;
 
-sealed class MemoryStateManager()
+sealed class MockStateManager()
     : IXmssStateManager
 {
     readonly Dictionary<XmssKeyPart, byte[]?> State = new()
@@ -84,7 +84,7 @@ public void DeletePublicPart()
         State[XmssKeyPart.Public] = null;
     }
 
-    public void DeleteAll()
+    public void Purge()
     {
         ThrowIfPlanned();