https://github.com/HangfireIO/Hangfire.Dashboard.Authorization

Some authorization filters for Hangfire's Dashboard
https://github.com/HangfireIO/Hangfire.Dashboard.Authorization

Last synced: about 1 month ago
JSON representation

Some authorization filters for Hangfire's Dashboard

• Host: GitHub
• URL: https://github.com/HangfireIO/Hangfire.Dashboard.Authorization
• Owner: HangfireIO
• License: mit
• Created: 2014-06-30T18:51:28.000Z (about 10 years ago)
• Default Branch: main
• Last Pushed: 2024-03-22T09:39:29.000Z (6 months ago)
• Last Synced: 2024-07-03T05:13:20.525Z (3 months ago)
• Language: C#
• Size: 6.86 MB
• Stars: 140
• Watchers: 18
• Forks: 70
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Hangfire.Dashboard.Authorization

================================

Some authorization filters for Hangfire's Dashboard for .NET Framework-based ASP.NET Applications.

Installation

-------------

This library is available as a NuGet Package:

```powershell

Install-Package Hangfire.Dashboard.Authorization

```

Usage

------

All the available classes implement both `IAuthorizationFilter` and `IDashboardAuthorizationFilter` interfaces, and compatible with Hangfire.Core 1.6 and later.

## OWIN-based authentication

```csharp

using Hangfire.Dashboard;

public void Configure(IAppBuilder app)

{

    var options = new DashboardOptions

    {

        Authorization = new [] 

        {

            new AuthorizationFilter { Users = "admin, superuser", Roles = "advanced" },

            new ClaimsBasedAuthorizationFilter("name", "value")

        }

    };

    app.UseHangfireDashboard("/hangfire", options);

}

```

## Basic authentication

 *Note:* If you are using basic authentication together with OWIN security, configure Hangfire *BEFORE* OWIN security configuration.

 

Please, keep in mind, if you have no SSL-based instance for your web application you have to disable `SslRedirect` and `RequireSsl` options (it's enabled by default for security reasons). Otherwise you will have dead redirect.

```csharp

var filter = new BasicAuthAuthorizationFilter(

    new BasicAuthAuthorizationFilterOptions

    {

        // Require secure connection for dashboard

        RequireSsl = true,

        // Case sensitive login checking

        LoginCaseSensitive = true,

        // Users

        Users = new[]

        {

            new BasicAuthAuthorizationUser

            {

                Login = "Administrator-1",

                // Password as plain text, SHA1 will be used

                PasswordClear = "test"

            },

            new BasicAuthAuthorizationUser

            {

                Login = "Administrator-2",

                // Password as SHA1 hash

                Password = new byte[]{0xa9,

                    0x4a, 0x8f, 0xe5, 0xcc, 0xb1, 0x9b,

                    0xa6, 0x1c, 0x4c, 0x08, 0x73, 0xd3,

                    0x91, 0xe9, 0x87, 0x98, 0x2f, 0xbb,

                    0xd3}

            }

        }

});

```

It is also possible to use other than `SHA1` crypto provider by specifying it when creating a user:

```csharp

var user = new BasicAuthAuthorizationUser(HMAC.Create)

{

    Login = "Admin",

    PasswordClear = "Password" // HMAC will be used instead

}

```

### How to generate password hash

Just run this code:

```csharp

string password = "";

using (var cryptoProvider = System.Security.Cryptography.SHA1.Create())

{

    byte[] passwordHash = cryptoProvider.ComputeHash(Encoding.UTF8.GetBytes(password));

    string result = "new byte[] { " + 

        String.Join(",", passwordHash.Select(x => "0x" + x.ToString("x2")).ToArray())

         + " } ";

}

```

The `result` variable will contain byte array definition with your password.