SolTechnology.Core.Authentication
0.5.0
dotnet add package SolTechnology.Core.Authentication --version 0.5.0
NuGet\Install-Package SolTechnology.Core.Authentication -Version 0.5.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="SolTechnology.Core.Authentication" Version="0.5.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SolTechnology.Core.Authentication" Version="0.5.0" />
<PackageReference Include="SolTechnology.Core.Authentication" />
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 SolTechnology.Core.Authentication --version 0.5.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: SolTechnology.Core.Authentication, 0.5.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 SolTechnology.Core.Authentication@0.5.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=SolTechnology.Core.Authentication&version=0.5.0
#tool nuget:?package=SolTechnology.Core.Authentication&version=0.5.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Overview
The SolTechnology.Core.Authentication library provides minimum basic API Key Authentication functionality. It handles needed services registration and configuration.
Registration
For installing the library, reference SolTechnology.Core.Authentication nuget package and invoke AddAuthenticationAndBuildFilter(); service collection extension method:
var authenticationFiler = builder.Services.AddAuthenticationAndBuildFilter();
Configuration
- The first option is to create an appsettings.json section:
"Configuration": {
"Authentication": {
"Key": "SecureKey"
}
}
- Alternatevely the same settings can be provided by optional parameter during registration:
var authenticationConfiguration = new AuthenticationConfiguration
{
Key = "SecureKey"
};
services.AddAuthenticationAndBuildFilter(authenticationConfiguration);
Usage
- After registration, the authentication filter has to be added to MVC options
builder.Services.AddControllers(opts => opts.Filters.Add(authenticationFiler));
- Additionally Authentication and Authorization has to be added to app
app.UseAuthorization();
app.UseAuthentication();
- From now on, you have to add your authentication key to header of every request send to the application
- Header name: "X-Auth"
- Schema name: "SolTechnologyAuthentication"
- Base64 encoded key: (equivalent of "SecureKey" is "U2VjdXJlS2V5")
For example:
"X-Auth": "SolTechnologyAuthentication U2VjdXJlS2V5"
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. 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.
-
net10.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.