Keycloak.AuthServices.Authentication
2.6.0
Prefix Reserved
dotnet add package Keycloak.AuthServices.Authentication --version 2.6.0
NuGet\Install-Package Keycloak.AuthServices.Authentication -Version 2.6.0
<PackageReference Include="Keycloak.AuthServices.Authentication" Version="2.6.0" />
paket add Keycloak.AuthServices.Authentication --version 2.6.0
#r "nuget: Keycloak.AuthServices.Authentication, 2.6.0"
// Install Keycloak.AuthServices.Authentication as a Cake Addin #addin nuget:?package=Keycloak.AuthServices.Authentication&version=2.6.0 // Install Keycloak.AuthServices.Authentication as a Cake Tool #tool nuget:?package=Keycloak.AuthServices.Authentication&version=2.6.0
Keycloak.AuthServices
🔐 Easy Authentication and Authorization with Keycloak in .NET.
Documentation
For Developer Documentation see: https://nikiforovall.github.io/keycloak-authorization-services-dotnet
API Reference
See: https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs
Getting Started
Install packages:
dotnet add package Keycloak.AuthServices.Authentication
// Program.cs
using Keycloak.AuthServices.Authentication;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddKeycloakWebApiAuthentication(builder.Configuration);
builder.Services.AddAuthorization();
var app = builder.Build();
app.UseAuthentication();
app.UseAuthorization();
app.MapGet("/", () => "Hello World!").RequireAuthorization();
app.Run();
In this example, configuration is based on appsettings.json
.
//appsettings.json
{
"Keycloak": {
"realm": "Test",
"auth-server-url": "http://localhost:8080/",
"ssl-required": "none",
"resource": "test-client",
"verify-token-audience": false,
"credentials": {
"secret": ""
},
"confidential-port": 0
}
}
Example - Add Authorization
With Keycloak.AuthServices.Authorization
, you can implement role-based authorization in your application. This package allows you to define policies based on roles. Also, you can use Keycloak as Authorization Server. It is a powerful way to organize and apply authorization polices centrally.
var builder = WebApplication.CreateBuilder(args);
var host = builder.Host;
var configuration = builder.Configuration;
var services = builder.Services;
services.AddKeycloakWebApiAuthentication(configuration);
services.AddAuthorization(options =>
{
options.AddPolicy("AdminAndUser", builder =>
{
builder
.RequireRealmRoles("User") // Realm role is fetched from token
.RequireResourceRoles("Admin"); // Resource/Client role is fetched from token
});
})
.AddKeycloakAuthorization(configuration);
var app = builder.Build();
app.UseAuthentication();
app.UseAuthorization();
app.MapGet("/hello", () => "[]")
.RequireAuthorization("AdminAndUser");
app.Run();
Example - Invoke Admin API
var services = new ServiceCollection();
services.AddKeycloakAdminHttpClient(new KeycloakAdminClientOptions
{
AuthServerUrl = "http://localhost:8080/",
Realm = "master",
Resource = "admin-api",
});
var sp = services.BuildServiceProvider();
var client = sp.GetRequiredService<IKeycloakRealmClient>();
var realm = await client.GetRealmAsync("Test");
Build and Development
dotnet cake --target build
dotnet cake --target test
dotnet pack -o ./Artefacts
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. 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. |
-
net8.0
- Microsoft.AspNetCore.Authentication.JwtBearer (>= 8.0.11)
- Microsoft.AspNetCore.Authentication.OpenIdConnect (>= 8.0.11)
- Microsoft.Extensions.Configuration.Abstractions (>= 9.0.0)
- Microsoft.Extensions.Configuration.Json (>= 9.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 9.0.0)
- Microsoft.IdentityModel.Protocols.OpenIdConnect (>= 8.2.1)
NuGet packages (11)
Showing the top 5 NuGet packages that depend on Keycloak.AuthServices.Authentication:
Package | Downloads |
---|---|
Gathrr.Framework.Infrastructure
Package Description |
|
MicroEthos.Common.Endpoints
Package Description |
|
Manjalabs.Library
Package Description |
|
Wcz.Layout
Package Description |
|
Inspire.Framework.Infrastructure
Package Description |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on Keycloak.AuthServices.Authentication:
Repository | Stars |
---|---|
NikiforovAll/keycloak-authorization-services-dotnet
Authentication and Authorization with Keycloak and ASP.NET Core 🔐
|
Version | Downloads | Last updated |
---|---|---|
2.6.0 | 8,150 | 11/30/2024 |
2.5.3 | 101,377 | 8/19/2024 |
2.5.2 | 114,135 | 6/15/2024 |
2.5.1 | 17,901 | 6/11/2024 |
2.5.0 | 16,353 | 6/2/2024 |
2.4.1 | 20,110 | 5/16/2024 |
2.4.0 | 2,257 | 5/12/2024 |
2.3.0 | 542 | 5/10/2024 |
2.3.0-pre-1 | 117 | 5/9/2024 |
2.2.1 | 964 | 5/9/2024 |
2.2.0 | 421 | 5/8/2024 |
2.1.0 | 4,544 | 5/7/2024 |
2.0.0 | 3,537 | 5/5/2024 |
2.0.0-pre-4 | 134 | 5/4/2024 |
2.0.0-pre-3 | 206 | 4/26/2024 |
2.0.0-pre-2 | 121 | 4/25/2024 |
2.0.0-pre-1 | 285 | 4/24/2024 |
1.6.0 | 320,117 | 10/25/2023 |
1.5.2 | 274,225 | 5/27/2023 |
1.5.1 | 175,149 | 1/17/2023 |
1.5.0 | 687 | 1/17/2023 |
1.4.1 | 3,647 | 1/12/2023 |
1.4.0 | 5,515 | 1/4/2023 |
1.3.0 | 4,471 | 12/28/2022 |
1.2.1 | 85,192 | 9/22/2022 |
1.2.0 | 6,771 | 8/24/2022 |
1.1.0 | 13,116 | 1/30/2022 |
1.0.5 | 163 | 1/29/2022 |
1.0.4 | 3,375 | 1/28/2022 |
1.0.3 | 138 | 1/28/2022 |
1.0.2 | 136 | 1/23/2022 |
1.0.1 | 686 | 1/19/2022 |
1.0.0 | 4,036 | 1/19/2022 |
The release notes are available at https://github.com/NikiforovAll/keycloak-authorization-services-dotnet/releases