# casbin-aspnetcore

**Repository Path**: anysharp/casbin-aspnetcore

## Basic Information

- **Project Name**: casbin-aspnetcore
- **Description**: Casbin.NET integration middleware and sample code for ASP.NET Core
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-24
- **Last Updated**: 2025-04-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Casbin.AspNetCore

[![Actions Status](https://github.com/casbin-net/casbin-aspnetcore/workflows/Build/badge.svg)](https://github.com/casbin-net/casbin-aspnetcore/actions)
[![Coverage Status](https://coveralls.io/repos/github/casbin-net/casbin-aspnetcore/badge.svg?branch=master)](https://coveralls.io/github/casbin-net/casbin-aspnetcore?branch=master)
[![License](https://img.shields.io/github/license/casbin-net/casbin-aspnetcore)](https://github.com/casbin-net/casbin-aspnetcore/blob/master/LICENSE)
[![Nuget](https://img.shields.io/nuget/v/Casbin.AspNetCore?label=Casbin.AspNetCore)](https://www.nuget.org/packages/Casbin.AspNetCore)

Casbin.AspNetCore is a [Casbin.NET](https://github.com/casbin/Casbin.NET) integration and extension for [ASP.NET Core](https://asp.net).

## Installation

This project is on developing, You can install the build version to try it.

```csharp
dotnet add package Casbin.AspNetCore --version <build package version>
```

Or you create a `NuGet.config` file on you solution directory like this.

```xml
<configuration>
  <packageSources>
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
  </packageSources>
</configuration>
```

## Quick Start
You should add the service at `ConfigureServices` method and add MiddleWare at `Configure` method like this:

```csharp
public void ConfigureServices(IServiceCollection services)
{
    // Other codes...

    //Add Casbin Authorization
    services.AddCasbinAuthorization(options =>
    {
        options.DefaultModelPath = "<model path>";
        options.DefaultPolicyPath = "<policy path>";
    });
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // Other codes...

    app.UseCasbinAuthorization();

    // You can add this to support offical authorization too.
    app.UseAuthorization();

    // Other codes...
}
```
Now you can use the attribute like offical authorization, If you use the Basic Model, It will like this:

```csharp
[CasbinAuthorize("<obj>", "<act>")]
public IActionResult Index()
{
    return View();
}
```

## How It Works

Here is a sequence chart that can well describe the process of this middleware. In the beginning, It looks like the process of official authorization middleware. It changes in the last half part.

![Sequence Chart of Middleware](https://raw.githubusercontent.com/casbin-net/casbin-aspnetcore/master/docs/assets/casbin-aspnetcore-sequence-chart.png)

## Samples
Sample applications using `Casbin.AspNetCore` can be found at [sample directory](https://github.com/casbin-net/casbin-aspnetcore/tree/master/samples).

## Migrate form v0.x to v1.x

1. Check the interfaces change:
- IEnforcerProvider
```csharp
public interface IEnforcerProvider
{
    // Before
    public Enforcer? GetEnforcer();
    // Now
    public IEnforcer? GetEnforcer();
}
```
- ICasbinModelProvider
```csharp
public interface ICasbinModelProvider
{
    // Before
    public Model? GetModel();
    // Now
    public IModel? GetModel();
}
```

## Getting Help
- [Casbin.NET](https://github.com/casbin/Casbin.NET)

## License
This project is under Apache 2.0 License. See the [LICENSE](LICENSE) file for the full license text.