misc: remove references to Yubico.DotNetPolyfills and update documentation for project structure

Author: DennisDyallo

.github/workflows/build-pull-requests.yml

@@ -63,7 +63,6 @@ jobs:
         with:
           name: Nuget Packages ReleaseWithDocs
           path: |
-            Yubico.DotNetPolyfills/src/bin/ReleaseWithDocs/*.nupkg
             Yubico.Core/src/bin/ReleaseWithDocs/*.nupkg
             Yubico.YubiKey/src/bin/ReleaseWithDocs/*.nupkg
 
@@ -72,6 +71,5 @@ jobs:
         with:
           name: Assemblies ReleaseWithDocs
           path: |
-            Yubico.DotNetPolyfills/src/bin/ReleaseWithDocs/**/*.dll
             Yubico.Core/src/bin/ReleaseWithDocs/**/*.dll
             Yubico.YubiKey/src/bin/ReleaseWithDocs/**/*.dll

.github/workflows/build.yml

@@ -80,7 +80,6 @@ jobs:
         run: |
           $file = gci ./build/Versions.props
           $versionProp = [xml](gc $file.FullName)
-          $versionProp.Project.PropertyGroup.YubicoDotNetPolyfillsVersion = "${{ github.event.inputs.version }}"
           $versionProp.Project.PropertyGroup.YubicoCoreVersion = "${{ github.event.inputs.version }}"
           $versionProp.Project.PropertyGroup.YubicoYubiKeyVersion = "${{ github.event.inputs.version }}"
           $versionProp.Save($file.FullName)
@@ -101,7 +100,6 @@ jobs:
         with:
           name: Nuget Packages
           path: |
-            Yubico.DotNetPolyfills/src/bin/ReleaseWithDocs/*.nupkg
             Yubico.Core/src/bin/ReleaseWithDocs/*.nupkg
             Yubico.YubiKey/src/bin/ReleaseWithDocs/*.nupkg
       
@@ -110,7 +108,6 @@ jobs:
         with:
           name: Symbols Packages
           path: |
-            Yubico.DotNetPolyfills/src/bin/ReleaseWithDocs/*.snupkg
             Yubico.Core/src/bin/ReleaseWithDocs/*.snupkg
             Yubico.YubiKey/src/bin/ReleaseWithDocs/*.snupkg
 
@@ -119,21 +116,17 @@ jobs:
         with:
           name: Assemblies
           path: |
-            Yubico.DotNetPolyfills/src/bin/ReleaseWithDocs/**/*.dll
             Yubico.Core/src/bin/ReleaseWithDocs/**/*.dll
             Yubico.YubiKey/src/bin/ReleaseWithDocs/**/*.dll
 
       - name: Generate artifact attestation
         uses: actions/attest-build-provenance@v2
         with:
           subject-path: |
-            Yubico.DotNetPolyfills/src/bin/ReleaseWithDocs/*.nupkg
             Yubico.Core/src/bin/ReleaseWithDocs/*.nupkg
             Yubico.YubiKey/src/bin/ReleaseWithDocs/*.nupkg
-            Yubico.DotNetPolyfills/src/bin/ReleaseWithDocs/*.snupkg
             Yubico.Core/src/bin/ReleaseWithDocs/*.snupkg
             Yubico.YubiKey/src/bin/ReleaseWithDocs/*.snupkg
-            Yubico.DotNetPolyfills/src/bin/ReleaseWithDocs/**/*.dll
             Yubico.Core/src/bin/ReleaseWithDocs/**/*.dll
             Yubico.YubiKey/src/bin/ReleaseWithDocs/**/*.dll
 
@@ -178,10 +171,8 @@ jobs:
         with:
           name: Nuget Packages
       - run: |
-          $polyfills = (Get-ChildItem -Recurse Yubico.DotnetPolyfills/*.nupkg)[0].FullName
           $core = (Get-ChildItem -Recurse Yubico.Core/*.nupkg)[0].FullName
           $yubikey = (Get-ChildItem -Recurse Yubico.YubiKey/*.nupkg)[0].FullName
           dotnet nuget add source --username ${{ github.actor }} --password ${{ secrets.GITHUB_TOKEN }} --store-password-in-clear-text --name github "https://nuget.pkg.github.com/Yubico/index.json"
-          dotnet nuget push $polyfills --source "github" --api-key ${{ secrets.GITHUB_TOKEN }}
           dotnet nuget push $core --source "github" --api-key ${{ secrets.GITHUB_TOKEN }}
           dotnet nuget push $yubikey --source "github" --api-key ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

@@ -210,5 +210,5 @@ The following rules must be followed for PRs that include files from another pro
 - The contribution is correctly attributed, as needed (generally in LICENSE.txt or NOTICE.txt in
   project root).
 
-See [CborTag.cs](./Yubico.DotNetPolyfills/src/System.Formats.Cbor/CborTag.cs) for an example of a
+See [CryptographicOperations.cs](./Yubico.Core/src/System.Security.Cryptography/CryptographicOperations.cs) for an example of a
 file copied from another project and attributed in the [LICENSE.txt](./LICENSE.txt) file.

LICENSE.txt

@@ -200,37 +200,6 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 
-
-
-==================================================
-The following license applies to
-\Yubico.DotNetPolyfills\src\Contrib.Bcl.Ranges\Range.cs
-\Yubico.DotNetPolyfills\src\Contrib.Bcl.Ranges\Index.cs
-
-MIT License
-
-Copyright (c) 2019 Stuart Lang
-Copyright (c) .NET Foundation and Contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
 ==================================================
 The following license applies to
 \CONTRIBUTING.md

Yubico.YubiKey/docs/users-manual/getting-started/overview-of-sdk.md

@@ -114,19 +114,15 @@ Read more about YubiHSM Auth [here.](xref:YubiHsmAuthOverview)
 
 ## SDK components
 
-The YubiKey SDK is comprised of three managed assemblies:
+The YubiKey SDK is comprised of two managed assemblies:
 
 - **Yubico.YubiKey** is the primary assembly that contains all of the classes and types needed for
   interacting with the YubiKey.
 - **Yubico.Core** is a common library used by Yubico's .NET offerings and serves as a platform
   abstraction layer (PAL). All interaction with operating-system specific functionality is contained
   within this library. It also contains useful utility classes that can be used for encoding and
   decoding different kinds of data, such as Base32, Tag-Length-Value (TLV), and ModHex.
-- **Yubico.DotNetPolyfills** is an internal library used to backport certain .NET base class library (BCL)
-  features needed by the SDK. Types in this assembly are subject to change and are not meant for
-  general public consumption. If you wish to use the newest features of .NET, you should target
-  the .NET implementation that contains those features directly.
-- **Yubico.NativeShims** is an internal unmanaged library that provides a stable Application
+- **Yubico.NativeShims** is an internal *unmanaged library* that provides a stable Application
   Binary Interface (ABI) to the P/Invoke Foreign Function Interface (FFI) in Yubico.Core.
 
 All components of the SDK are built to the .NET Standard 2.0 specification. This means that either
@@ -235,14 +231,4 @@ product. It also contains all of the platform abstraction logic required for oth
 to run across different platforms and operating systems.
 
 For most consumers of the SDK, this library will automatically be included when you reference the `Yubico.YubiKey`
-NuGet package.
-
-### Yubico.DotNetPolyfills
-
-Yubico.DotNetPolyfills is a support project for .NET-based Yubico libraries. It is not to be consumed. Yubico
-will not make any effort at providing a stable API surface around this assembly, and it may have breaking changes
-applied to it at any point in time. Its purpose is to provide the SDK, which targets .NET Standard 2.0, with missing
-APIs so that we can leverage certain newer features. If you wish to use the latest features of .NET, your library
-or application should target a newer standard. If that is not possible, we recommend that you invest in creating
-your own polyfills library. This way, you can implement precisely what your project needs and not have to rely on
-what may or may not be implemented here.
+NuGet package.

Yubico.YubiKey/docs/users-manual/sdk-programming-guide/appcompat.md

@@ -28,7 +28,7 @@ The .NET SDK strives to maintain both source and behavioral compatibility across
 **Source compatibility** is the promise that your source code should continue to compile as-is when you update your
 application to the latest version of the SDK. This promise extends to "minor" (feature) and "patch" (bug-fix) releases
 of the SDK. Additionally, we only make this guarantee for the `Yubico.YubiKey` and the `Yubico.Core` assemblies. Since
-`Yubico.NativeShims` and `Yubico.DotnetPolyfills` are meant to be purely for internal use, we *do not* make any
+`Yubico.NativeShims` is meant to be purely for internal use, we *do not* make any
 guarantees here.
 
 **Behavioral compatibility** is the promise that your application will behave exactly the same after you have upgraded

build/Versions.props

@@ -30,18 +30,6 @@ for external milestones.
 
   <PropertyGroup Label="Versions for all projects">
 
-    <!--
-    Yubico.DotNetPolyfills project
-
-    This project includes polyfill code that allows other projects in this repository to use .NET
-    library features and APIs in older versions of the .NET Standard.
-
-    Increment the major version whenever we remove support for a .NET version.
-    Increment the minor version whenever we add support for a new class or type.
-    Increment the patch version for bug fixes.
-    -->
-<YubicoDotNetPolyfillsVersion>1.12.1</YubicoDotNetPolyfillsVersion>
-
     <!--
     Yubico.Core project
 

build/build.ps1

@@ -15,7 +15,6 @@ limitations under the License. #>
 function Build-YubiKeySdkProject
 {
     $ProjectPaths = @{
-        "DotNetPolyfills" = "./Yubico.DotNetPolyfills/src/Yubico.DotNetPolyfills.csproj"
         "CoreRef" = "./Yubico.Core/ref/Yubico.Core.Ref.csproj"
         "CoreSrc" = "./Yubico.Core/src/Yubico.Core.csproj"
         "YubiKey" = "./Yubico.YubiKey/src/Yubico.YubiKey.csproj"
@@ -29,7 +28,6 @@ function Build-YubiKeySdkProject
         Write-Error "The dotnet CLI was not found. You can install all prerequisites using Install-YubiKeySdkTools."
     }
 
-    Build-Project $ProjectPaths["DotNetPolyfills"] $CurrentConfiguration
     Build-Project $ProjectPaths["CoreRef"] $CurrentConfiguration
     Build-Project $ProjectPaths["CoreSrc"] $CurrentConfiguration
     Build-Project $ProjectPaths["YubiKey"] $CurrentConfiguration
@@ -40,13 +38,10 @@ function Test-YubiKeySdkProject
     $CurrentConfiguration = "Debug"
 
     $ProjectPaths = @{
-        "DotNetPolyfills" = "./Yubico.DotNetPolyfills/tests/Yubico.DotNetPolyfills.UnitTests.csproj"
         "Core" = "./Yubico.Core/tests/Yubico.Core.UnitTests.csproj"
         "YubiKey" = "./Yubico.YubiKey/tests/Yubico.YubiKey.UnitTests.csproj"
     }
 
-    Test-Project $ProjectPaths["DotNetPolyfills"] $CurrentConfiguration
-
     # We should test core for each RID that we build for
     Test-Project $ProjectPaths["Core"] $CurrentConfiguration "win-x64"
     Test-Project $ProjectPaths["Core"] $CurrentConfiguration "osx-x64"

contributordocs/getting-started.md

@@ -74,8 +74,7 @@ one or more 'Project File' (\*.csproj, \*.cxproj, etc.) that represents a single
 The .NET YubiKey SDK project has a single solution file located in the root of the repository called
 Yubico.NET.SDK.sln.
 
-Within the solution there are three groupings of projects: Yubico.YubiKey, Yubico.Core, and
-Yubico.DotnetPolyfills.
+Within the solution there are two groupings of projects: Yubico.YubiKey and Yubico.Core.
 
 Each project folder may have one or more subfolders: