Merge pull request #130 from dorssel/net9

Use .NET 9 SDK
dorssel · Nov 17, 2024 · 3ad45c8 · 3ad45c8
2 parents 837bf73 + 6ca8bb8
commit 3ad45c8
Show file tree

Hide file tree

Showing 23 changed files with 104 additions and 108 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -90,6 +90,7 @@ end_of_line = crlf
 dotnet_style_prefer_simplified_boolean_expressions = true:suggestion
 dotnet_style_prefer_compound_assignment = true:suggestion
 dotnet_style_prefer_simplified_interpolation = true:suggestion
+dotnet_style_prefer_collection_expression = when_types_loosely_match:suggestion
 ###############################
 # C# Coding Conventions       #
 ###############################
@@ -151,11 +152,13 @@ csharp_preserve_single_line_statements = true
 csharp_preserve_single_line_blocks = true
 csharp_using_directive_placement = outside_namespace:silent
 csharp_prefer_simple_using_statement = true:suggestion
-csharp_style_namespace_declarations = block_scoped:silent
+csharp_style_namespace_declarations = file_scoped:silent
 csharp_style_expression_bodied_lambdas = true:silent
 csharp_style_expression_bodied_local_functions = false:silent
 csharp_style_prefer_method_group_conversion = true:silent
 csharp_style_prefer_top_level_statements = true:silent
+csharp_style_prefer_primary_constructors = true:suggestion
+csharp_prefer_system_threading_lock = true:suggestion
 ###############################
 # VB Coding Conventions       #
 ###############################

diff --git a/.mega-linter.yml b/.mega-linter.yml
@@ -13,9 +13,9 @@ DISABLE:
   - COPYPASTE # Comment to enable checks of excessive copy-pastes
   - SPELL # Comment to enable checks of spelling mistakes
 DISABLE_LINTERS:
-  - CSHARP_DOTNET_FORMAT # Not compatible with .NET 8 (yet)
-  - CSHARP_CSHARPIER # Not compatible with .NET 8 (yet)
-  - CSHARP_ROSLYNATOR # Not compatible with .NET 8 (yet)
+  - CSHARP_DOTNET_FORMAT # Not compatible with .NET 9 (yet)
+  - CSHARP_CSHARPIER # Not compatible with .NET 9 (yet)
+  - CSHARP_ROSLYNATOR # Not compatible with .NET 9 (yet)
   - REPOSITORY_TRIVY # Unstable, leading to a lot of build failures
 SHOW_ELAPSED_TIME: true
 FILEIO_REPORTER: false

diff --git a/AesExtra/AesCmac.cs b/AesExtra/AesCmac.cs
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: MIT
 
-using System;
 using System.Security.Cryptography;
 
 namespace Dorssel.Security.Cryptography;
@@ -17,16 +16,16 @@ public sealed class AesCmac
 
     /// <inheritdoc cref="KeyedHashAlgorithm.Create()" />
     /// <remarks>This static override defaults to <see cref="AesCmac" />.</remarks>
-    public static new KeyedHashAlgorithm Create() => new AesCmac();
+    public static new KeyedHashAlgorithm Create()
+    {
+        return new AesCmac();
+    }
 
     /// <inheritdoc cref="KeyedHashAlgorithm.Create(string)" />
     public static new KeyedHashAlgorithm? Create(string algorithmName)
     {
-        if (algorithmName == null)
-        {
-            throw new ArgumentNullException(nameof(algorithmName));
-        }
-        return algorithmName == nameof(AesCmac) ? Create() : null;
+        return algorithmName != null ? algorithmName == nameof(AesCmac) ? Create() : null
+            : throw new ArgumentNullException(nameof(algorithmName));
     }
 
     /// <summary>
@@ -100,7 +99,7 @@ public override byte[] Key
     // In-place: X = CIPH_K(X)
     void CIPH_K_InPlace(byte[] X_Base, int X_Offset = 0)
     {
-        CryptoTransform.TransformBlock(X_Base, X_Offset, BLOCKSIZE, X_Base, X_Offset);
+        _ = CryptoTransform.TransformBlock(X_Base, X_Offset, BLOCKSIZE, X_Base, X_Offset);
     }
 
     // See: NIST SP 800-38B, Section 6.1
@@ -152,7 +151,7 @@ protected override void HashCore(byte[] array, int ibStart, int cbSize)
         }
 
         // If we have a non-empty && non-full Partial block already -> append to that first.
-        if ((0 < PartialLength) && (PartialLength < BLOCKSIZE))
+        if (PartialLength is > 0 and < BLOCKSIZE)
         {
             var count = Math.Min(cbSize, BLOCKSIZE - PartialLength);
             Array.Copy(array, ibStart, Partial, PartialLength, count);

diff --git a/AesExtra/AesCtr.cs b/AesExtra/AesCtr.cs
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: MIT
 
-using System;
 using System.Security.Cryptography;
 
 namespace Dorssel.Security.Cryptography;
@@ -19,16 +18,16 @@ public sealed class AesCtr
     const int FixedFeedbackSize = FixedBlockSize * 8; // bits
 
     /// <inheritdoc cref="Aes.Create()" />
-    public static new Aes Create() => new AesCtr();
+    public static new Aes Create()
+    {
+        return new AesCtr();
+    }
 
     /// <inheritdoc cref="Aes.Create(string)" />
     public static new Aes? Create(string algorithmName)
     {
-        if (algorithmName == null)
-        {
-            throw new ArgumentNullException(nameof(algorithmName));
-        }
-        return algorithmName == nameof(AesCtr) ? Create() : null;
+        return algorithmName != null ? algorithmName == nameof(AesCtr) ? Create() : null
+            : throw new ArgumentNullException(nameof(algorithmName));
     }
 
     AesCtr()
@@ -134,10 +133,16 @@ AesCtrTransform CreateTransform(byte[] rgbKey, byte[]? rgbIV)
     }
 
     /// <inheritdoc cref="AesManaged.CreateDecryptor(byte[], byte[])" />
-    public override ICryptoTransform CreateDecryptor(byte[] rgbKey, byte[]? rgbIV) => CreateTransform(rgbKey, rgbIV);
+    public override ICryptoTransform CreateDecryptor(byte[] rgbKey, byte[]? rgbIV)
+    {
+        return CreateTransform(rgbKey, rgbIV);
+    }
 
     /// <inheritdoc cref="AesManaged.CreateEncryptor(byte[], byte[])" />
-    public override ICryptoTransform CreateEncryptor(byte[] rgbKey, byte[]? rgbIV) => CreateTransform(rgbKey, rgbIV);
+    public override ICryptoTransform CreateEncryptor(byte[] rgbKey, byte[]? rgbIV)
+    {
+        return CreateTransform(rgbKey, rgbIV);
+    }
 
     /// <inheritdoc cref="AesManaged.GenerateIV" />
     public override void GenerateIV()

diff --git a/AesExtra/AesCtrTransform.cs b/AesExtra/AesCtrTransform.cs
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: MIT
 
-using System;
 using System.Security.Cryptography;
 
 namespace Dorssel.Security.Cryptography;
@@ -128,7 +127,7 @@ int ICryptoTransform.TransformBlock(byte[] inputBuffer, int inputOffset, int inp
 
         for (var i = 0; i < inputCount / BLOCKSIZE; ++i)
         {
-            TransformBlock(inputBuffer, inputOffset + i * BLOCKSIZE, outputBuffer, outputOffset + i * BLOCKSIZE);
+            TransformBlock(inputBuffer, inputOffset + (i * BLOCKSIZE), outputBuffer, outputOffset + (i * BLOCKSIZE));
         }
         return inputCount;
     }

diff --git a/AesExtra/AesExtra.csproj b/AesExtra/AesExtra.csproj
@@ -30,8 +30,4 @@ SPDX-License-Identifier: MIT
     <None Include="..\README.md" Pack="true" PackagePath="" Visible="false" />
   </ItemGroup>
 
-  <ItemGroup>
-    <PackageReference Include="Microsoft.SourceLink.GitHub" PrivateAssets="All" />
-  </ItemGroup>
-
 </Project>
diff --git a/AesExtra/AesSiv.cs b/AesExtra/AesSiv.cs
@@ -2,8 +2,6 @@
 //
 // SPDX-License-Identifier: MIT
 
-using System;
-using System.Linq;
 using System.Security.Cryptography;
 
 namespace Dorssel.Security.Cryptography;
@@ -64,9 +62,9 @@ byte[] S2V(byte[][] associatedData, byte[] plaintext)
             // D takes the role of the "end" in "xorend"
             D.xor_InPlace(0, plaintext, plaintext.Length - BLOCKSIZE, BLOCKSIZE);
             // Using Transform instead of Compute prevents cloning plaintext.
-            Cmac.TransformBlock(plaintext, 0, plaintext.Length - BLOCKSIZE, null, 0);
-            Cmac.TransformBlock(D, 0, BLOCKSIZE, null, 0);
-            Cmac.TransformFinalBlock([], 0, 0);
+            _ = Cmac.TransformBlock(plaintext, 0, plaintext.Length - BLOCKSIZE, null, 0);
+            _ = Cmac.TransformBlock(D, 0, BLOCKSIZE, null, 0);
+            _ = Cmac.TransformFinalBlock([], 0, 0);
             return Cmac.Hash;
         }
         else

diff --git a/AesExtra/AssemblySettings.cs b/AesExtra/AssemblySettings.cs
@@ -2,7 +2,6 @@
 //
 // SPDX-License-Identifier: MIT
 
-using System;
 using System.Runtime.CompilerServices;
 
 [assembly: CLSCompliant(true)]

diff --git a/AesExtra/CryptographicOperations.cs b/AesExtra/CryptographicOperations.cs
@@ -8,7 +8,7 @@
 namespace Dorssel.Security.Cryptography;
 
 /// <summary>
-/// This is a backport of .NET 6.0. Since this library is for .NET Standard 2.0 it uses <see cref="byte"/>[] instead of Span.
+/// This is a backport of .NET 9. Since this library is for .NET Standard 2.0 it uses <see cref="byte"/>[] instead of Span.
 /// <para/>
 /// See:
 /// <see href="https://github.com/dotnet/runtime/blob/main/src/libraries/System.Security.Cryptography/src/System/Security/Cryptography/CryptographicOperations.cs"/>

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -12,10 +12,11 @@ SPDX-License-Identifier: MIT
     <Platforms>AnyCPU</Platforms>
 
     <!-- Use the latest .NET SDK -->
-    <TargetFrameworks>net8.0</TargetFrameworks>
+    <TargetFrameworks>net9.0</TargetFrameworks>
 
     <!-- Use the latest C# language standard -->
-    <LangVersion>12.0</LangVersion>
+    <LangVersion>13.0</LangVersion>
+    <ImplicitUsings>enable</ImplicitUsings>
 
     <!-- Be very strict -->
     <WarningLevel>9999</WarningLevel>
@@ -31,6 +32,10 @@ SPDX-License-Identifier: MIT
     <IsPackable>false</IsPackable>
     <IsPublishable>false</IsPublishable>
     <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)\strongname.snk</AssemblyOriginatorKeyFile>
+    <!--
+    See https://github.com/dotnet/roslyn/issues/41640
+    -->
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
 
     <!-- Assembly metadata -->
     <Product>dotnet-aes-extra</Product>
@@ -40,15 +45,11 @@ SPDX-License-Identifier: MIT
     <!-- NuGet metadata -->
     <Title>$(Product)</Title>
     <Authors>$(Company)</Authors>
-    <Description>.NET Standard 2.0 implementation of AES-CTR, AES-CMAC, and AES-SIV.</Description>
+    <Description>.NET Standard 2.0 implementation of AES-CTR, AES-CMAC, and SIV-AES.</Description>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <PackageProjectUrl>https://github.com/dorssel/dotnet-aes-extra</PackageProjectUrl>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <UseFullSemVerForNuGet>false</UseFullSemVerForNuGet>
-
-    <!-- SourceLink -->
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
-    <EmbedUntrackedSources>true</EmbedUntrackedSources>
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>
@@ -60,6 +61,7 @@ SPDX-License-Identifier: MIT
   <Target Name="SetPackageVersion" AfterTargets="GetVersion">
     <PropertyGroup>
       <PackageVersion>$(GitVersion_MajorMinorPatch)</PackageVersion>
+      <PackageVersion Condition=" '$(GitVersion_MajorMinorPatch)' == '' ">0.9.99</PackageVersion>
     </PropertyGroup>
   </Target>
 

diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -7,15 +7,12 @@ SPDX-License-Identifier: MIT
 <Project>
   <ItemGroup>
     <!-- all -->
-    <PackageVersion Include="GitVersion.MsBuild" Version="6.0.4" />
-    <!-- AesExtra -->
-    <PackageVersion Include="Microsoft.SourceLink.GitHub" Version="8.0.0" />
+    <PackageVersion Include="GitVersion.MsBuild" Version="6.0.5" />
     <!-- UnitTests -->
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
     <PackageVersion Include="Moq" Version="4.20.72" />
     <PackageVersion Include="MSTest.TestAdapter" Version="3.6.3" />
     <PackageVersion Include="MSTest.TestFramework" Version="3.6.3" />
-    <PackageVersion Include="System.IO.Pipelines" Version="8.0.0" />
     <PackageVersion Include="coverlet.collector" Version="6.0.2" />
   </ItemGroup>
 </Project>
diff --git a/UnitTests/AesCmac_Tests.cs b/UnitTests/AesCmac_Tests.cs
@@ -24,7 +24,7 @@ public void Create_Name()
     [TestMethod]
     public void Create_NullNameFails()
     {
-        Assert.ThrowsException<ArgumentNullException>(() =>
+        _ = Assert.ThrowsException<ArgumentNullException>(() =>
         {
             using var keyedHashAlgorithm = AesCmac.Create(null!);
         });
@@ -55,7 +55,7 @@ public void Constructor_WithKey(int keySize)
     [TestMethod]
     public void Constructor_WithInvalidKeySize()
     {
-        Assert.ThrowsException<CryptographicException>(() =>
+        _ = Assert.ThrowsException<CryptographicException>(() =>
         {
             using var aesCmac = new AesCmac(new byte[42]);
         });
@@ -64,7 +64,7 @@ public void Constructor_WithInvalidKeySize()
     [TestMethod]
     public void Constructor_WithNullKey()
     {
-        Assert.ThrowsException<ArgumentNullException>(() =>
+        _ = Assert.ThrowsException<ArgumentNullException>(() =>
         {
             using var aesCmac = new AesCmac(null!);
         });
@@ -110,7 +110,7 @@ public void ComputeHash_Segmented()
         var pos = 0;
         void Transfer(int count)
         {
-            aesCmac.TransformBlock(testVector.PT.ToArray(), pos, count, null, 0);
+            _ = aesCmac.TransformBlock(testVector.PT.ToArray(), pos, count, null, 0);
             pos += count;
         }
 
@@ -121,13 +121,13 @@ void Transfer(int count)
         // complete the partial block precisely
         Transfer(1);
         // more than 1 block, but not an exact multiple
-        Transfer(2 * 16 - 3);
+        Transfer((2 * 16) - 3);
         // topping off the partial block + again less than 1 block
         Transfer(16);
         // remainder
         Transfer(testVector.PT.Length - pos);
 
-        aesCmac.TransformFinalBlock([], 0, 0);
+        _ = aesCmac.TransformFinalBlock([], 0, 0);
 
         CollectionAssert.AreEqual(testVector.Tag.ToArray(), aesCmac.Hash);
     }