Passingwind.AspNetCore.Authentication.ApiKey 0.2.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Passingwind.AspNetCore.Authentication.ApiKey --version 0.2.0
                    


                    

                
NuGet\Install-Package Passingwind.AspNetCore.Authentication.ApiKey -Version 0.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Passingwind.AspNetCore.Authentication.ApiKey" Version="0.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Passingwind.AspNetCore.Authentication.ApiKey" Version="0.2.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Passingwind.AspNetCore.Authentication.ApiKey" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Passingwind.AspNetCore.Authentication.ApiKey --version 0.2.0
                    


                    

                
#r "nuget: Passingwind.AspNetCore.Authentication.ApiKey, 0.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Passingwind.AspNetCore.Authentication.ApiKey@0.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Passingwind.AspNetCore.Authentication.ApiKey&version=0.2.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Passingwind.AspNetCore.Authentication.ApiKey&version=0.2.0
                    


                            Install as a Cake Tool

AspNetCore.Authentication.ApiKey

ASP.NET Core authentication handler for the ApiKey protocol

NuGet

Quickstart

builder.Services
    .AddAuthentication()
    // api ApiKey scheme
    .AddApiKey<TestApiKeyProvider>();

// configure this if you default scheme is not 'ApiKey'
// builder.Services.ConfigureApplicationCookie(options =>
// {
//     options.ForwardDefaultSelector = (s) =>
//     {
//         var authorization = (string?)s.Request.Headers.Authorization;
//         if (authorization?.StartsWith(ApiKeyDefaults.AuthenticationSchemeName) == true)
//             return ApiKeyDefaults.AuthenticationScheme;
// 
//         // you default scheme
//         return IdentityConstants.ApplicationScheme;
//     };
// });

TestApiKeyProvider.cs

public class TestApiKeyProvider : IApiKeyProvider
{ 
    public async Task<ApiKeyValidationResult> ValidateAsync(string apiKey, CancellationToken cancellationToken = default)
    {
        // verification apiKey
        ...

        // if success
        return ApiKeyValidationResult.Success(...);

        // if fail
        return ApiKeyValidationResult.Failed(new Exception("invalid api key"));
    }
}
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net6.0

    • No dependencies.

  • net7.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Passingwind.AspNetCore.Authentication.ApiKey:

Package Downloads
Passingwind.Abp.ApiKey.AspNetCore

an abp module that provider api key authentication and key management.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.3.0 1,562 1/6/2024
0.2.0 6,402 9/23/2023
0.1.0 219 9/19/2023