DarkLoop.Azure.Functions.Authorization.Isolated 4.1.0

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package DarkLoop.Azure.Functions.Authorization.Isolated --version 4.1.0                
NuGet\Install-Package DarkLoop.Azure.Functions.Authorization.Isolated -Version 4.1.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DarkLoop.Azure.Functions.Authorization.Isolated" Version="4.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DarkLoop.Azure.Functions.Authorization.Isolated --version 4.1.0                
#r "nuget: DarkLoop.Azure.Functions.Authorization.Isolated, 4.1.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install DarkLoop.Azure.Functions.Authorization.Isolated as a Cake Addin
#addin nuget:?package=DarkLoop.Azure.Functions.Authorization.Isolated&version=4.1.0

// Install DarkLoop.Azure.Functions.Authorization.Isolated as a Cake Tool
#tool nuget:?package=DarkLoop.Azure.Functions.Authorization.Isolated&version=4.1.0                

functions-authorization-isolated

Bringing AuthorizeAttribute Behavior to Azure Functions v4 in Isolated mode.

It hooks into .NET Core dependency injection container to enable authentication and authorization in the same way ASP.NET Core does.

Breaking for current package consumers

Starting with version 4.1.0, due to security changes made on the Functions runtime, the Bearer scheme is no longer supported for your app functions.

Use AddJwtFunctionsBearer(Action<JwtBearerOptions>) instead of AddJwtBearer(Action<JwtBearerOptions>) when setting up authentication. Using AddJwtBearer will generate a compilation error when used against FunctionsAuthenticationBuilder. We are introducing JwtFunctionsBearerDefaults to refer to the suggested new custom scheme name.

No changes should be required if already using a custom scheme name.

Using the package

Installing the package

dotnet add package DarkLoop.Azure.Functions.Authorization.Isolated

Setting up authentication and authorization

The goal is to utilize the same authentication framework provided for ASP.NET Core

using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var host = new HostBuilder()
    .ConfigureFunctionsWebAppliction(builder =>
    {
        // Explicitly adding the extension middleware because
        // registering middleware when extension is loaded does not
        // place the middleware in the pipeline where required request
        // information is available.
        builder.UseFunctionsAuthorization();
    })
    .ConfigureServices(services =>
    {
        services
            .AddFunctionsAuthentication(JwtBearerDefaults.AuthenticationScheme)
            // This is important as Bearer scheme is used by the runtime
            // and no longer supported by this framework.
            .AddJwtFunctionsBearer(options =>
            {
                options.Authority = "https://login.microsoftonline.com/your-tenant-id";
                options.Audience = "your-app-id-uri";
                ...
            });

        services.AddFunctionsAuthorization(options =>
        {
            options.AddPolicy("OnlyAdmins", policy => policy.RequireRole("Admin"));
        });

        // Add other services
    })
    .Build();

host.Run();

Starting with version 4.1.0, the default Bearer scheme is not supported by this framework. You can use a custom scheme or make use of AddJwtFunctionsBearer(Action<JwtBearerOptions>) as shown above. This one adds the "FunctionsBearer" scheme. Clients still submit token for Authorization header in the format: Bearer <token>.

Notice the call to UseFunctionsAuthorization in the ConfigureFunctionsWebAppliction method. This is required to ensure that the middleware is placed in the pipeline where required function information is available.`

Using the attribute

And now lets use FunctionAuthorizeAttribute the same way we use AuthorizeAttribute in our ASP.NET Core applications.

[FunctionAuthorize]
public class Functions
{
  [FunctionName("get-record")]
  public async Task<IActionResult> GetRecord(
    [HttpTrigger("get")] HttpRequest req, ILogger log)
  {
    var user = req.HttpContext.User;
    var record = GetUserData(user.Identity.Name);
    return new OkObjectResult(record);
  }

  [Authorize(Policy = "OnlyAdmins")]
  [FunctionName("get-all-records")]
  public async Task<IActionResult> GetAllRecords(
    [HttpTrigger("get")] HttpRequest req, ILogger log)
  {
    var records = GetAllData();
    return new OkObjectResult(records);
  }
}

Something really nice to notice is that for Functions in Isolated mode, the HttpTriggerAttribute default AuthenticationLevel is Anonymous, playing really well with the attribute.<br/> Also notice how the second function uses the AuthorizeAttribute attribute to apply a policy to the function. FunctionAuthorizeAttribute was left as part of the framework only to make it easier to migrate from In-Proc to Isolated, but they can be used interchangeably.

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on DarkLoop.Azure.Functions.Authorization.Isolated:

Package Downloads
Snokam.Middleware

Package Description

Snokam.Api

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.1.1-preview-240719-1 62 7/19/2024
4.1.0 3,041 5/27/2024
4.1.0-preview-240522-2 138 5/22/2024
4.1.0-preview-240522-1 71 5/22/2024
4.1.0-preview-240521-1 70 5/21/2024
4.0.1 5,537 3/19/2024
4.0.0 125 3/19/2024
4.0.0-preview-240319-1 62 3/19/2024
4.0.0-preview-240311-16 382 3/11/2024
4.0.0-preview-240304-38 77 3/4/2024