Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wissance/authorization
An unofficial adapters to use KeyCloak as Authentication and Authorization server
https://github.com/wissance/authorization
aspnet-identity aspnetcore authentication jwt-authentication keycloak keycloak-authenticator keycloak-net keycloak-net-core oauth2 openidconnect
Last synced: 15 days ago
JSON representation
An unofficial adapters to use KeyCloak as Authentication and Authorization server
- Host: GitHub
- URL: https://github.com/wissance/authorization
- Owner: Wissance
- License: apache-2.0
- Created: 2021-10-26T13:26:20.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-11T14:01:35.000Z (about 1 year ago)
- Last Synced: 2024-12-06T03:29:46.595Z (26 days ago)
- Topics: aspnet-identity, aspnetcore, authentication, jwt-authentication, keycloak, keycloak-authenticator, keycloak-net, keycloak-net-core, oauth2, openidconnect
- Language: C#
- Homepage: https://wissance.github.io/Authorization/
- Size: 1.67 MB
- Stars: 6
- Watchers: 4
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wissance.Authorization Project
C# class library that helps to add authorization into **any** type of applycation (`Web`, `Desktop` and others easily). Supports `OpenId-Connect` `private` and `public` authentication using ***token* ** and ***authorization code*** flows in `KeyCloak`. Works with any version of `KeyCloak`, supporting old platforms (**netcore 3.1+**, **netstandard2.0+**).
## Functionality
* Easily integrate **KeyCloak as authorization server** into any application (`Web`, `Desktop` or `Console`)
* Protect **swagger with KeyCloak** Authorization
## Example of usage
### 1. Authentication & Authorization on Keycloak
don't forget to add this usage:
```csharp
using Wissance.Authorization.Config;
using Wissance.Authorization.Extensions;
```
In my Startup.cs i have _ConfigureService_ method that calls ConfigureWeb:
```csharp
public void ConfigureServices(IServiceCollection services)
{
// Configure subsystems before ...
ConfigureWeb(services);
// Configure subsystems after ...
}
// ...
private void ConfigureWeb(IServiceCollection services)
{
// ...
// Authorization, here we need only config which is very simple, see KeyCloakAuthenticator tests
KeyCloakServerConfig authConfig = BuildKeyCloakConfig();
services.AddKeyCloak(authConfig);
// ...
}
// don't forget to add Authentication & Authorization in Configure function, like this:
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// ...
app.UseAuthentication();
// app.UseHttpsRedirection();
app.UseRouting();
app.UseAuthorization();
app.UseEndpoints(endpoints => { endpoints.MapControllers(); });
//...
}
```
if you would like to just `Restrict` access to you controllers to only Autenticated users (without Claims check) your could add following (i suppose that Controllers configuretion is implemented in upper mentioned `ConfigureWeb(IServiceCollection services)` method:
```csharp
services.AddControllers(config =>
{
AuthorizationPolicy policy = new AuthorizationPolicyBuilder()
.RequireAuthenticatedUser()
.Build();
config.Filters.Add(new AuthorizeFilter(policy));
});
```
this requires to add a couple of using:
```csharp
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc.Authorization;
```
If you would like to use Role-based acces to controllers (we form Roles property (propper mapper have to be configured on a KeyCloak side)) use `[Authorize]` attribute on controllers, i.e.
```csharp
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Authorization;
[ApiController]
[Authorize(Roles = "user")]
public class MyController : ControllerBase
{
// ...
}
```
### 2. Use swagger under Authorization
See the structure of Startup class in part related to Keycloak, so to configure Swagger with Keycloak add following line to you `ConfigureWeb(IServiceCollection services` method:
```csharp
IDictionary scopes = _authConfig.Scopes.Select(s => s).ToDictionary(k => k, v => v);
Action generalOptionSwaggerConfigure = options =>
{
options.MapType(() => new OpenApiSchema
{
Type = "string",
Example = new OpenApiString("00:00:00")
});
};
services.AddSwaggerWithKeyCloakPasswordAuthentication(authConfig, generalOptionSwaggerConfigure, scopes);
```
and to `Configure(IApplicationBuilder app, IWebHostEnvironment env)` method:
```csharp
app.UseSwaggerWithKeyCloakAuthentication("Wissance.BusinessTools", BuildKeyCloakConfig(), _authConfig.Scopes);
```
`_authConfig.Scopes` is array of strings (public string[] Scopes { get; set; }), by default _**Keycloak**_ works with _**profile**_ scope.
var Scopes = new string[]{"profile"};
!!! DON'T forget to add * or your app base URI i.e. http://localhost:8421/* to **WebOrigin of Keycloak client settings** (subscribe to our medium because we are writing interesting articles and in particular about Authorization and Keycloak usage aspects: https://m-ushakov.medium.com/)
_Additional docs with images with examples will be soon_.
## Nuget package
https://www.nuget.org/packages/Wissance.Authorization/