Merge pull request #148 from vcsjones/net6

Update to .NET 6.

Author: vcsjones

.github/workflows/pr.yml

@@ -11,5 +11,5 @@ jobs:
       name: Checkout
     - uses: actions/setup-dotnet@v1
       with:
-        dotnet-version: '3.1.412'
+        dotnet-version: '6.0'
     - run: dotnet test

src/AzureSign.Core/AuthenticodeKeyVaultSigner.cs

@@ -36,18 +36,20 @@ public class AuthenticodeKeyVaultSigner : IDisposable
         /// <param name="additionalCertificates">Any additional certificates to assist in building a certificate chain.</param>
         public AuthenticodeKeyVaultSigner(AsymmetricAlgorithm signingAlgorithm, X509Certificate2 signingCertificate,
             HashAlgorithmName fileDigestAlgorithm, TimeStampConfiguration timeStampConfiguration,
-            X509Certificate2Collection additionalCertificates = null)
+            X509Certificate2Collection? additionalCertificates = null)
         {
             _fileDigestAlgorithm = fileDigestAlgorithm;
             _signingCertificate = signingCertificate ?? throw new ArgumentNullException(nameof(signingCertificate));
             _timeStampConfiguration = timeStampConfiguration ?? throw new ArgumentNullException(nameof(timeStampConfiguration));
             _signingAlgorithm = signingAlgorithm ?? throw new ArgumentNullException(nameof(signingAlgorithm));
             _certificateStore = MemoryCertificateStore.Create();
             _chain = new X509Chain();
-            if (additionalCertificates != null)
+
+            if (additionalCertificates is not null)
             {
                 _chain.ChainPolicy.ExtraStore.AddRange(additionalCertificates);
             }
+
             //We don't care about the trustworthiness of the cert. We just want a chain to sign with.
             _chain.ChainPolicy.VerificationFlags = X509VerificationFlags.AllFlags;
 
@@ -73,15 +75,18 @@ public AuthenticodeKeyVaultSigner(AsymmetricAlgorithm signingAlgorithm, X509Cert
         /// <param name="logger">An optional logger to capture signing operations.</param>
         /// <returns>A HRESULT indicating the result of the signing operation. S_OK, or zero, is returned if the signing
         /// operation completed successfully.</returns>
-        public unsafe int SignFile(ReadOnlySpan<char> path, ReadOnlySpan<char> description, ReadOnlySpan<char> descriptionUrl, bool? pageHashing, ILogger logger = null)
+        public unsafe int SignFile(ReadOnlySpan<char> path, ReadOnlySpan<char> description, ReadOnlySpan<char> descriptionUrl, bool? pageHashing, ILogger? logger = null)
         {
-            static void CopyAndNullTerminate(ReadOnlySpan<char> str, Span<char> destination)
+            static char[] NullTerminate(ReadOnlySpan<char> str)
             {
-                str.CopyTo(destination);
-                destination[destination.Length - 1] = '\0';
+                char[] result = new char[str.Length + 1];
+                str.CopyTo(result);
+                result[result.Length - 1] = '\0';
+                return result;
             }
 
-            var flags = SignerSignEx3Flags.SIGN_CALLBACK_UNDOCUMENTED;
+            SignerSignEx3Flags flags = SignerSignEx3Flags.SIGN_CALLBACK_UNDOCUMENTED;
+
             if (pageHashing == true)
             {
                 flags |= SignerSignEx3Flags.SPC_INC_PE_PAGE_HASHES_FLAG;
@@ -93,7 +98,8 @@ static void CopyAndNullTerminate(ReadOnlySpan<char> str, Span<char> destination)
 
             SignerSignTimeStampFlags timeStampFlags;
             ReadOnlySpan<byte> timestampAlgorithmOid;
-            string timestampUrl;
+            string? timestampUrl;
+
             switch (_timeStampConfiguration.Type)
             {
                 case TimeStampType.Authenticode:
@@ -107,32 +113,17 @@ static void CopyAndNullTerminate(ReadOnlySpan<char> str, Span<char> destination)
                     timestampUrl = _timeStampConfiguration.Url;
                     break;
                 default:
-                    timeStampFlags = 0;
+                    timeStampFlags = default;
                     timestampAlgorithmOid = default;
                     timestampUrl = null;
                     break;
             }
 
-            Span<char> pathWithNull = path.Length > 0x100 ? new char[path.Length + 1] : stackalloc char[path.Length + 1];
-            Span<char> descriptionBuffer = description.Length > 0x100 ? new char[description.Length + 1] : stackalloc char[description.Length + 1];
-            Span<char> descriptionUrlBuffer = descriptionUrl.Length > 0x100 ? new char[descriptionUrl.Length + 1] : stackalloc char[descriptionUrl.Length + 1];
-            Span<char> timestampUrlBuffer = timestampUrl == null ?
-                default : timestampUrl.Length > 0x100 ?
-                new char[timestampUrl.Length + 1] : stackalloc char[timestampUrl.Length + 1];
-
-            CopyAndNullTerminate(path, pathWithNull);
-            CopyAndNullTerminate(description, descriptionBuffer);
-            CopyAndNullTerminate(descriptionUrl, descriptionUrlBuffer);
-            if (timestampUrl != null)
-            {
-                CopyAndNullTerminate(timestampUrl.AsSpan(), timestampUrlBuffer);
-            }
-
             fixed (byte* pTimestampAlgorithm = timestampAlgorithmOid)
-            fixed (char* pTimestampUrl = timestampUrlBuffer)
-            fixed (char* pPath = pathWithNull)
-            fixed (char* pDescription = descriptionBuffer)
-            fixed (char* pDescriptionUrl = descriptionUrlBuffer)
+            fixed (char* pTimestampUrl = timestampUrl)
+            fixed (char* pPath = NullTerminate(path))
+            fixed (char* pDescription = NullTerminate(description))
+            fixed (char* pDescriptionUrl = NullTerminate(descriptionUrl))
             {
                 var fileInfo = new SIGNER_FILE_INFO(pPath, default);
                 var subjectIndex = 0u;

src/AzureSign.Core/AzureSign.Core.csproj

@@ -7,6 +7,7 @@
     <RuntimeIdentifiers>win10-x64;win10-x86</RuntimeIdentifiers>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <MinVerTagPrefix>v</MinVerTagPrefix>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>

src/AzureSign.Core/MemoryCertificateStore.cs

@@ -8,7 +8,7 @@ namespace AzureSign.Core
     internal sealed class MemoryCertificateStore : IDisposable
     {
         private IntPtr _handle;
-        private X509Store _store;
+        private readonly X509Store _store;
 
         private MemoryCertificateStore(IntPtr handle)
         {
@@ -50,10 +50,12 @@ public static MemoryCertificateStore Create()
         private void Dispose(bool disposing)
         {
             GC.SuppressFinalize(this);
+
             if (disposing)
             {
                 _store.Dispose();
             }
+
             FreeHandle();
         }
 

src/AzureSign.Core/TimeStampConfiguration.cs

@@ -10,7 +10,7 @@ public class TimeStampConfiguration
         /// <summary>
         /// The URL to the timestamp authority.
         /// </summary>
-        public string Url { get; }
+        public string? Url { get; }
 
         /// <summary>
         /// The digest algorithm the timestamp service authority should use on timestamp signatures.

src/AzureSignTool/AzureSignTool.csproj

@@ -2,27 +2,27 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
     <PackAsTool>true</PackAsTool>
     <ToolCommandName>azuresigntool</ToolCommandName>
-    <Description>Azure Sign Tool is similar to signtool in the Windows SDK, with the major difference being that it uses Azure Key Vault for performing the signing process. The usage is like signtool, except with a limited set of options for signing and options for authenticating to Azure Key Vault.</Description>    
-    <RuntimeIdentifiers>win10-x64;win10-x86</RuntimeIdentifiers>
+    <Description>Azure Sign Tool is similar to signtool in the Windows SDK, with the major difference being that it uses Azure Key Vault for performing the signing process. The usage is like signtool, except with a limited set of options for signing and options for authenticating to Azure Key Vault.</Description>
+    <RuntimeIdentifiers>win10-x64;win10-x86;win10-arm;win10-arm64</RuntimeIdentifiers>
     <MinVerTagPrefix>v</MinVerTagPrefix>
   </PropertyGroup>
-  
+
   <ItemGroup>
-    <PackageReference Include="Azure.Identity" Version="1.4.1" />
+    <PackageReference Include="Azure.Identity" Version="1.5.0" />
     <PackageReference Include="Azure.Security.KeyVault.Certificates" Version="4.2.0" />
     <PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="3.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging" Version="3.1.18" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="3.1.18" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="6.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="6.0.0" />
     <PackageReference Include="MinVer" Version="2.5.0">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>
     <PackageReference Include="RSAKeyVaultProvider" Version="2.1.1" />
   </ItemGroup>
-  
+
   <ItemGroup>
     <ProjectReference Include="..\AzureSign.Core\AzureSign.Core.csproj" />
   </ItemGroup>

src/AzureSignTool/SignCommand.cs

@@ -2,7 +2,7 @@
 using McMaster.Extensions.CommandLineUtils;
 using McMaster.Extensions.CommandLineUtils.Abstractions;
 using Microsoft.Extensions.Logging;
-
+using Microsoft.Extensions.Logging.Console;
 using RSAKeyVaultProvider;
 
 using System;
@@ -190,10 +190,11 @@ public int OnValidationError(ValidationResult result, CommandLineApplication<Sig
 
         private void ConfigureLogging(ILoggingBuilder builder)
         {
-            builder.AddConsole(console => {
+            builder.AddSimpleConsole(console => {
                 console.IncludeScopes = true;
-                console.DisableColors = !Colors;
+                console.ColorBehavior = Colors ? LoggerColorBehavior.Enabled : LoggerColorBehavior.Disabled;
             });
+
             builder.SetMinimumLevel(LogLevel);
         }
 
@@ -293,7 +294,7 @@ public async Task<int> OnExecuteAsync(CommandLineApplication app, IConsole conso
                         {
                             return state;
                         }
-                        using (var loopScope = logger.BeginScope("File: {Id}", filePath))
+                        using (logger.BeginScope("File: {Id}", filePath))
                         {
                             logger.LogInformation("Signing file.");
 

src/AzureSignTool/runtimeconfig.template.json

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
+    <TargetFramework>net6.0</TargetFramework>
 
     <IsPackable>false</IsPackable>
   </PropertyGroup>

test/AzureSign.Core.Tests/AzureSign.Core.Tests.csproj

@@ -1,13 +1,13 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>netcoreapp3.1</TargetFrameworks>
+    <TargetFrameworks>net6.0</TargetFrameworks>
 
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.6.1" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.0.0" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.2">
       <PrivateAssets>all</PrivateAssets>