EngineBay.Authentication 2.4.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package EngineBay.Authentication --version 2.4.0
NuGet\Install-Package EngineBay.Authentication -Version 2.4.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="EngineBay.Authentication" Version="2.4.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add EngineBay.Authentication --version 2.4.0
#r "nuget: EngineBay.Authentication, 2.4.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 EngineBay.Authentication as a Cake Addin
#addin nuget:?package=EngineBay.Authentication&version=2.4.0

// Install EngineBay.Authentication as a Cake Tool
#tool nuget:?package=EngineBay.Authentication&version=2.4.0

EngineBay.Authentication

NuGet version Maintainability Test Coverage

Authentication module for EngineBay published to EngineBay.Authentication on NuGet.

About

Learn about Authentication and Authorization.

This module provides middleware and services for both authentication and authorization. The behaviour of the authentication depends heavily on your configuration options. The module can be configured to use JWT auth, Basic auth, and no auth. JWT is recommended. The latter two should only be used during local testing - not in a production environment.

Simple endpoints to register a user or get the current user are also provided.

This module also provides implementations of ICurrentIdentity, which can be used by modules such as EngineBay.Auditing, to get information about the current user from the HttpContext.

With the authorization middleware, you can specify authorization policies on endpoints to limit access to users with the appropriate permissions.

Usage

When this module is registered and configured, all endpoints will only allow authenticated users by default. To allow unauthenticated users to access an endpoint, you can use the .AllowAnonymous() method on the route builder. For an example, see AuthenticationModule.

To restrict access to endpoints to users with specific permissions, you can use .RequireAuthorization("Policy.Name") on the route builder. For an example, see AuditEntryEndpoint.

Registration

This module cannot run on its own. You will need to register it in your application to use its functionality. See the Demo API registration guide.

Since this module uses HttpContextAccessor in custom components, you will need to register it on the service collection for dependency injection. This can be done with the line builder.Services.AddHttpContextAccessor();, as seen here.

Environment Variables

See the Documentation Portal.

Dependencies

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.4.0 114 2/13/2024
2.3.0 115 2/12/2024
2.2.5 113 1/30/2024
2.2.4 114 1/18/2024
2.2.3 97 1/16/2024
2.2.2 112 1/10/2024
2.2.1 156 12/20/2023
2.2.0 191 12/7/2023
2.1.3 115 12/7/2023
2.1.2 105 12/7/2023
2.1.1 98 12/4/2023
2.1.0 91 11/30/2023
2.0.1 173 11/29/2023
2.0.0 147 11/23/2023
1.1.1 93 11/23/2023
1.1.0 221 11/15/2023
1.0.5 90 11/8/2023
1.0.4 325 11/3/2023
1.0.3 160 11/1/2023
1.0.2 283 10/26/2023
1.0.1 118 10/10/2023
1.0.0 519 9/28/2023
0.11.17 120 9/26/2023
0.11.16 145 9/24/2023
0.11.15 110 9/24/2023
0.11.14 95 9/22/2023
0.11.13 95 9/22/2023
0.11.12 111 9/22/2023
0.11.11 327 9/22/2023
0.11.10 138 9/22/2023
0.11.9 106 9/21/2023
0.11.8 400 6/2/2023
0.11.7 473 6/2/2023
0.11.6 296 4/8/2023
0.11.5 561 4/2/2023
0.11.4 217 4/2/2023
0.11.0 1,237 3/26/2023
0.10.1 254 3/26/2023
0.10.0 169 3/26/2023
0.9.0 240 3/26/2023
0.8.2 169 3/26/2023
0.8.1 581 3/26/2023
0.8.0 224 3/26/2023
0.7.0 187 3/26/2023
0.6.5 251 3/25/2023
0.6.3 260 3/25/2023
0.6.1 252 3/25/2023
0.6.0 243 3/25/2023
0.5.0 253 3/25/2023
0.4.4 193 3/25/2023
0.4.2 236 3/25/2023
0.4.0 253 3/25/2023
0.3.1 258 3/25/2023
0.3.0 240 3/25/2023
0.2.0 252 3/25/2023
0.1.1 195 3/25/2023
0.1.0 271 3/25/2023