Remove support weak digest hash algos

Also refactor file digest options to use enum for hash algorithms and update related tests

Author: ATimmeh33

src/SignhostAPIClient.Tests/SignhostApiClientTests.cs

@@ -429,7 +429,7 @@ await signhostApiClient.AddOrReplaceFileToTransactionAsync(
 					new FileUploadOptions{
 					DigestOptions = new FileDigestOptions
 					{
-						DigestHashAlgorithm = "SHA-512"
+						DigestHashAlgorithm = DigestHashAlgorithm.SHA512,
 					}
 				});
 			}
@@ -443,7 +443,7 @@ public async Task when_AddOrReplaceFileToTransaction_with_digest_value_is_used_a
 			var mockHttp = new MockHttpMessageHandler();
 			mockHttp
 				.Expect(HttpMethod.Put, "http://localhost/api/transaction/transaction Id/file/file Id")
-				.WithHeaders("Digest", "SHA-1=AAEC")
+				.WithHeaders("Digest", "SHA-256=AAEC")
 				.Respond(HttpStatusCode.OK);
 
 			using (var httpClient = mockHttp.ToHttpClient()) {
@@ -457,7 +457,7 @@ await signhostApiClient.AddOrReplaceFileToTransactionAsync(
 					{
 						DigestOptions = new FileDigestOptions
 						{
-							DigestHashAlgorithm = "SHA-1",
+							DigestHashAlgorithm = DigestHashAlgorithm.SHA256,
 							DigestHashValue = new byte[] { 0x00, 0x01, 0x02 }
 						}
 					});

src/SignhostAPIClient/Rest/DigestHashAlgorithmNames.cs

@@ -0,0 +1,30 @@
+namespace Signhost.APIClient.Rest;
+
+/// <summary>
+/// Provides constants for hash algorithm names used in HTTP Digest headers,
+/// following the naming conventions specified in RFC 3230 (Instance Digests in HTTP)
+/// and RFC 5843 (Additional Hash Algorithms for HTTP Instance Digests).
+///
+/// These names are in accordance with the Digest header in HTTP requests,
+/// where the header specifies the algorithm used to create the digest of the resource.
+///
+/// For more information:
+/// https://evidos.github.io/endpoints/##/paths//api/transaction/%7BtransactionId%7D/file/%7BfileId%7D/put
+/// </summary>
+public enum DigestHashAlgorithm
+{
+	/// <summary>
+	/// Use no digest.
+	/// </summary>
+	None = 0,
+
+	/// <summary>
+	/// SHA-256 hash algorithm, as specified in RFC 5843.
+	/// </summary>
+	SHA256,
+
+	/// <summary>
+	/// SHA-512 hash algorithm, as specified in RFC 5843.
+	/// </summary>
+	SHA512,
+}

src/SignhostAPIClient/Rest/FileDigestOptions.cs

@@ -20,7 +20,7 @@ public class FileDigestOptions
 		/// the hash value or the digest algorithm that is used
 		/// to set the <see cref="DigestHashValue"/>.
 		/// </summary>
-		public string DigestHashAlgorithm { get; set; } = "SHA-256";
+		public DigestHashAlgorithm DigestHashAlgorithm { get; set; } = DigestHashAlgorithm.SHA256;
 
 		/// <summary>
 		/// Gets or sets the hash digest value, you can set this yourself

src/SignhostAPIClient/Rest/StreamContentDigestOptionsExtensions.cs

@@ -23,19 +23,33 @@ public static StreamContent WithDigest(
 			Stream fileStream,
 			FileDigestOptions options)
 		{
-			if (!options.UseFileDigesting || options.DigestHashAlgorithm == null) {
+			if (
+				!options.UseFileDigesting ||
+				options.DigestHashAlgorithm == DigestHashAlgorithm.None
+			) {
 				return content;
 			}
 
 			SetHashValue(fileStream, options);
 
 			string base64Digest = Convert.ToBase64String(options.DigestHashValue);
 
-			content.Headers.Add("Digest", $"{options.DigestHashAlgorithm}={base64Digest}");
+			content.Headers.Add("Digest", $"{GetDigestHashAlgorithmName(options)}={base64Digest}");
 
 			return content;
 		}
 
+		private static string GetDigestHashAlgorithmName(FileDigestOptions options)
+		{
+			return options.DigestHashAlgorithm switch {
+				DigestHashAlgorithm.SHA256 => "SHA-256",
+				DigestHashAlgorithm.SHA512 => "SHA-512",
+
+				_ => throw new InvalidOperationException(
+					$"No hash algorithm name for '{options.DigestHashAlgorithm}'"),
+			};
+		}
+
 		private static void SetHashValue(
 			Stream fileStream,
 			FileDigestOptions options)
@@ -60,48 +74,17 @@ private static void SetHashValue(
 		private static HashAlgorithm HashAlgorithmCreate(
 			FileDigestOptions options)
 		{
-			string algorithmName = options.DigestHashAlgorithm;
-			HashAlgorithm algorithm = null;
-
+			return options.DigestHashAlgorithm switch {
 #if NETSTANDARD2_0 || NET8_0
-			switch (algorithmName) {
-				case "SHA1":
-				case "SHA-1":
-					algorithm = SHA1.Create();
-					break;
-				case "SHA256":
-				case "SHA-256":
-					algorithm = SHA256.Create();
-					break;
-				case "SHA384":
-				case "SHA-384":
-					algorithm = SHA384.Create();
-					break;
-				case "SHA512":
-				case "SHA-512":
-					algorithm = SHA512.Create();
-					break;
-			}
+				DigestHashAlgorithm.SHA256 => SHA256.Create(),
+				DigestHashAlgorithm.SHA512 => SHA512.Create(),
 #else
-			algorithm = HashAlgorithm.Create(algorithmName);
+				DigestHashAlgorithm.SHA256 => HashAlgorithm.Create("SHA256"),
+				DigestHashAlgorithm.SHA512 => HashAlgorithm.Create("SHA512"),
 #endif
-			if (algorithm == null && options.DigestHashValue == null) {
-				algorithm = DefaultHashAlgorithm();
-				options.DigestHashAlgorithm = algorithm.GetType().Name;
-			}
-
-			if (algorithm == null) {
-				throw new InvalidOperationException($"No hash algorithm for '{algorithmName}'");
-			}
-
-			return algorithm;
+				_ => throw new InvalidOperationException(
+					$"No hash algorithm for '{options.DigestHashAlgorithm}'"),
+			};
 		}
-
-		private static HashAlgorithm DefaultHashAlgorithm() =>
-#if NETSTANDARD2_0 || NET8_0
-			SHA256.Create();
-#else
-			HashAlgorithm.Create();
-#endif
 	}
 }

src/SignhostAPIClient/SignhostAPIClient.csproj

@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 	<PropertyGroup Label="Build">
 		<TargetFrameworks>netstandard2.0;net8.0;net462</TargetFrameworks>
+		<LangVersion>10.0</LangVersion>
 		<CodeAnalysisRuleSet>../signhost.ruleset</CodeAnalysisRuleSet>
 		<DefineConstants Condition="'$(TargetFramework)' == 'net462'">SERIALIZABLE</DefineConstants>
 		<DefineConstants Condition="'$(TargetFramework)' == 'netstandard2.0'">TYPEINFO</DefineConstants>

src/signhost.ruleset

@@ -6,6 +6,7 @@
  <Rules AnalyzerId="RefactoringEssentials" RuleNamespace="RefactoringEssentials">  
  </Rules>
  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
+   <Rule Id="SA1009" Action="None" /><!-- Closing parenthesis must not be preceded by a space -->
    <Rule Id="SA1027" Action="None" /><!-- Tabs must not be used -->
    <Rule Id="SA1633" Action="None" /><!-- FileMustHaveHeader -->
    <Rule Id="SA1652" Action="None" /><!-- Enable XML documentation output -->