What is the .NET DevPack.Identity?

.NET DevPack Identity is a set of common implementations to help you implementing ASP.NET Identity, JWT, claims validation and another facilities

Give a Star! :star:

If you liked the project or if NetDevPack helped you, please give a star ;)

Get Started

| Package | Version | Popularity | | ------- | ----- | ----- | |

NetDevPack.Identity

.NET DevPack.Identity can be installed in your ASP.NET Core application using the Nuget package manager or the

dotnet

dotnet add package NetDevPack.Identity

If you want to use our IdentityDbContext (ASP.NET Identity standard) you will need to create the Identity tables. Set your connection string in the

appsettings.json

Add the IdentityDbContext configuration in your

startup.cs

services.AddIdentityEntityFrameworkContextConfiguration(options => 
    options.UseSqlServer(configuration.GetConnectionString("DefaultConnection"), 
    b=>b.MigrationsAssembly("AspNetCore.Jwt.Sample")));

Note: You must inform the namespace to avoid migration errors

Note: You must install the

Microsoft.EntityFrameworkCore.SqlServer

or another provider like

Npgsql.EntityFrameworkCore.PostgreSQL

package to have support from your database. Find the package for your database here

Add the Identity configuration in

ConfigureServices

startup.cs

services.AddIdentityConfiguration();

Note: This extension returns an IdentityBuilder to allow you extending the configuration

Add the Identity configuration in

Configure

startup.cs

app.UseAuthConfiguration();

Note: This method need to be set between

app.UseRouting()

and

app.UseEndpoints()

Run the command to generate the migration files:

dotnet ef migrations add Initial --context NetDevPackAppDbContext --project /.csproj

Run the command to generate the database:

dotnet ef database update --context NetDevPackAppDbContext --project /.csproj

Note: If are you using your own

IdentityDbContext

you must change the

NetDevPackAppDbContext

value to your context class name in the commands above.

After execute this steps you will be all set to use the Identity in your Application.

Configuring JWT

If you want to generate JSON Web Tokens in your application you need to add the JWT configuration in

ConfigureServices

startup.cs

csharp
services.AddJwtConfiguration(Configuration, "AppSettings");

Note: If you don't inform the configuration name the value adopted will be AppJwtSettings

Set your

appsettings.json

"AppSettings": {
    "SecretKey": "MYSECRETSUPERSECRET",
    "Expiration": 2,
    "Issuer": "SampleApp",
    "Audience": "https://localhost"
}

|Key|Meaning| |--|--| |SecretKey | Is your key to build JWT. This value need to be stored in a safe place in the production way | |Expiration| Expiration time in hours | |Issuer| The name of the JWT issuer | |Audience| The domain that the JWT will be valid. Can be a string collection |

Generating JWT

You will need to set some dependencies in your Authentication Controller:

private readonly SignInManager _signInManager;
private readonly UserManager _userManager;
private readonly AppJwtSettings _appJwtSettings;

public AuthController(SignInManager signInManager,
              UserManager userManager,
              IOptions appJwtSettings)
{
    _signInManager = signInManager;
    _userManager = userManager;
    _appJwtSettings = appJwtSettings.Value;
}

Note: The AppJwtSettings is our dependency and is configured internally during JWT setup (in

startup.cs

file). You just need to inject it in your controller.

Note: The SignInManager and UserManager classes is native from Identity and provided in NetDevPack.Identity. You just need to inject it in your controller.

After user register or login process you can generate a JWT to respond the request. Use our implementation, you just need inform the user email and the dependencies injected in your controller:

return new JwtBuilder()
    .WithUserManager(_userManager)
    .WithJwtSettings(_appJwtSettings)
    .WithEmail(email)
    .BuildToken();

Note: This builder can return a single string with JWT or a complex object

UserResponse

if you want return more data than a single JWT string.

Adding Claims to your JWT

You can call more methods in

JwtBuilder

return new JwtBuilder()
    .WithUserManager(_userManager)
    .WithJwtSettings(_appJwtSettings)
    .WithEmail(email)
    .WithJwtClaims()
    .WithUserClaims()
    .WithUserRoles()
    .BuildToken();

|Method|Meaning| |--|--| |WithJwtClaims()| Claims of JWT like

sub

jti

nbf

AspNetUserClaims

AspNetUserRoles

If you want return your complex object

UserResponse

return new JwtBuilder()
    .WithUserManager(_userManager)
    .WithJwtSettings(_appJwtSettings)
    .WithEmail(email)
    .WithJwtClaims()
    .WithUserClaims()
    .WithUserRoles()
    .BuildUserResponse() as UserResponse;

Note: The safe cast to

UserResponse

is needed because is a subtype of

UserResponse

.

Examples

Use the sample application to understand how NetDevPack.Identity can be implemented and help you to decrease the complexity of your application and development time.

Compatibility

The NetDevPack.Identity was developed to be implemented in ASP.NET Core 3.1

LTS

LTS

About

.NET DevPack.Identity was developed by Eduardo Pires under the MIT license.