Keycloak.AuthServices.Sdk
1.2.0
See the version list below for details.
dotnet add package Keycloak.AuthServices.Sdk --version 1.2.0
NuGet\Install-Package Keycloak.AuthServices.Sdk -Version 1.2.0
<PackageReference Include="Keycloak.AuthServices.Sdk" Version="1.2.0" />
paket add Keycloak.AuthServices.Sdk --version 1.2.0
#r "nuget: Keycloak.AuthServices.Sdk, 1.2.0"
// Install Keycloak.AuthServices.Sdk as a Cake Addin
#addin nuget:?package=Keycloak.AuthServices.Sdk&version=1.2.0
// Install Keycloak.AuthServices.Sdk as a Cake Tool
#tool nuget:?package=Keycloak.AuthServices.Sdk&version=1.2.0
Keycloak.AuthServices
Easy Authentication and Authorization with Keycloak in .NET and ASP.NET Core.
Example
Demonstrates how to add JWT-based authentication and custom authorization policy.
var builder = WebApplication.CreateBuilder(args);
var host = builder.Host;
var configuration = builder.Configuration;
var services = builder.Services;
host.ConfigureKeycloakConfigurationSource();
// conventional registration from keycloak.json
services.AddKeycloakAuthentication(configuration);
services.AddAuthorization(options =>
{
options.AddPolicy("RequireWorkspaces", builder =>
{
builder.RequireProtectedResource("workspaces", "workspaces:read") // HTTP request to Keycloak to check protected resource
.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()
.UseAuthorization();
app.MapGet("/workspaces", () => "[]")
.RequireAuthorization("RequireWorkspaces");
app.Run();
Keycloak.AuthServices.Authentication
Keycloak.AuthServices.Authentication
Add OpenID Connect + JWT Bearer token authentication.
// add configuration from keycloak file
host.ConfigureKeycloakConfigurationSource("keycloak.json");
// add authentication services, OICD JwtBearerDefaults.AuthenticationScheme
services.AddKeycloakAuthentication(configuration, o =>
{
o.RequireHttpsMetadata = false;
});
Client roles are automatically transformed into user role claims KeycloakRolesClaimsTransformation.
See Keycloak.AuthServices.Authentication - README.md
Keycloak installation file:
// confidential client
{
"realm": "<realm>",
"auth-server-url": "http://localhost:8088/auth/",
"ssl-required": "external", // external | none
"resource": "<clientId>",
"verify-token-audience": true,
"credentials": {
"secret": ""
}
}
// public client
{
"realm": "<realm>",
"auth-server-url": "http://localhost:8088/auth/",
"ssl-required": "external",
"resource": "<clientId>",
"public-client": true,
"confidential-port": 0
}
Keycloak.AuthServices.Authorization
Keycloak.AuthServices.Authorization
services.AddAuthorization(authOptions =>
{
authOptions.AddPolicy("<policyName>", policyBuilder =>
{
// configure policies here
});
}).AddKeycloakAuthorization(configuration);
See Keycloak.AuthServices.Authorization - README.md
Keycloak.AuthServices.Sdk
Keycloak API clients.
Service | Description |
---|---|
IKeycloakClient | Unified HTTP client - IKeycloakRealmClient, IKeycloakProtectedResourceClient |
IKeycloakRealmClient | Keycloak realm API |
IKeycloakProtectedResourceClient | Protected resource API |
IKeycloakProtectionClient | Authorization server API, used by AddKeycloakAuthorization |
// requires confidential client
services.AddKeycloakAdminHttpClient(keycloakOptions);
// based on token forwarding HttpClient middleware and IHttpContextAccessor
services.AddKeycloakProtectionHttpClient(keycloakOptions);
See Keycloak.AuthServices.Sdk - README.md
Build and Development
dotnet cake --target build
dotnet pack -o ./Artefacts
Reference
- https://github.com/thinktecture-labs/webinar-keycloak
- https://github.com/thinktecture-labs/webinar-keycloak-authorization
- https://github.com/elmankross/Jboss.AspNetCore.Authentication.Keycloak/
- https://github.com/mikemir/AspNetCore.KeycloakAuthentication/
- https://github.com/lvermeulen/Keycloak.Net
- https://github.com/keycloak/keycloak-documentation/blob/main/authorization_services/topics/service-authorization-uma-authz-process.adoc
- https://www.keycloak.org/docs/latest/authorization_services/index.html
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.1.2)
- Keycloak.AuthServices.Common (>= 1.2.0)
- Microsoft.AspNetCore.Authentication.JwtBearer (>= 6.0.1)
- Microsoft.AspNetCore.Http.Abstractions (>= 2.2.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 6.0.0)
- Refit (>= 6.1.15)
- Refit.HttpClientFactory (>= 6.1.15)
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 (1)
Showing the top 1 popular GitHub repositories that depend on Keycloak.AuthServices.Sdk:
Repository | Stars |
---|---|
NikiforovAll/keycloak-authorization-services-dotnet
Authentication and Authorization with Keycloak and ASP.NET Core 🔐
|
Version | Downloads | Last updated |
---|---|---|
2.4.0 | 30 | 5/12/2024 |
2.3.0 | 48 | 5/10/2024 |
2.3.0-pre-1 | 43 | 5/9/2024 |
2.2.1 | 59 | 5/9/2024 |
2.2.0 | 66 | 5/8/2024 |
2.1.0 | 98 | 5/7/2024 |
2.0.0 | 141 | 5/5/2024 |
2.0.0-pre-4 | 75 | 5/4/2024 |
2.0.0-pre-3 | 99 | 4/26/2024 |
2.0.0-pre-2 | 80 | 4/25/2024 |
2.0.0-pre-1 | 79 | 4/24/2024 |
1.6.0 | 40,699 | 10/25/2023 |
1.5.2 | 53,470 | 5/27/2023 |
1.5.1 | 44,083 | 1/17/2023 |
1.5.0 | 598 | 1/17/2023 |
1.4.1 | 991 | 1/12/2023 |
1.4.0 | 499 | 1/4/2023 |
1.3.0 | 1,064 | 12/28/2022 |
1.2.1 | 9,339 | 9/22/2022 |
1.2.0 | 693 | 8/24/2022 |
1.1.0 | 13,519 | 1/30/2022 |
1.0.5 | 127 | 1/29/2022 |
1.0.4 | 3,330 | 1/28/2022 |
1.0.3 | 114 | 1/28/2022 |
1.0.2 | 121 | 1/23/2022 |
1.0.1 | 539 | 1/19/2022 |
1.0.0 | 552 | 1/19/2022 |