v0.8 Alpha (#7)

* Support client v0.1.2

* Support client v0.2.0

* Update extension naming and replace docs

* Update github actions

.github/workflows/build.yml

@@ -11,12 +11,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Setup .NET 
-      uses: actions/setup-dotnet@v1
+      uses: actions/setup-dotnet@v3
       with:
-        dotnet-version: '6.0.x'
+        dotnet-version: '7.0.x'
 
     - name: Run build & test
       run: ./build.sh Test

.github/workflows/nuget-push.yml

@@ -8,12 +8,12 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup .NET Core
-        uses: actions/setup-dotnet@v1
+        uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '7.0.x'
 
       - name: Run Nuget Pack
         run: ./build.sh NugetPack

Package.Build.props

@@ -1,6 +1,6 @@
 <Project>
   <PropertyGroup>
-    <Version>0.7.0-alpha</Version>
+    <Version>0.8.0-alpha</Version>
     <Authors>Hawxy</Authors>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>

README.md

@@ -30,12 +30,14 @@ Ensure you have a Store ID, Client ID, and Client Secret ready from [How to get
 1. Add your `StoreId`, `ClientId` and `ClientSecret` to your application configuration, ideally via the [dotnet secrets manager](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-6.0&tabs=windows#enable-secret-storage).
 2. Add the following code to your ASP.NET Core services configuration:
 ```cs
-builder.Services.AddOpenFga(x =>
+builder.Services.AddOpenFgaClient(x =>
 {
     x.WithAuth0FgaDefaults(builder.Configuration["Auth0Fga:ClientId"], builder.Configuration["Auth0Fga:ClientSecret"]);
 
     x.StoreId = builder.Configuration["Auth0Fga:StoreId"];
 });
+
+builder.Services.AddOpenFgaMiddleware();
 ```
 
 The `WithAuth0FgaDefaults` extension will configure the relevant OpenFGA client settings to work with Auth0 FGA's US environment.
@@ -47,17 +49,19 @@ OpenFGA configuration is very similar to the [SDK Setup Guide](https://openfga.d
 1. Add the FGA `ApiScheme`, `ApiHost` & `StoreId` to your application configuration.
 2. Add the following code to your ASP.NET Core configuration:
 ```cs
-builder.Services.AddOpenFga(x =>
+builder.Services.AddOpenFgaClient(x =>
 {
     x.ApiScheme = builder.Configuration["Fga:ApiScheme"];
     x.ApiHost = builder.Configuration["Fga:ApiHost"];
     x.StoreId = builder.Configuration["Fga:StoreId"];
 });
+
+builder.Services.AddOpenFgaMiddleware();
 ```
 
 ### Authorization Policy Setup
 
-We'll need to setup our authorization middleware like so:
+We'll need to setup our authorization policy like so:
 
 ```cs
 builder.Services.AddAuthorization(options =>
@@ -105,12 +109,11 @@ If you want to use the built-in attributes, you need to configure how the user's
 The example below uses the Name, which should be suitable for most people (given the claim is mapped correctly).
 
 ```cs
-builder.Services.AddOpenFga(x =>
-{
-  //...
-}, config =>
+builder.Services.AddOpenFgaMiddleware(config =>
 {
     config.UserIdentityResolver = principal => principal.Identity!.Name!;
+    //If you're using DSL v1.1 it requires the user type to be included
+    //config.UserIdentityResolver = principal => $"user:{principal.Identity!.Name!}";
 });
 ```
 

build/_build.csproj

@@ -11,7 +11,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Nuke.Common" Version="6.2.1" />
+    <PackageReference Include="Nuke.Common" Version="6.3.0" />
   </ItemGroup>
 
 </Project>

samples/Fga.Example.AspNetCore/Fga.Example.AspNetCore.csproj

@@ -8,7 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="6.0.9" />
+    <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="6.0.10" />
   </ItemGroup>
 
   <ItemGroup>

samples/Fga.Example.AspNetCore/Program.cs

@@ -30,25 +30,27 @@
 
 
 // Auth0 FGA
-builder.Services.AddOpenFga(clientConfig =>
+builder.Services.AddOpenFgaClient(clientConfig =>
 {
-    clientConfig.WithAuth0FgaDefaults(builder.Configuration["Auth0Fga:ClientId"], builder.Configuration["Auth0Fga:ClientSecret"]);
+    clientConfig.WithAuth0FgaDefaults(builder.Configuration["Auth0Fga:ClientId"],
+        builder.Configuration["Auth0Fga:ClientSecret"]);
     clientConfig.StoreId = builder.Configuration["Auth0Fga:StoreId"];
-  
-}, middlewareConfig =>
-{
-    middlewareConfig.UserIdentityResolver = principal => principal.Identity!.Name!;
-});
 
+});
 
 // OpenFGA
-/*builder.Services.AddOpenFga(x =>
+/*builder.Services.AddOpenFgaClient(x =>
 {
     x.ApiScheme = builder.Configuration["Fga:ApiScheme"];
     x.ApiHost = builder.Configuration["Fga:ApiHost"];
     x.StoreId = builder.Configuration["Fga:StoreId"];
 });*/
 
+builder.Services.AddOpenFgaMiddleware(middlewareConfig =>
+{
+    middlewareConfig.UserIdentityResolver = principal => principal.Identity!.Name!;
+});
+
 builder.Services.AddAuthorization(options =>
 {
     options.AddPolicy(FgaAuthorizationDefaults.PolicyKey, 

src/Fga.Net.AspNetCore/Authorization/Attributes/FgaPropertyObjectAttribute.cs

@@ -35,14 +35,14 @@ public override ValueTask<string> GetRelation(HttpContext context)
     }
 
     /// <inheritdoc />
-    public override ValueTask<string> GetObject(HttpContext context)
+    public override async ValueTask<string> GetObject(HttpContext context)
     {
        context.Request.EnableBuffering();
-       using var document = JsonDocument.Parse(context.Request.Body);
+       using var document = await JsonDocument.ParseAsync(context.Request.Body, cancellationToken: context.RequestAborted);
        if (document.RootElement.TryGetProperty(_property, out var element))
        {
            context.Request.Body.Position = 0;
-           return ValueTask.FromResult(FormatObject(_type,element.GetString()!));
+           return FormatObject(_type,element.GetString()!);
        }
 
        throw new FgaMiddlewareException($"Unable to resolve JSON property {_property}");

src/Fga.Net.AspNetCore/Authorization/FineGrainedAuthorizationHandler.cs

@@ -81,7 +81,7 @@ protected override async Task HandleRequirementAsync(AuthorizationHandlerContext
                     }
                 }, httpContext.RequestAborted);
 
-                if (!result.Allowed)
+                if (result.Allowed is false)
                 {
                     _logger.CheckFailureDebug(user, relation, @object);
                     return;

src/Fga.Net.AspNetCore/Controllers/FgaControllerBase.cs

@@ -56,6 +56,6 @@ public async Task<bool> Check(string user, string relation, string @object, Canc
                 Object = @object
             }
         }, ct);
-        return checkRes.Allowed;
+        return checkRes.Allowed.HasValue && checkRes.Allowed.Value;
     }
 }

src/Fga.Net.AspNetCore/Fga.Net.AspNetCore.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>

src/Fga.Net.AspNetCore/ServiceCollectionExtensions.cs

@@ -36,6 +36,7 @@ public static class ServiceCollectionExtensions
     /// <param name="clientConfig">The delegate for the <see cref="FgaClientConfiguration"/> that will be used to configure the <see cref="OpenFgaApi"/></param>
     /// <param name="middlewareConfig">The delegate for the <see cref="FgaAspNetCoreConfiguration"/> that will be used to configure the underlying middleware</param>
     /// <returns>The service collection</returns>
+    [Obsolete("Replace with AddOpenFgaClient & AddOpenFgaMiddleware")]
     public static IServiceCollection AddOpenFga(this IServiceCollection collection, Action<FgaClientConfiguration> clientConfig, Action<FgaAspNetCoreConfiguration>? middlewareConfig = null)
     {
         ArgumentNullException.ThrowIfNull(clientConfig);
@@ -47,6 +48,21 @@ public static IServiceCollection AddOpenFga(this IServiceCollection collection,
         return collection;
     }
 
+    /// <summary>
+    /// Adds and configures an <see cref="FineGrainedAuthorizationHandler"/>
+    /// </summary>
+    /// <param name="collection">The service collection</param>
+    /// <param name="middlewareConfig">The delegate for the <see cref="FgaAspNetCoreConfiguration"/> that will be used to configure the underlying middleware</param>
+    /// <returns>The service collection</returns>
+    public static IServiceCollection AddOpenFgaMiddleware(this IServiceCollection collection, Action<FgaAspNetCoreConfiguration>? middlewareConfig = null)
+    {
+        if (middlewareConfig != null)
+            collection.Configure(middlewareConfig);
+        collection.AddScoped<IFgaCheckDecorator, FgaCheckDecorator>();
+        collection.AddScoped<IAuthorizationHandler, FineGrainedAuthorizationHandler>();
+        return collection;
+    }
+
     /// <summary>
     /// Adds a <see cref="FineGrainedAuthorizationRequirement"/> to the given policy.
     /// </summary>

src/Fga.Net/Fga.Net.DependencyInjection.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFrameworks>net6.0;net7.0</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>
@@ -14,7 +14,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Http" Version="6.0.0" />
     <PackageReference Include="DotNet.ReproducibleBuilds" Version="1.1.1" PrivateAssets="All" />
-    <PackageReference Include="OpenFga.Sdk" Version="0.1.0" />
+    <PackageReference Include="OpenFga.Sdk" Version="0.2.0" />
   </ItemGroup>
 
   <Import Project="../../Package.Build.props" />

tests/Fga.Net.Tests/Client/EndpointTests.cs

@@ -1,4 +1,5 @@
-using System.Linq;
+using System.Collections.Generic;
+using System.Linq;
 using System.Threading.Tasks;
 using Alba;
 using Microsoft.Extensions.DependencyInjection;
@@ -34,15 +35,15 @@ private async Task GetEndpoints_Return_200()
             var modelResponse = await client.ReadAuthorizationModel(modelId);
 
             Assert.NotNull(modelResponse);
-            Assert.NotNull(modelResponse.AuthorizationModel.Id);
+            Assert.NotNull(modelResponse.AuthorizationModel?.Id);
 
             var assertions = await client.ReadAssertions(modelId);
 
             Assert.NotNull(assertions);
             Assert.True(assertions.Assertions?.Count > 0);
             var assertion = assertions.Assertions!.First().TupleKey;
 
-            Assert.NotEmpty(assertion.Object!);
+            Assert.NotEmpty(assertion!.Object!);
             Assert.NotEmpty(assertion.Relation!);
             Assert.NotEmpty(assertion.User!);
 
@@ -58,6 +59,7 @@ private async Task GetEndpoints_Return_200()
             var watch = await client.ReadChanges();
             Assert.NotNull(watch);
 
+
         }
 
     }

tests/Fga.Net.Tests/Fga.Net.Tests.csproj

@@ -8,9 +8,9 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Alba" Version="6.1.0" />
-    <PackageReference Include="HttpContextMoq" Version="1.3.0" />
-    <PackageReference Include="Moq" Version="4.18.2" />
+    <PackageReference Include="Alba" Version="7.2.1" />
+    <PackageReference Include="HttpContextMoq" Version="1.4.0" />
+    <PackageReference Include="Moq" Version="4.18.4" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
     <PackageReference Include="xunit" Version="2.4.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">

tests/Fga.Net.Tests/Unit/ExtensionTests.cs

@@ -35,11 +35,13 @@ public void AspNetCoreServiceExtensions_RegisterCorrectly()
         {
             var collection = new ServiceCollection();
 
-            collection.AddOpenFga(x =>
+            collection.AddOpenFgaClient(x =>
             {
                 x.StoreId = Guid.NewGuid().ToString();
                 x.WithAuth0FgaDefaults(Guid.NewGuid().ToString(), Guid.NewGuid().ToString());
-            }, x =>
+            });
+
+            collection.AddOpenFgaMiddleware(x =>
             {
                 x.UserIdentityResolver = principal => principal.Identity!.Name!;
             });