SHA3 NIST test vectors (#185)

Author: WingZer0o

.gitignore

@@ -82,6 +82,7 @@ StyleCopReport.xml
 *.pgc
 *.pgd
 *.rsp
+!cas-dotnet-sdk-tests/**/**/*.rsp
 *.sbr
 *.tlb
 *.tli

cas-dotnet-sdk-tests/SHA/Data/SHA3_256LongMsg.rsp

@@ -0,0 +1,129 @@
+using CasDotnetSdk.Hashers;
+using System.Globalization;
+using Xunit;
+
+namespace CasDotnetSdkTests.Tests
+{
+    public class SHAWrapperTests
+    {
+        private readonly SHAWrapper _wrapper;
+        private const string DataDirectory = "SHA/Data";
+        private const string ProjectDataDirectory = "cas-dotnet-sdk-tests/SHA/Data";
+
+        public SHAWrapperTests()
+        {
+            this._wrapper = new SHAWrapper();
+        }
+
+        [Theory]
+        [MemberData(nameof(SHA256NistVectors))]
+        public void SHA256MatchesNistVectors(byte[] message, byte[] expectedDigest)
+        {
+            byte[] hashed = this._wrapper.Hash256(message);
+            Assert.Equal(expectedDigest, hashed);
+            Assert.True(this._wrapper.Verify256(message, expectedDigest));
+        }
+
+        [Theory]
+        [MemberData(nameof(SHA512NistVectors))]
+        public void SHA512MatchesNistVectors(byte[] message, byte[] expectedDigest)
+        {
+            byte[] hashed = this._wrapper.Hash512(message);
+            Assert.Equal(expectedDigest, hashed);
+            Assert.True(this._wrapper.Verify512(message, expectedDigest));
+        }
+
+        public static IEnumerable<object[]> SHA256NistVectors()
+        {
+            return LoadRspVectors("SHA3_256ShortMsg.rsp")
+                .Concat(LoadRspVectors("SHA3_256LongMsg.rsp"));
+        }
+
+        public static IEnumerable<object[]> SHA512NistVectors()
+        {
+            return LoadRspVectors("SHA3_512ShortMsg.rsp")
+                .Concat(LoadRspVectors("SHA3_512LongMsg.rsp"));
+        }
+
+        private static IEnumerable<object[]> LoadRspVectors(string fileName)
+        {
+            string path = ResolveVectorPath(fileName);
+
+            string? msgHex = null;
+            int? bitLength = null;
+
+            foreach (string rawLine in File.ReadLines(path))
+            {
+                string line = rawLine.Trim();
+                if (string.IsNullOrWhiteSpace(line) || line.StartsWith("#", StringComparison.Ordinal))
+                {
+                    continue;
+                }
+
+                if (line.StartsWith("Len =", StringComparison.Ordinal))
+                {
+                    bitLength = int.Parse(line["Len =".Length..].Trim(), CultureInfo.InvariantCulture);
+                    continue;
+                }
+
+                if (line.StartsWith("Msg =", StringComparison.Ordinal))
+                {
+                    msgHex = line["Msg =".Length..].Trim();
+                    continue;
+                }
+
+                if (!line.StartsWith("MD =", StringComparison.Ordinal) || bitLength is null || msgHex is null)
+                {
+                    continue;
+                }
+
+                string digestHex = line["MD =".Length..].Trim();
+                yield return new object[]
+                {
+                    GetMessageBytes(msgHex, bitLength.Value),
+                    Convert.FromHexString(digestHex)
+                };
+
+                msgHex = null;
+                bitLength = null;
+            }
+        }
+
+        private static byte[] GetMessageBytes(string msgHex, int bitLength)
+        {
+            if (bitLength == 0)
+            {
+                return Array.Empty<byte>();
+            }
+
+            if (bitLength % 8 != 0)
+            {
+                throw new InvalidOperationException($"Only byte-aligned NIST test vectors are supported. Found Len = {bitLength}.");
+            }
+
+            byte[] fullMessage = Convert.FromHexString(msgHex);
+            return fullMessage.Take(bitLength / 8).ToArray();
+        }
+
+        private static string ResolveVectorPath(string fileName)
+        {
+            string[] candidatePaths =
+            {
+                Path.Combine(AppContext.BaseDirectory, DataDirectory, fileName),
+                Path.GetFullPath(Path.Combine(AppContext.BaseDirectory, "..", "..", "..", "..", ProjectDataDirectory, fileName)),
+                Path.GetFullPath(Path.Combine(AppContext.BaseDirectory, "..", "..", "..", "..", "..", ProjectDataDirectory, fileName))
+            };
+
+            foreach (string candidatePath in candidatePaths)
+            {
+                if (File.Exists(candidatePath))
+                {
+                    return candidatePath;
+                }
+            }
+
+            throw new FileNotFoundException(
+                $"Missing NIST SHA vector file: {fileName}. Checked: {string.Join(", ", candidatePaths)}");
+        }
+    }
+}

cas-dotnet-sdk-tests/SHA/Data/SHA3_256ShortMsg.rsp

@@ -26,4 +26,15 @@
   <ItemGroup>
     <ProjectReference Include="..\cas-dotnet-sdk\cas-dotnet-sdk.csproj" />
   </ItemGroup>
+
+  <ItemGroup>
+    <Content Include="SHA\Data\*.rsp">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <TargetPath>SHA\Data\%(Filename)%(Extension)</TargetPath>
+    </Content>
+  </ItemGroup>
+
+  <ItemGroup>
+    <Folder Include="SHA\Data\" />
+  </ItemGroup>
 </Project>

cas-dotnet-sdk-tests/SHA/Data/SHA3_512LongMsg.rsp

@@ -28,15 +28,6 @@ public SHAWrapper()
 
         public byte[] Hash512(byte[] dataToHash)
         {
-            if (dataToHash == null)
-            {
-                throw new Exception("You must provide a byte array of data to hash");
-            }
-            if (dataToHash.Length == 0)
-            {
-                throw new Exception("You must provide a byte array with allocated data to hash");
-            }
-
             SHAHashByteResult hashedPtr = (this._platform == OSPlatform.Linux) ?
                 SHALinuxWrapper.sha512_bytes(dataToHash, dataToHash.Length) :
                 SHAWindowsWrapper.sha512_bytes(dataToHash, dataToHash.Length);
@@ -58,23 +49,12 @@ public byte[] Hash512(byte[] dataToHash)
 
         public byte[] Hash256(byte[] dataToHash)
         {
-            if (dataToHash == null)
-            {
-                throw new Exception("You must provide a byte array of data to hash");
-            }
-            if (dataToHash.Length == 0)
-            {
-                throw new Exception("You must provide a byte array with allocated data to hash");
-            }
-
             SHAHashByteResult hashedPtr = (this._platform == OSPlatform.Linux) ?
                 SHALinuxWrapper.sha256_bytes(dataToHash, dataToHash.Length) :
                 SHAWindowsWrapper.sha256_bytes(dataToHash, dataToHash.Length);
             byte[] result = new byte[hashedPtr.length];
             Marshal.Copy(hashedPtr.result_bytes_ptr, result, 0, hashedPtr.length);
             FreeMemoryHelper.FreeBytesMemory(hashedPtr.result_bytes_ptr);
-
-
             return result;
         }
 
@@ -89,20 +69,9 @@ public byte[] Hash256(byte[] dataToHash)
 
         public bool Verify512(byte[] dataToVerify, byte[] hashedData)
         {
-            if (dataToVerify == null || dataToVerify.Length == 0)
-            {
-                throw new Exception("You must provide a byte array with allocated data to verify");
-            }
-            if (hashedData == null || hashedData.Length == 0)
-            {
-                throw new Exception("You must provide a byte array with allocated data to verify");
-            }
-
             bool result = (this._platform == OSPlatform.Linux) ?
                 SHALinuxWrapper.sha512_bytes_verify(dataToVerify, dataToVerify.Length, hashedData, hashedData.Length) :
                 SHAWindowsWrapper.sha512_bytes_verify(dataToVerify, dataToVerify.Length, hashedData, hashedData.Length);
-
-
             return result;
         }
 
@@ -117,15 +86,6 @@ public bool Verify512(byte[] dataToVerify, byte[] hashedData)
 
         public bool Verify256(byte[] dataToVerify, byte[] hashedData)
         {
-            if (dataToVerify == null || dataToVerify.Length == 0)
-            {
-                throw new Exception("You must provide a byte array with allocated data to verify");
-            }
-            if (hashedData == null || hashedData.Length == 0)
-            {
-                throw new Exception("You must provide a byte array with allocated data to verify");
-            }
-
             bool result = (this._platform == OSPlatform.Linux) ?
                 SHALinuxWrapper.sha256_bytes_verify(dataToVerify, dataToVerify.Length, hashedData, hashedData.Length) :
                 SHAWindowsWrapper.sha256_bytes_verify(dataToVerify, dataToVerify.Length, hashedData, hashedData.Length);

cas-dotnet-sdk-tests/SHA/Data/SHA3_512ShortMsg.rsp

@@ -7,7 +7,7 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>  
     <Title>cas-dotnet-sdk</Title>
     <PackageIcon>icon.jpeg</PackageIcon>
-    <Version>1.9.4</Version>
+    <Version>1.9.5</Version>
     <Authors>Mike Mulchrone</Authors>
     <Description>A Nuget package that provides a implementation of the RustCrypto suite of cryptographic algorithms.</Description>
     <RepositoryUrl>https://github.com/Cryptographic-API-Services/cas-dotnet-sdk</RepositoryUrl>