Keycloak.AuthServices.Sdk
2.0.0-pre-2
Prefix Reserved
See the version list below for details.
dotnet add package Keycloak.AuthServices.Sdk --version 2.0.0-pre-2
NuGet\Install-Package Keycloak.AuthServices.Sdk -Version 2.0.0-pre-2
<PackageReference Include="Keycloak.AuthServices.Sdk" Version="2.0.0-pre-2" />
paket add Keycloak.AuthServices.Sdk --version 2.0.0-pre-2
#r "nuget: Keycloak.AuthServices.Sdk, 2.0.0-pre-2"
// Install Keycloak.AuthServices.Sdk as a Cake Addin #addin nuget:?package=Keycloak.AuthServices.Sdk&version=2.0.0-pre-2&prerelease // Install Keycloak.AuthServices.Sdk as a Cake Tool #tool nuget:?package=Keycloak.AuthServices.Sdk&version=2.0.0-pre-2&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/.
Installation
dotnet add package Keycloak.AuthServices.Authentication
dotnet add package Keycloak.AuthServices.Authorization
dotnet add package Keycloak.AuthServices.Sdk
Getting Started
See the docs: https://nikiforovall.github.io/keycloak-authorization-services-dotnet/.
// 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
}
}
You can always fetch the corresponding authentication options like this:
var authenticationOptions = configuration
.GetSection(KeycloakAuthenticationOptions.Section)
.Get<KeycloakAuthenticationOptions>(KeycloakFormatBinder.Instance);
services.AddKeycloakAuthentication(authenticationOptions);
Note, the default case convention for KeycloakAuthenticationOptions
configuration is PascalCase, but you can change it by specifying KeycloakFormatBinder.Instance
binding options to retrieve it based on original kebab-case. See changes in 2.0.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 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
- IdentityModel.AspNetCore (>= 4.3.0)
- Keycloak.AuthServices.Common (>= 2.0.0-pre-2)
- Microsoft.AspNetCore.Authentication.JwtBearer (>= 6.0.29)
- Microsoft.AspNetCore.Http.Abstractions (>= 2.2.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Refit (>= 7.0.0)
- Refit.HttpClientFactory (>= 7.0.0)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on Keycloak.AuthServices.Sdk:
Package | Downloads |
---|---|
Gathrr.Framework.Infrastructure
Package Description |
|
Inspire.Framework.Infrastructure
Package Description |
|
Codehard.IdentityProvider.Keycloak
A client library for Codehard's Identity Provider with Keycloak as a provider. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.6.0 | 1,855 | 11/30/2024 |
2.5.5 | 691 | 11/27/2024 |
2.5.3 | 27,648 | 8/19/2024 |
2.5.2 | 10,664 | 6/15/2024 |
2.5.1 | 536 | 6/11/2024 |
2.5.0 | 8,368 | 6/2/2024 |
2.4.1 | 5,110 | 5/16/2024 |
2.4.0 | 742 | 5/12/2024 |
2.3.0 | 301 | 5/10/2024 |
2.3.0-pre-1 | 109 | 5/9/2024 |
2.2.1 | 368 | 5/9/2024 |
2.2.0 | 137 | 5/8/2024 |
2.1.0 | 180 | 5/7/2024 |
2.0.0 | 472 | 5/5/2024 |
2.0.0-pre-4 | 117 | 5/4/2024 |
2.0.0-pre-3 | 170 | 4/26/2024 |
2.0.0-pre-2 | 118 | 4/25/2024 |
2.0.0-pre-1 | 279 | 4/24/2024 |
1.6.0 | 90,917 | 10/25/2023 |
1.5.2 | 64,955 | 5/27/2023 |
1.5.1 | 49,432 | 1/17/2023 |
1.5.0 | 620 | 1/17/2023 |
1.4.1 | 1,015 | 1/12/2023 |
1.4.0 | 522 | 1/4/2023 |
1.3.0 | 1,087 | 12/28/2022 |
1.2.1 | 9,721 | 9/22/2022 |
1.2.0 | 725 | 8/24/2022 |
1.1.0 | 14,480 | 1/30/2022 |
1.0.5 | 146 | 1/29/2022 |
1.0.4 | 3,367 | 1/28/2022 |
1.0.3 | 138 | 1/28/2022 |
1.0.2 | 141 | 1/23/2022 |
1.0.1 | 577 | 1/19/2022 |
1.0.0 | 666 | 1/19/2022 |
The release notes are available at https://github.com/NikiforovAll/keycloak-authorization-services-dotnet/releases