Minimal Api

AuthEndpoints

A simple jwt authentication library for ASP.Net 6. AuthEndpoints library provides a set of minimal api endpoints to handle basic web & JWT authentication actions such as registration, email verification, reset password, create jwt, etc. It works with custom identity user model.

Supported endpoints

Users API:
- sign-up
- email verification
- user profile (retrieving)
- reset password
- change password
- enable 2fa
- login 2fa
TokenAuth:
- Create (login)
- Destroy (logout)
Simple JWT:
- Create (login)
- Refresh
- Verify

Current limitations

Only works with IdentityUser & EfCore
2fa via email

Installing via NuGet

The easiest way to install AuthEndpoints is via NuGet

Install the library using the following .net cli command:

dotnet add package AuthEndpoints

or in Visual Studio's Package Manager Console, enter the following command:

Install-Package AuthEndpoints

Quick start

// MyDbContext.cs


using AuthEndpoints.SimpleJwt.Core.Models;

public class MyDbContext : IdentityDbContext
{
  public DbSet<RefreshToken>? RefreshTokens { get; set; } // <--
  public MyDbContext(DbContextOptions<MyDbContext> options) : base(options) { }
}

Add migration and apply migration:

// using dotnet cli
$ dotnet ef migrations add CreateRefreshToken
$ dotnet ef database update

// or using package manager console in visual studio
PM> Add-Migration CreateRefreshToken
PM> Update-Database

Add endpoints and call app.MapEndpoints() before app.Run();

// Program.cs


// Required services
builder.Services.AddIdentityCore<IdentityUser>(); // <--

// Add core services & users api
builder.Services.AddAuthEndpointsCore<IdentityUser, MyDbContext>() // <--
                .AddUsersApiEndpoints()
                .Add2FAEndpoints();

// Add jwt endpoints
// When no options are provided
// AuthEndpoints will create a secret key and use a single security key (symmetric encryption)
// for each access jwt and refresh jwt.
// Secrets will be created under `keys/` directory.
builder.Services.AddSimpleJwtEndpoints<IdentityUser, MyDbContext>(); // <--

var app = builder.Build();

...

app.UseAuthentication(); // <--
app.UseAuthorization(); // <--

...

app.MapEndpoints(); // <--

app.Run();

Documentations

Documentation is available at https://madeyoga.github.io/AuthEndpoints/ and in docs directory.

Contributing

Your contributions are always welcome! simply send a pull request! The up-for-grabs label is a great place to start. If you find a flaw, please open an issue or a PR and let's sort things out.

The project is far from perfect so every bit of help is more than welcome.

	public void PostConfigure(string name, AuthEndpointsOptions options)
	{
	var accessOptions = options.AccessSigningOptions!;
	if (accessOptions.Algorithm!.StartsWith("HS"))
	{
	if (options.AccessValidationParameters == null)
	{
	options.AccessValidationParameters = new TokenValidationParameters()
	{
	IssuerSigningKey = accessOptions.SigningKey,
	ValidIssuer = options.Issuer,
	ValidAudience = options.Audience,
	ValidateIssuerSigningKey = true,
	ClockSkew = TimeSpan.Zero,
	};
	}
	else
	{
	options.AccessValidationParameters.IssuerSigningKey = accessOptions.SigningKey;
	}
	}

	var refreshOptions = options.RefreshSigningOptions!;
	if (refreshOptions.Algorithm!.StartsWith("HS"))
	{
	if (options.RefreshValidationParameters == null)
	{
	options.RefreshValidationParameters = new TokenValidationParameters()
	{
	IssuerSigningKey = refreshOptions.SigningKey,
	ValidIssuer = options.Issuer,
	ValidAudience = options.Audience,
	ValidateIssuerSigningKey = true,
	ClockSkew = TimeSpan.Zero,
	};
	}
	else
	{
	options.RefreshValidationParameters.IssuerSigningKey = refreshOptions.SigningKey;
	}
	}
	}

	public string GenerateRefreshToken(TUser user)
	{
	JwtSigningOptions signingOptions = _options.RefreshSigningOptions!;
	var credentials = new SigningCredentials(signingOptions.SigningKey, signingOptions.Algorithm);
	var header = new JwtHeader(credentials);
	var payload = new JwtPayload(
	_options.Issuer!,
	_options.Audience!,
	_claimsProvider.provideRefreshClaims(user),
	DateTime.UtcNow,
	DateTime.UtcNow.AddMinutes(signingOptions.ExpirationMinutes)
	);
	return _tokenHandler.WriteToken(new JwtSecurityToken(header, payload));
	}

	public virtual async Task<IResult> Refresh([FromBody] RefreshRequest request,
	IJwtValidator jwtValidator,
	IOptions<AuthEndpointsOptions> options,
	UserManager<TUser> userManager,
	IAuthenticator<TUser> authenticator)
	{
	bool isValidRefreshToken = jwtValidator.Validate(request.RefreshToken!,
	options.Value.RefreshValidationParameters!);

	if (!isValidRefreshToken)
	{
	// Token may be expired, invalid, etc. but this good enough for now.
	return Results.BadRequest(new ErrorResponse("Invalid refresh token. Token may be expired or invalid."));
	}

madeyoga / authendpoints Goto Github PK

authendpoints's Introduction

AuthEndpoints

Supported endpoints

Current limitations

Installing via NuGet

Quick start

Documentations

Contributing

authendpoints's People

Contributors

Stargazers

Watchers

Forkers

authendpoints's Issues

Password

Todo

Recommend Projects

Recommend Topics

Recommend Org