Meziantou.AspNetCore.Authentication.HttpBasic
2.0.0
Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Meziantou.AspNetCore.Authentication.HttpBasic --version 2.0.0
NuGet\Install-Package Meziantou.AspNetCore.Authentication.HttpBasic -Version 2.0.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="Meziantou.AspNetCore.Authentication.HttpBasic" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Meziantou.AspNetCore.Authentication.HttpBasic" Version="2.0.0" />
<PackageReference Include="Meziantou.AspNetCore.Authentication.HttpBasic" />
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 Meziantou.AspNetCore.Authentication.HttpBasic --version 2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Meziantou.AspNetCore.Authentication.HttpBasic, 2.0.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 Meziantou.AspNetCore.Authentication.HttpBasic@2.0.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=Meziantou.AspNetCore.Authentication.HttpBasic&version=2.0.0
#tool nuget:?package=Meziantou.AspNetCore.Authentication.HttpBasic&version=2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Meziantou.AspNetCore.Authentication.HttpBasic
ASP.NET Core authentication handler for HTTP Basic authentication.
Credential validation is delegate-based through options.ValidateCredentials, which returns a ClaimsPrincipal for valid credentials and null for invalid credentials.
You can also integrate with ASP.NET Core Identity using AddHttpBasicIdentity<TUser>().
Usage
using Meziantou.AspNetCore.Authentication.HttpBasic;
using System.Security.Claims;
var builder = WebApplication.CreateBuilder(args);
builder.Services
.AddAuthentication(HttpBasicAuthenticationDefaults.AuthenticationScheme)
.AddHttpBasic(options =>
{
options.Realm = "My application";
options.MaxCredentialLength = 4096;
options.ValidateCredentials = (context, username, password) =>
{
if (!string.Equals(username, "admin", StringComparison.Ordinal) ||
!string.Equals(password, "secret", StringComparison.Ordinal))
{
return ValueTask.FromResult<ClaimsPrincipal?>(null);
}
var claims = new[]
{
new Claim(ClaimTypes.Name, username),
new Claim(ClaimTypes.NameIdentifier, username),
};
var identity = new ClaimsIdentity(claims, authenticationType: HttpBasicAuthenticationDefaults.AuthenticationScheme);
return ValueTask.FromResult<ClaimsPrincipal?>(new ClaimsPrincipal(identity));
};
});
builder.Services.AddAuthorization();
var app = builder.Build();
app.UseAuthentication();
app.UseAuthorization();
app.MapGet("/", (ClaimsPrincipal user) => $"Hello {user.Identity?.Name}!")
.RequireAuthorization();
app.Run();
ASP.NET Core Identity integration
using Meziantou.AspNetCore.Authentication.HttpBasic;
using Microsoft.AspNetCore.Identity;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddIdentityCore<IdentityUser>()
.AddSignInManager();
builder.Services
.AddAuthentication(HttpBasicAuthenticationDefaults.AuthenticationScheme)
.AddHttpBasicIdentity<IdentityUser>(options =>
{
options.Realm = "My application";
});
Security options
MaxCredentialLengthlimits the size (in characters) of the Base64 credential payload in theAuthorizationheader.
| 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. net11.0 is compatible. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- No dependencies.
-
net11.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.