Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/madeyoga/authendpoints
A simple jwt library for Asp.Net 6 that provides a set of minimal api endpoints to handle authentication actions
https://github.com/madeyoga/authendpoints
2fa aspnetcore authentication authorization csharp dotnet6 httponly-cookie json-web-token jwt spa
Last synced: 17 days ago
JSON representation
A simple jwt library for Asp.Net 6 that provides a set of minimal api endpoints to handle authentication actions
- Host: GitHub
- URL: https://github.com/madeyoga/authendpoints
- Owner: madeyoga
- License: mit
- Created: 2022-04-16T15:40:25.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-14T12:18:48.000Z (about 1 year ago)
- Last Synced: 2024-04-27T11:29:28.268Z (7 months ago)
- Topics: 2fa, aspnetcore, authentication, authorization, csharp, dotnet6, httponly-cookie, json-web-token, jwt, spa
- Language: C#
- Homepage: https://madeyoga.github.io/AuthEndpoints/
- Size: 1.58 MB
- Stars: 122
- Watchers: 2
- Forks: 15
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# AuthEndpoints
[](https://www.nuget.org/packages/AuthEndpoints/)
[](https://github.com/madeyoga/AuthEndpoints/issues)
[](https://www.nuget.org/packages/AuthEndpoints/)
[](https://www.codefactor.io/repository/github/madeyoga/authendpoints)
[](https://github.com/madeyoga/AuthEndpoints/blob/main/LICENSE)
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](https://docs.microsoft.com/en-us/aspnet/core/security/authentication/customize-identity-model?view=aspnetcore-6.0#custom-user-data).
## 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](https://www.nuget.org/packages/AuthEndpoints.MinimalApi/)
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
```cs
// MyDbContext.cs
using AuthEndpoints.SimpleJwt.Core.Models;
public class MyDbContext : IdentityDbContext
{
public DbSet? RefreshTokens { get; set; } // <--
public MyDbContext(DbContextOptions 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();`
```cs
// Program.cs
// Required services
builder.Services.AddIdentityCore(); // <--
// Add core services & users api
builder.Services.AddAuthEndpointsCore() // <--
.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(); // <--
var app = builder.Build();
...
app.UseAuthentication(); // <--
app.UseAuthorization(); // <--
...
app.MapEndpoints(); // <--
app.Run();
```
## Documentations
Documentation is available at [https://madeyoga.github.io/AuthEndpoints/](https://madeyoga.github.io/AuthEndpoints/) and in [docs](https://github.com/madeyoga/AuthEndpoints/tree/main/docs) directory.
## Contributing
Your contributions are always welcome! simply send a pull request! The [up-for-grabs](https://github.com/madeyoga/AuthEndpoints/labels/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.