Add .Net 6 as supported framework (#270)

trejjam · web-flow · commit 54761b01b05e · 2021-12-21T21:09:50.000-05:00
* Add .Net6 to the Demo project

* Add .Net6 to the Test project

* Add net6.0 to the SupportedTargetFrameworks

* Add .Net6 to the Fido2.AspNet project

* Fix BOM typo in the AuthenticatorAssertionResponse

* Specify RootNamespace (maybe use separate namespace for each project?)

* Resolve compiler warnings in the Test project

* Semi-resolve warnings in the Fido2.Model project

* Resolve compiler warnings in the Demo project

* Resolve warnings in the Fido2 project

* Add missing TreatWarningsAsErrors

* Fix possible error

* Add dotnet-reportgenerator-globaltool (a local package of tool used in CI)

* Use coverlet.collector instead of coverlet.msbuild (VSTest issues)

* Allow both .Net 5.0 &amp; 6.0, refactor build/test pipeline
diff --git a/Demo/.config/dotnet-tools.json b/Demo/.config/dotnet-tools.json
@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "dotnet-aspnet-codegenerator": {
+      "version": "6.0.0",
+      "commands": [
+        "dotnet-aspnet-codegenerator"
+      ]
+    }
+  }
+}
diff --git a/Demo/Demo.csproj b/Demo/Demo.csproj
@@ -1,16 +1,19 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk.Web">
   <PropertyGroup>
-    <TargetFramework>net5.0</TargetFramework>
+    <TargetFrameworks>net5.0;net6.0</TargetFrameworks>
     <UserSecretsId>39589262-6aa1-4bde-aaa9-403a7542cf63</UserSecretsId>
+    <RootNamespace>Fido2Demo</RootNamespace>
   </PropertyGroup>
   <ItemGroup>
     <ProjectReference Include="..\Src\Fido2.AspNet\Fido2.AspNet.csproj" />
     <ProjectReference Include="..\Src\Fido2.Models\Fido2.Models.csproj" />
     <ProjectReference Include="..\Src\Fido2\Fido2.csproj" />
-    <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="5.0.2" />    
   </ItemGroup>
-  <ItemGroup>
-    <DotNetCliToolReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Tools" Version="2.0.2" />
+  <ItemGroup Condition=" '$(TargetFramework)' == 'net5.0' ">
+    <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="5.0.2" />
+  </ItemGroup>
+  <ItemGroup Condition=" '$(TargetFramework)' == 'net6.0' ">
+    <PackageReference Include="Microsoft.VisualStudio.Web.CodeGeneration.Design" Version="6.0.0" />
   </ItemGroup>
   <ItemGroup>
     <Folder Include="wwwroot\bulma\" />
diff --git a/Demo/Pages/custom.cshtml b/Demo/Pages/custom.cshtml
@@ -72,7 +72,7 @@
         </div>
 
         <partial name="_options.cshtml" />
-        @Html.Partial("_options.cshtml")
+        @await Html.PartialAsync("_options.cshtml")
 
         <div class="section">
             <div class="container">
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -15,7 +15,8 @@
   
   <!-- Global Variables -->
   <PropertyGroup>
-    <SupportedTargetFrameworks>net5.0</SupportedTargetFrameworks>
+    <SupportedTargetFrameworks>net5.0;net6.0</SupportedTargetFrameworks>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
   </PropertyGroup>
   
   <!-- Language + Compiler Settings-->
@@ -30,4 +31,4 @@
     <!-- Avoid annoying build warnings when packing using the solution file -->
     <IsTestProject>false</IsTestProject>
   </PropertyGroup>
-</Project>
+</Project>
diff --git a/Src/Fido2.AspNet/Fido2.AspNet.csproj b/Src/Fido2.AspNet/Fido2.AspNet.csproj
@@ -1,7 +1,8 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net5.0</TargetFrameworks>
+    <TargetFrameworks>net5.0;net6.0</TargetFrameworks>
+    <RootNamespace>Fido2NetLib</RootNamespace>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/Src/Fido2.Models/Fido2.Models.csproj b/Src/Fido2.Models/Fido2.Models.csproj
@@ -2,6 +2,8 @@
   <PropertyGroup>
     <TargetFrameworks>$(SupportedTargetFrameworks)</TargetFrameworks>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <RootNamespace>Fido2NetLib</RootNamespace>
+    <NoWarn>$(NoWarn);CS1591</NoWarn>
   </PropertyGroup>
   
   <ItemGroup>
@@ -17,4 +19,4 @@
   <ItemGroup>
     <PackageReference Update="Microsoft.SourceLink.GitHub" Version="1.0.0" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/Src/Fido2.Models/Fido2Configuration.cs b/Src/Fido2.Models/Fido2Configuration.cs
@@ -48,7 +48,12 @@ public class Fido2Configuration
         /// </summary>
         public HashSet<string> Origins
         {
-            get => _origins ?? new HashSet<string> { Origin };
+            get => _origins ?? new HashSet<string>
+            {
+#pragma warning disable CS0618
+                Origin
+#pragma warning restore CS0618
+            };
             set
             {
                 _origins = value;
@@ -61,7 +66,12 @@ public HashSet<string> Origins
         /// </summary>
         public HashSet<string> FullyQualifiedOrigins
         {
-            get => _fullyQualifiedOrigins ?? new HashSet<string> { Origin?.ToFullyQualifiedOrigin() };
+            get => _fullyQualifiedOrigins ?? new HashSet<string>
+            {
+#pragma warning disable CS0618
+                Origin?.ToFullyQualifiedOrigin()
+#pragma warning restore CS0618
+            };
             private set => _fullyQualifiedOrigins = value;
         }
 
diff --git a/Src/Fido2/AttestationFormat/AndroidSafetyNet.cs b/Src/Fido2/AttestationFormat/AndroidSafetyNet.cs
@@ -16,7 +16,7 @@ namespace Fido2NetLib
 {
     internal sealed class AndroidSafetyNet : AttestationVerifier
     {
-        private readonly int _driftTolerance;
+        private const int _driftTolerance = 0;
 
         private static X509Certificate2 GetX509Certificate(string certString)
         {
diff --git a/Src/Fido2/AuthenticatorAssertionResponse.cs b/Src/Fido2/AuthenticatorAssertionResponse.cs
@@ -1,7 +1,7 @@
 ﻿using System;
 using System.Collections.Generic;
 
-﻿#nullable disable
+#nullable disable
 
 using System.Linq;
 using System.Security.Cryptography;
diff --git a/Src/Fido2/Cbor/CborMap.cs b/Src/Fido2/Cbor/CborMap.cs
@@ -166,8 +166,10 @@ public CborObject GetValue(long key)
             throw new KeyNotFoundException($"Key '{key}' not found");
         }
 
+
         public CborObject? this[CborObject key]
         {
+#pragma warning disable CS8766
             get
             {
                 foreach (var item in items)
@@ -178,8 +180,9 @@ public CborObject? this[CborObject key]
                     }
                 }
 
-                return null!;
+                return null;
             }
+#pragma warning restore CS8766
         }
 
         public override CborObject? this[string name]
diff --git a/Src/Fido2/Fido2.csproj b/Src/Fido2/Fido2.csproj
@@ -2,6 +2,7 @@
   <PropertyGroup>
     <TargetFrameworks>$(SupportedTargetFrameworks)</TargetFrameworks>
     <Nullable>enable</Nullable>
+    <RootNamespace>Fido2NetLib</RootNamespace>
   </PropertyGroup>
    
   <ItemGroup>
@@ -31,4 +32,4 @@
   <ItemGroup>
     <PackageReference Update="Microsoft.SourceLink.GitHub" Version="1.0.0" />
   </ItemGroup>
-</Project>
+</Project>
diff --git a/Src/Fido2/Metadata/ConformanceMetadataRepository.cs b/Src/Fido2/Metadata/ConformanceMetadataRepository.cs
@@ -28,14 +28,13 @@ public sealed class ConformanceMetadataRepository : IMetadataRepository
                                         "xubSa3y3v5ormpPqCwfqn9s0MLBAtzCIgxQ/zkzPKctkiwoPtDzI51KnAjAmeMyg" +
                                         "X2S5Ht8+e+EQnezLJBJXtnkRWY+Zt491wgt/AwSs5PHHMv5QgjELOuMxQBc=";
 
-        private readonly string? _blobUrl;
         private readonly HttpClient _httpClient;
 
-        private readonly string _origin = "http://localhost";
+        private readonly string _origin;
 
         private readonly string _getEndpointsUrl = "https://mds3.certinfra.fidoalliance.org/getEndpoints";
 
-        public ConformanceMetadataRepository(HttpClient client, string origin)
+        public ConformanceMetadataRepository(HttpClient? client, string origin)
         {
             _httpClient = client ?? new HttpClient();
             _origin = origin;
@@ -82,7 +81,7 @@ public async Task<MetadataBLOBPayload> GetBLOBAsync()
                     continue;
                 }
                 
-                if(string.Compare(blob.NextUpdate, combinedBlob.NextUpdate) < 0)
+                if(string.Compare(blob.NextUpdate, combinedBlob.NextUpdate, StringComparison.InvariantCulture) < 0)
                     combinedBlob.NextUpdate = blob.NextUpdate;
                 if (combinedBlob.Number < blob.Number)
                     combinedBlob.Number = blob.Number;
diff --git a/Test/.config/dotnet-tools.json b/Test/.config/dotnet-tools.json
@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "dotnet-reportgenerator-globaltool": {
+      "version": "5.0.0",
+      "commands": [
+        "reportgenerator"
+      ]
+    }
+  }
+}
diff --git a/Test/AuthenticatorResponse.cs b/Test/AuthenticatorResponse.cs
@@ -314,7 +314,7 @@ public void TestAuthenticatorAttestationReponseAttestationObjectNull(byte[] valu
 
         [Theory]
         [InlineData(new byte[] { 0x66, 0x6f, 0x6f })]
-        public async void TestAuthenticatorAttestationObjectBadCBOR(byte[] value)
+        public void TestAuthenticatorAttestationObjectBadCBOR(byte[] value)
         {
             var rawResponse = new AuthenticatorAttestationRawResponse
             {
diff --git a/Test/Fido2Tests.cs b/Test/Fido2Tests.cs
@@ -273,6 +273,7 @@ internal byte[] SignData(COSE.KeyType kty, COSE.Algorithm alg, COSE.EllipticCurv
                             privateKey = Key.Import(SignatureAlgorithm.Ed25519, expandedPrivateKey, KeyBlobFormat.RawPrivateKey);
                             break;
                         }
+                    default:
                         throw new ArgumentOutOfRangeException(nameof(kty), $"Missing or unknown kty {kty}");
                 }
 
@@ -861,6 +862,7 @@ internal static async Task<AssertionVerificationResult> MakeAssertionResponse(CO
                             cpk = MakeCredentialPublicKey(kty, alg, COSE.EllipticCurve.Ed25519, publicKey);
                             break;
                         }
+                    default:
                         throw new ArgumentOutOfRangeException(nameof(kty), $"Missing or unknown kty {kty}");
                 }
             }
@@ -1064,6 +1066,7 @@ internal static CredentialPublicKey MakeCredentialPublicKey((COSE.KeyType, COSE.
                         cpk = MakeCredentialPublicKey(kty, alg, COSE.EllipticCurve.Ed25519, publicKey);
                         break;
                     }
+                default:
                     throw new ArgumentException(nameof(kty), $"Missing or unknown kty {kty}");
             }
             return cpk;
diff --git a/Test/Test.csproj b/Test/Test.csproj
@@ -1,6 +1,6 @@
 ﻿<Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFrameworks>net5.0</TargetFrameworks>
+    <TargetFrameworks>net5.0;net6.0</TargetFrameworks>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
@@ -13,27 +13,31 @@
     </Content>
     <None Include="@(TestFiles)" />
   </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\Src\Fido2.AspNet\Fido2.AspNet.csproj" />
     <ProjectReference Include="..\Src\Fido2.Models\Fido2.Models.csproj" />
     <ProjectReference Include="..\Src\Fido2\Fido2.csproj" />
-    <PackageReference Include="coverlet.msbuild" Version="3.1.0">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="coverlet.collector" Version="3.1.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
-    <PackageReference Include="ReportGenerator" Version="4.6.1" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.0.0" />
+    <PackageReference Include="ReportGenerator" Version="5.0.0" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
   </ItemGroup>
 
-  <ItemGroup>
-    <None Update="xunit.runner.json">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
+  <ItemGroup>
+    <None Update="xunit.runner.json">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
 
   <ItemGroup>
diff --git a/azure-pipelines.yml b/azure-pipelines.yml

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ namespace Fido2NetLib`
`16`	`16`	`{`
`17`	`17`	`internal sealed class AndroidSafetyNet : AttestationVerifier`
`18`	`18`	`{`
`19`		`- private readonly int _driftTolerance;`
	`19`	`+ private const int _driftTolerance = 0;`
`20`	`20`
`21`	`21`	`private static X509Certificate2 GetX509Certificate(string certString)`
`22`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -166,8 +166,10 @@ public CborObject GetValue(long key)`
`166`	`166`	`throw new KeyNotFoundException($"Key '{key}' not found");`
`167`	`167`	`}`
`168`	`168`
	`169`	`+`
`169`	`170`	`public CborObject? this[CborObject key]`
`170`	`171`	`{`
	`172`	`+#pragma warning disable CS8766`
`171`	`173`	`get`
`172`	`174`	`{`
`173`	`175`	`foreach (var item in items)`
`@@ -178,8 +180,9 @@ public CborObject? this[CborObject key]`
`178`	`180`	`}`
`179`	`181`	`}`
`180`	`182`
`181`		`- return null!;`
	`183`	`+ return null;`
`182`	`184`	`}`
	`185`	`+#pragma warning restore CS8766`
`183`	`186`	`}`
`184`	`187`
`185`	`188`	`public override CborObject? this[string name]`