ViThor.Auth 0.3.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package ViThor.Auth --version 0.3.0                
NuGet\Install-Package ViThor.Auth -Version 0.3.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="ViThor.Auth" Version="0.3.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ViThor.Auth --version 0.3.0                
#r "nuget: ViThor.Auth, 0.3.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 ViThor.Auth as a Cake Addin
#addin nuget:?package=ViThor.Auth&version=0.3.0

// Install ViThor.Auth as a Cake Tool
#tool nuget:?package=ViThor.Auth&version=0.3.0                

ViThor Auth

A small package that adds Authentication and Authorization layer, based on Json Web Token (JWT), in your dotnet application.

Ready-made endpoints are available for:

  • User Registration
  • Login (get token)
  • Token Validation
  • Refresh Token

An email submission and validation service is also now available in this library.

Installation

Install the package from NuGet:

dotnet add package ViThor.Auth

Usage

Authentication

It is necessary to create a class that inherits from UserBase:

public class User : UserBase
{    
}

Next, you need to create a class that implements the IUserService interface. You can get a sample implementation in Samples/Vithor.Auth.Sample/Serives/UserService.cs.

Add the class that implements the IUserService to the Program.cs dependency injection service:

builder.Services.AddScoped<IUserService<User>, UserService>();

The remaining settings and services are built by running:

builder.BuildViThorSettings();

The parameterization of these services is done in appsettings:

{
    "JwtConfig": {
        "Secret": "This is my custom Secret key for authnetication",
        "Issuer": "http://localhost:5000",
        "Audience": "http://localhost:5000",
        "ExpirationType": "Minutes",
        "Expiration": 1,
        "ValidateIssuerSigningKey": true,
        "ValidateLifetime": true,
        "ValidateIssuer": false,
        "ValidateAudience": false,
        "RequireHttpsMetadata": false,
        "SaveToken": false
    }
}

Add AuthController to the API:

public class AuthController : AuthControllerBase<User>
{
    public AuthController(IJwtService jwtServices, IEmailService emailService, IUserService<User> userService, IOptions<ViThorAuthSettings> appSettings) : base(jwtServices, emailService, userService, appSettings)
    {
    }
}

E-mail

E-mail configuration is not required. That is, only if you are going to use the email sending service to validate the user registration, add the parameters below in appsettings:

{
    "BaseAddress": "http://localhost:5000",
    "SmtpConfig": {
        "Enabled": false,
        "Host": "smtp.gmail.com",
        "Port": 587,
        "UserName": "user@gmail.com",
        "Password": "password-here",
        "From": "user@gmail.com"
    }
}

Sample

The sample project is available in the repository. It is a simple dotnet web api project that uses the ViThor.Auth package.

Running the sample

Run the following command to run the sample API:

dotnet run --project ./Samples/Vithor.Auth.Sample/ViThor.Auth.Sample.csproj

Testing the sample

Swagger

The sample project has Swagger configured. To access it, run the API and access the following URL:

http://localhost:5000/swagger/index.html
Postman

The example project has a Postman collection that can be used to test endpoints. To use it, import the collections from the Postman folder into Postman and run the requests.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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
0.6.0 570 12/20/2022
0.5.0 507 12/20/2022
0.4.0 562 12/19/2022
0.3.0 592 12/19/2022
0.2.0 567 12/19/2022
0.1.0 835 12/18/2022