Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikiforovall/keycloak-authorization-services-dotnet
Authentication and Authorization with Keycloak and ASP.NET Core 🔐
https://github.com/nikiforovall/keycloak-authorization-services-dotnet
auth authentication authorization authserver authz dotnet idp jwt jwt-authentication keycloak oidc
Last synced: 14 days ago
JSON representation
Authentication and Authorization with Keycloak and ASP.NET Core 🔐
- Host: GitHub
- URL: https://github.com/nikiforovall/keycloak-authorization-services-dotnet
- Owner: NikiforovAll
- License: mit
- Created: 2022-01-15T12:00:53.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-26T18:43:32.000Z (about 2 months ago)
- Last Synced: 2024-10-10T19:39:51.534Z (about 1 month ago)
- Topics: auth, authentication, authorization, authserver, authz, dotnet, idp, jwt, jwt-authentication, keycloak, oidc
- Language: C#
- Homepage: https://nikiforovall.github.io/keycloak-authorization-services-dotnet/
- Size: 3.36 MB
- Stars: 461
- Watchers: 14
- Forks: 110
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Keycloak.AuthServices
[](https://discord.gg/S449PhBPRQ)
[](https://github.com/NikiforovAll/keycloak-authorization-services-dotnet/actions/workflows/build.yml)
[](https://github.com/NikiforovAll/keycloak-authorization-services-dotnet/actions/workflows/codeql-analysis.yml)
[](https://nuget.org/packages/Keycloak.AuthServices.Authentication)
[](https://github.com/nikiforovall/keycloak-authorization-services-dotnet)
[](https://conventionalcommits.org)
[](https://github.com/nikiforovall/keycloak-authorization-services-dotnet/blob/main/LICENSE.md)
Easy Authentication and Authorization with Keycloak in .NET.
| Package | Version | Description |
| -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| `Keycloak.AuthServices.Authentication` | [](https://nuget.org/packages/Keycloak.AuthServices.Authentication) | Keycloak Authentication JWT + OICD |
| `Keycloak.AuthServices.Authorization` | [](https://nuget.org/packages/Keycloak.AuthServices.Authorization) | Authorization Services. Use Keycloak as authorization server |
| `Keycloak.AuthServices.Sdk` | [](https://nuget.org/packages/Keycloak.AuthServices.Sdk) | HTTP API integration with Keycloak |
| `Keycloak.AuthServices.Sdk.Kiota` | [](https://nuget.org/packages/Keycloak.AuthServices.Sdk.Kiota) | HTTP API integration with Keycloak based on OpenAPI |
| `Keycloak.AuthServices.OpenTelemetry` | [](https://nuget.org/packages/Keycloak.AuthServices.OpenTelemetry) | OpenTelemetry support |
| `Keycloak.AuthServices.Templates` | [](https://nuget.org/packages/Keycloak.AuthServices.Templates) | `dotnet new` templates |
[](https://github.com/NikiforovAll/keycloak-authorization-services-dotnet/actions)
## Documentation
For Developer Documentation see:
### API Reference
See:
## Getting Started
Install packages:
```bash
dotnet add package Keycloak.AuthServices.Authentication
dotnet add package Keycloak.AuthServices.Common
```
```csharp
// 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`.
```jsonc
//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.
```csharp
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
```csharp
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();
var realm = await client.GetRealmAsync("Test");
```
## Build and Development
`dotnet cake --target build`
`dotnet cake --target test`
`dotnet pack -o ./Artefacts`