Add Ascon Hash Algorithm (#479)

Author: Kalkwst

Algorithms.Tests/Crypto/Digests/AsconDigestTests.cs

@@ -0,0 +1,266 @@
+using System;
+using System.Text;
+using Algorithms.Crypto.Digests;
+using Algorithms.Crypto.Exceptions;
+using FluentAssertions;
+using NUnit.Framework;
+
+namespace Algorithms.Tests.Crypto.Digests;
+
+[NonParallelizable]
+public class AsconDigestTests
+{
+    private readonly AsconDigest asconHash = new AsconDigest(AsconDigest.AsconParameters.AsconHash);
+    private readonly AsconDigest asconHashA = new AsconDigest(AsconDigest.AsconParameters.AsconHashA);
+
+    [TestCase("a", "02a9d471afab12914197af7090f00d16c41b6e30be0a63bbfd00bc13064de548")]
+    [TestCase("abc", "d37fe9f1d10dbcfad8408a6804dbe91124a8912693322bb23ec1701e19e3fd51")]
+    [TestCase("Hello", "d80f38d94ad72bd18718879f753a44870e8446925ff64bd7441db5fe020b6c0c")]
+    [TestCase("message digest", "e8848979c5adfd21bfcf29e54be1dd085ee523d251e8e6876f2654d6368da0ca")]
+    [TestCase("abcdefghijklmnopqrstuvwxyz", "c62368674e1b2301f19f46c50bb7f87a988a3e41205d68ab9d7882d2a15e917b")]
+    [TestCase("ABCDEFGHIJKLMNOPQRSTUVWXYZ", "4ff71928d740524735b5ab12bb1598463054f88089f3c5f9760b6bdcd23f897b")]
+    [TestCase("12345678901234567890123456789012345678901234567890123456789012345678901234567890", "2dae8b553b93841120e88ee77b9ccb8b512a32318db6012025f3f1c482b1def8")]
+    public void AsconHash_ReturnsCorrectValue(string input, string expected)
+    {
+        var inputBytes = Encoding.ASCII.GetBytes(input);
+        var result = asconHash.Digest(inputBytes);
+
+        result.Should().Be(expected);
+    }
+
+    [TestCase("a", "062bb0346671da00da4f460308b4d2c4d9877c3e2827d6229ff5361332d36527")]
+    [TestCase("abc", "836a5ddba0142b011ce3425ea9789fd6a21628d619195a48c1540f847667a84e")]
+    [TestCase("Hello", "15f245df8af697dc540e86083822809ab7299575d8ad6c2e17ecc603a7ab79dd")]
+    [TestCase("message digest", "3f18a1f398a40a77e0e9477aa6cb50e9e1abecff651c1874f9717c02c8a165ba")]
+    [TestCase("abcdefghijklmnopqrstuvwxyz", "406b809260f361e12dcf0bf924bfe1ffd2f987fc18d90b94fc544ff80dc2946b")]
+    [TestCase("ABCDEFGHIJKLMNOPQRSTUVWXYZ", "5c6c69ff3ee83361391b7236c8eb6718f52df43de5a61a4f4d2819d40430dc19")]
+    [TestCase("12345678901234567890123456789012345678901234567890123456789012345678901234567890", "d8e38fc50d682550cd176decda61adb7fd1c793cdafa825f17f3a002d65847be")]
+    public void AsconHashA_ReturnsCorrectValue(string input, string expected)
+    {
+        var inputBytes = Encoding.ASCII.GetBytes(input);
+        var result = asconHashA.Digest(inputBytes);
+
+        result.Should().Be(expected);
+    }
+
+    [Test]
+    public void BlockUpdate_WithValidOffsetAndLength_ShouldProcessCorrectly()
+    {
+        // Arrange
+        var input = new byte[] { 0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77, 0x88, 0x99 };
+        var offset = 2;
+        var length = 6; // Picking 6 bytes starting from offset 2
+
+        // Act
+        var act = () => asconHash.BlockUpdate(input, offset, length);
+
+        // Assert
+        act.Should().NotThrow(); // Ensure no exceptions are thrown during processing
+
+        // Finalize the hash and check the output size
+        var output = new byte[asconHash.GetDigestSize()];
+        asconHash.DoFinal(output, 0);
+        output.Should().HaveCount(32); // Ascon hash size is 32 bytes
+    }
+
+    [Test]
+    public void BlockUpdate_WithInvalidOffset_ShouldThrowDataLengthException()
+    {
+        // Arrange
+        var input = new byte[] { 0x00, 0x11, 0x22, 0x33 };
+        var offset = 3; // Offset goes too close to the end
+        var length = 3; // Length would exceed buffer size
+
+        // Act
+        var act = () => asconHash.BlockUpdate(input, offset, length);
+
+        // Assert
+        act.Should().Throw<DataLengthException>()
+            .WithMessage("input buffer too short");
+    }
+
+    [Test]
+    public void BlockUpdate_WithInvalidLength_ShouldThrowDataLengthException()
+    {
+        // Arrange
+        var input = new byte[] { 0x00, 0x11, 0x22, 0x33, 0x44, 0x55 };
+        var offset = 1; // Valid offset
+        var length = 10; // Invalid length (exceeds buffer)
+
+        // Act
+        var act = () => asconHash.BlockUpdate(input, offset, length);
+
+        // Assert
+        act.Should().Throw<DataLengthException>()
+            .WithMessage("input buffer too short");
+    }
+
+    [Test]
+    public void BlockUpdate_WithPartialBlock_ShouldProcessCorrectly()
+    {
+        // Arrange
+        var input = new byte[] { 0x00, 0x11, 0x22, 0x33, 0x44 };
+        var offset = 0;
+        var length = 5; // Less than 8 bytes, partial block
+
+        // Act
+        asconHash.BlockUpdate(input, offset, length);
+
+        // Assert
+        var output = new byte[asconHash.GetDigestSize()];
+        asconHash.DoFinal(output, 0);
+        output.Should().HaveCount(32); // Ensure valid hash output
+    }
+
+    [Test]
+    public void BlockUpdate_WithFullBlock_ShouldProcessCorrectly()
+    {
+        // Arrange
+        var input = new byte[] { 0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77 };
+        var offset = 0;
+        var length = 8; // Full block
+
+        // Act
+        asconHash.BlockUpdate(input, offset, length);
+
+        // Assert
+        var output = new byte[asconHash.GetDigestSize()];
+        asconHash.DoFinal(output, 0);
+        output.Should().HaveCount(32); // Ensure valid hash output
+    }
+
+    [Test]
+    public void BlockUpdate_MultipleCalls_ShouldProcessCorrectly()
+    {
+        // Arrange
+        var input1 = new byte[] { 0x00, 0x11, 0x22 };
+        var input2 = new byte[] { 0x33, 0x44, 0x55, 0x66, 0x77 };
+
+        // Act
+        asconHash.BlockUpdate(input1, 0, input1.Length);
+        asconHash.BlockUpdate(input2, 0, input2.Length);
+
+        // Assert
+        var output = new byte[asconHash.GetDigestSize()];
+        asconHash.DoFinal(output, 0);
+        output.Should().HaveCount(32); // Ensure valid hash output
+    }
+
+    [Test]
+    public void AsconHash_WhenGetNameIsCalled_ReturnsCorrectValue()
+    {
+        asconHash.AlgorithmName.Should().Be("Ascon-Hash");
+        asconHashA.AlgorithmName.Should().Be("Ascon-HashA");
+    }
+
+    [Test]
+    public void AsconHash_WhenGetByteLengthIsCalled_ReturnsCorrectValue()
+    {
+        asconHash.GetByteLength().Should().Be(8);
+    }
+
+    [Test]
+    public void Update_ShouldProcessByte_WhenBufferIsFull()
+    {
+        // Arrange
+        byte[] inputBytes = { 0x00, 0x11, 0x22, 0x33, 0x44, 0x55, 0x66, 0x77 }; // 8 bytes to fill the buffer
+
+        // Act
+        foreach (var input in inputBytes)
+        {
+            asconHashA.Update(input);
+        }
+
+        // Assert
+        // Since the buffer is full after 8 updates, we expect the state to have been processed.
+        var output = new byte[asconHashA.GetDigestSize()];
+        asconHashA.DoFinal(output, 0);
+        output.Should().HaveCount(32); // Ascon hash size is 32 bytes
+    }
+
+    [Test]
+    public void Update_ShouldNotProcess_WhenBufferIsNotFull()
+    {
+        // Arrange
+        byte[] inputBytes = { 0x00, 0x11, 0x22, 0x33 }; // Only 4 bytes (buffer is not full)
+
+        // Act
+        foreach (var input in inputBytes)
+        {
+            asconHashA.Update(input);
+        }
+
+        // Assert
+        // Even though the buffer has received input, it should not process until it is full (8 bytes).
+        // We can check that DoFinal still completes, but the buffer has not been processed yet.
+        var output = new byte[asconHashA.GetDigestSize()];
+        asconHashA.DoFinal(output, 0);
+        output.Should().HaveCount(32); // Ensure valid hash output
+    }
+
+    [Test]
+    public void Update_ShouldProcessMultipleBlocks()
+    {
+        // Arrange
+        var inputBytes = new byte[16]; // Enough to fill two full blocks (16 bytes)
+
+        // Act
+        foreach (var input in inputBytes)
+        {
+            asconHashA.Update(input);
+        }
+
+        // Assert
+        // Ensure that the state is processed twice since 16 bytes were passed (2 blocks of 8 bytes).
+        var output = new byte[asconHashA.GetDigestSize()];
+        asconHashA.DoFinal(output, 0);
+        output.Should().HaveCount(32); // Ensure valid hash output
+    }
+
+    [Test]
+    public void Update_ShouldHandleSingleByteCorrectly()
+    {
+        // Arrange
+        byte input = 0xFF; // Single byte input
+
+        // Act
+        asconHashA.Update(input);
+
+        // Assert
+        // Even though one byte is provided, it should not process the state (waiting for 8 bytes).
+        var output = new byte[asconHashA.GetDigestSize()];
+        asconHashA.DoFinal(output, 0);
+        output.Should().HaveCount(32); // Ensure valid hash output
+    }
+
+    [Test]
+    public void Update_ShouldAccumulateStateWithMultipleUpdates()
+    {
+        // Arrange
+        byte[] inputBytes = { 0x00, 0x11, 0x22 }; // Partial input
+
+        // Act
+        foreach (var input in inputBytes)
+        {
+            asconHashA.Update(input);
+        }
+
+        // Add more data to fill the buffer.
+        byte[] additionalBytes = { 0x33, 0x44, 0x55, 0x66, 0x77 };
+        foreach (var input in additionalBytes)
+        {
+            asconHashA.Update(input);
+        }
+
+        // Assert
+        // Ensure that the state is correctly updated after multiple partial updates.
+        var output = new byte[asconHashA.GetDigestSize()];
+        asconHashA.DoFinal(output, 0);
+        output.Should().HaveCount(32); // Ensure valid hash output
+    }
+
+    private static string ToHexString(byte[] bytes)
+    {
+        return BitConverter.ToString(bytes).Replace("-", "").ToLowerInvariant();
+    }
+}

Algorithms.Tests/Crypto/Exceptions/CryptoExceptionTests.cs

@@ -0,0 +1,69 @@
+using Algorithms.Crypto.Exceptions;
+using NUnit.Framework;
+using FluentAssertions;
+using System;
+
+
+namespace Algorithms.Tests.Crypto.Exceptions
+{
+    [TestFixture]
+    public class CryptoExceptionTests
+    {
+        [Test]
+        public void CryptoException_ShouldBeCreatedWithoutMessageOrInnerException()
+        {
+            // Act
+            var exception = new CryptoException();
+
+            // Assert
+            exception.Should().BeOfType<CryptoException>()
+                .And.Subject.As<CryptoException>()
+                .Message.Should().NotBeNullOrEmpty();
+            exception.InnerException.Should().BeNull();
+        }
+
+        [Test]
+        public void CryptoException_ShouldSetMessage()
+        {
+            // Arrange
+            var expectedMessage = "This is a custom cryptographic error.";
+
+            // Act
+            var exception = new CryptoException(expectedMessage);
+
+            // Assert
+            exception.Should().BeOfType<CryptoException>()
+                .And.Subject.As<CryptoException>()
+                .Message.Should().Be(expectedMessage);
+            exception.InnerException.Should().BeNull();
+        }
+
+        [Test]
+        public void CryptoException_ShouldSetMessageAndInnerException()
+        {
+            // Arrange
+            var expectedMessage = "An error occurred during encryption.";
+            var innerException = new InvalidOperationException("Invalid operation");
+
+            // Act
+            var exception = new CryptoException(expectedMessage, innerException);
+
+            // Assert
+            exception.Should().BeOfType<CryptoException>()
+                .And.Subject.As<CryptoException>()
+                .Message.Should().Be(expectedMessage);
+            exception.InnerException.Should().Be(innerException);
+        }
+
+        [Test]
+        public void CryptoException_MessageShouldNotBeNullWhenUsingDefaultConstructor()
+        {
+            // Act
+            var exception = new CryptoException();
+
+            // Assert
+            exception.Message.Should().NotBeNullOrEmpty(); // Even the default Exception message is not null or empty.
+        }
+    }
+}
+