Keycloak.AuthServices.Common
2.0.0-pre-4
Prefix Reserved
See the version list below for details.
dotnet add package Keycloak.AuthServices.Common --version 2.0.0-pre-4
NuGet\Install-Package Keycloak.AuthServices.Common -Version 2.0.0-pre-4
<PackageReference Include="Keycloak.AuthServices.Common" Version="2.0.0-pre-4" />
paket add Keycloak.AuthServices.Common --version 2.0.0-pre-4
#r "nuget: Keycloak.AuthServices.Common, 2.0.0-pre-4"
// Install Keycloak.AuthServices.Common as a Cake Addin #addin nuget:?package=Keycloak.AuthServices.Common&version=2.0.0-pre-4&prerelease // Install Keycloak.AuthServices.Common as a Cake Tool #tool nuget:?package=Keycloak.AuthServices.Common&version=2.0.0-pre-4&prerelease
Keycloak.AuthServices
Easy Authentication and Authorization with Keycloak in .NET and ASP.NET Core.
Documentation
See the docs: https://nikiforovall.github.io/keycloak-authorization-services-dotnet
Getting Started
Install packages:
dotnet add package Keycloak.AuthServices.Authentication
dotnet add package Keycloak.AuthServices.Common
// 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 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();
Build and Development
dotnet cake --target build
dotnet cake --target test
dotnet pack -o ./Artefacts
Blog Posts
For more information and real world examples, please see my blog posts related to Keycloak and .NET https://nikiforovall.github.io/tags.html#keycloak-ref
- https://nikiforovall.github.io/aspnetcore/dotnet/2022/08/24/dotnet-keycloak-auth.html
- https://nikiforovall.github.io/dotnet/keycloak/2022/12/28/keycloak-authorization-server.html
- https://nikiforovall.github.io/blazor/dotnet/2022/12/08/dotnet-keycloak-blazorwasm-auth.html
Reference
Product | Versions 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 was computed. 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. |
-
net6.0
- Microsoft.Extensions.Configuration.Abstractions (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Keycloak.AuthServices.Common:
Package | Downloads |
---|---|
Keycloak.AuthServices.Sdk
HttpClient integration with Keycloak. Includes HTTP Admin REST API, Protection API. |
|
Keycloak.AuthServices.Sdk.Kiota
Keycloak HTTP Admin API generated by Kiota |
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on Keycloak.AuthServices.Common:
Repository | Stars |
---|---|
NikiforovAll/keycloak-authorization-services-dotnet
Authentication and Authorization with Keycloak and ASP.NET Core 🔐
|
Version | Downloads | Last updated |
---|---|---|
2.6.0 | 2,213 | 11/30/2024 |
2.5.5 | 1,294 | 11/27/2024 |
2.5.3 | 40,838 | 8/19/2024 |
2.5.2 | 38,990 | 6/15/2024 |
2.5.1 | 628 | 6/11/2024 |
2.5.0 | 8,934 | 6/2/2024 |
2.4.1 | 7,363 | 5/16/2024 |
2.4.0 | 848 | 5/12/2024 |
2.3.0 | 336 | 5/10/2024 |
2.3.0-pre-1 | 126 | 5/9/2024 |
2.2.1 | 631 | 5/9/2024 |
2.2.0 | 195 | 5/8/2024 |
2.1.0 | 2,640 | 5/7/2024 |
2.0.0 | 617 | 5/5/2024 |
2.0.0-pre-4 | 141 | 5/4/2024 |
2.0.0-pre-3 | 198 | 4/26/2024 |
2.0.0-pre-2 | 134 | 4/25/2024 |
2.0.0-pre-1 | 288 | 4/24/2024 |
1.7.0 | 2,948 | 4/23/2024 |
1.6.0 | 95,461 | 10/25/2023 |
1.5.2 | 73,523 | 5/27/2023 |
1.5.1 | 51,106 | 1/17/2023 |
1.5.0 | 610 | 1/17/2023 |
1.4.1 | 1,019 | 1/12/2023 |
1.4.0 | 507 | 1/4/2023 |
1.3.0 | 1,085 | 12/28/2022 |
1.2.1 | 9,830 | 9/22/2022 |
1.2.0 | 734 | 8/24/2022 |
1.1.0 | 14,814 | 1/30/2022 |
1.0.5 | 147 | 1/29/2022 |
1.0.4 | 3,333 | 1/28/2022 |
1.0.3 | 133 | 1/28/2022 |
1.0.2 | 138 | 1/23/2022 |
1.0.1 | 660 | 1/19/2022 |
The release notes are available at https://github.com/NikiforovAll/keycloak-authorization-services-dotnet/releases