This article demonstrates how the Hangfire dashboard can be set up in an ASP .NET 5 application including authentication via ASP .NET Identity.
Adding Hangfire Packages
project.json:
|
1 2 3 4 5 6 |
"dependencies": { ... "Hangfire.SqlServer": "1.5.3", "Hangfire": "1.5.3", ... }, |
Since I am using Hangfire with SQL, I have to add Hangfire itself and Hangfire.SqlServer to the project.json.
Configuring Hangfire Dashboard
In order to be able to use the Hangfire dashboard we have to configure it in the Configure method in Startup.cs.
|
1 2 3 4 5 6 7 8 9 |
public void Configure(..., IHttpContextAccessor contextAccessor) { ... app.UseHangfireDashboard("/Hangfire", new DashboardOptions { AuthorizationFilters = new[] { new HangfireAuthorizationFilter(contextAccessor) } }); ... } |
First we are defining under which URL Hangfire will be available, secondly we add a new Authorization Filter to Hangfire in order to authenticate users using ASP .NET Identity. Therefore we use an IHttpContextAccessor in the constructor of the filter in order to get access to authentication information. The parameter contextAccessor can simply be added to the method and will automatically be injected by the ASP .NET Dependency Injection.
The filter provided below, will simply check if the person accessing the Hangfire dashboard is authenticated.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 |
public class HangfireAuthorizationFilter : IAuthorizationFilter { private readonly IHttpContextAccessor _contextAccessor; public HangfireAuthorizationFilter(IHttpContextAccessor contextAccessor) { _contextAccessor = contextAccessor; } public bool Authorize(IDictionary<string, object> owinEnvironment) { return _contextAccessor.HttpContext.User.Identity.IsAuthenticated; } } |
Of course you could also check for claims and roles in the Authorize method.
Summary
This article demonstrates how to add the Hangfire dashboard to an ASP .NET 5 application with authentication using ASP .NET Identity.