EasyRefreshToken 5.2.0

EasyRefreshToken

Overview

EasyRefreshToken is a .NET library that provides an easy-to-use token service for refreshing access tokens in ASP.NET Core applications. It offers a flexible and customizable solution for managing refresh tokens, token expiration, preventing simultaneous logins, and more.

With EasyRefreshToken, you can integrate refresh token functionality into your ASP.NET Core applications without the need to write complex code or manage token-related logic manually. It simplifies the process of refreshing access tokens and ensures a secure and seamless user experience.

It support .Net5, .Net6, and .Net7

Features

• Automatic management of refresh tokens and token expiration.
• Flexible options for configuring token behavior, such as token expiration duration and preventing simultaneous logins.
• Determine the number of tokens for each user according to global limit, its type or one of its properties.
• Support for different storage mechanisms, including in-memory and Entity Framework Core.
• Customizable token generation methods.
• Integration with ASP.NET Core Identity.
• Lightweight and minimal dependencies.

Getting Started

Follow these steps to get started with EasyRefreshToken in your ASP.NET Core application:

1. Installation

Install the EasyRefreshToken package from NuGet by using the following command:

// In-Memory Refrsh Token 
dotnet add package EasyRefreshToken.InMemory

// EF Core Cache Refresh Token
dotnet add package EasyRefreshToken.EFCore

2. Configuration

In the ConfigureServices method of your Startup.cs / Program.cs file, add the EasyRefreshToken services and configure the options:

using EasyRefreshToken.InMemory;

// ...

// Add EasyRefreshToken services
builder.Services.AddInMemoryRefreshToken(options =>
{
    // Configure the options as needed
    options.TokenExpiredDays = 7;
    options.PreventingLoginWhenAccessToMaxNumberOfActiveDevices = true;
    // ...
});

// Other service configurations...

3. Usage

Make your TUser inherit from IUser:

public class User : IUser { }

Inject the ITokenService into your controller or service where you want to use the token service functionality:

using EasyRefreshToken;

// ...

private readonly ITokenService<string> _tokenService;

public MyRepository(ITokenService<string> tokenService)
{
    _tokenService = tokenService;
}

public async Task<LoginResponse> Login(LoginDto dto)
{
    // Login logic ...
   
    TokenResult result = await _tokenService.OnLoginAsync(userId);

    if (result.IsSucceeded)
    {
        // Return the new token to the client
    }
    else
    {
        // Handle the error
    }
}

4. Documentation

Common Documentation:

• You should make your TUser inherit from IUser.

• Use IUser<TKey> if the key of your User not string

• Use ITokenService<TKey> that contains:

  • Task<TokenResult> OnLoginAsync(TKey userId): Adds a new refresh token for the specified user upon login.
  • Task<bool> OnLogoutAsync(string token): Deletes a refresh token for the user that owns this token upon logout.
  • Task<TokenResult> OnAccessTokenExpiredAsync(TKey userId, string oldToken): Updates the refresh token for the specified user when the current access token has expired.
  • Task<string> OnChangePasswordAsync(TKey userId): This method should be called when changing the user's password.
  • Task<bool> ClearAsync(): Clears all token entities.
  • Task<bool> ClearExpiredAsync(): Clears expired token entities.
  • Task<bool> ClearAsync(TKey userId): Clears the token entities for the specified user.
  • Task<bool> ClearExpiredAsync(TKey userId): Clears the expired token entities for the specified user.

• Configure your service by options:

  • int? TokenExpiredDays:Sets the number of days until the token expires. If set to null, the token will never expire. Default value is 7 days.
  • bool PreventingLoginWhenAccessToMaxNumberOfActiveDevices: Sets a value indicating whether to prevent login operation when the maximum number of active devices is reached. If set to true and there is a valid token, login will be prevented. If set to false, the old token will be removed and a new token will be added. Default value is true.
  • Func<string> TokenGenerationMethod: Sets the method used for generating tokens.
  • OnChangePasswordBehavior OnChangePasswordBehavior: Sets the behavior of the OnChangePassword method. Default value is OnChangePasswordBehavior.DeleteAllTokens.
  • MaxNumberOfActiveDevices MaxNumberOfActiveDevices: Sets the maximum number of active devices per user type. If a type is not specified, the default value is int.MaxValue

MaxNumberOfActiveDevices

• Global Limit: MaxNumberOfActiveDevices.Configure(int.MaxValue)
• Limit Per Type: MaxNumberOfActiveDevices.Configure((typeof(Admin), 1), (typeof(Employee), 2))
• Limit Per Property: MaxNumberOfActiveDevices.Configure("UserType", (UserType.Admin, 1), (UserType.Employee, 2))

Notes

• You can specifies a life time of the Service (the default is Scoped).
• For MaxNumberOfActiveDevices use MaxNumberOfActiveDevices.Configure().
• Note: when change on options, I highly recommend cleaning the table by Clear

EF Core RefreshToken:

• Create your own class MyRefreshToken and add to it the properties you want and make it inherit from RefreshToken<TUser, TKey>

• If you do not want to add new features, you can skip the previous step.

• In AppDbContext Class: public DbSet<RefreshToken<TUser, TKey>> RefreshTokens { get; set; } or public DbSet<MyRefreshToken> RefreshTokens { get; set; }

• In Program Class: builder.Services.AddEFCoreRefreshToken<AppDbContext, RefreshToken<TUser, TKey>, TUser, TKey>(); or builder.Services.AddEFCoreRefreshToken<AppDbContext, MyRefreshToken, TUser, TKey>();

• You have an additional option bool SaveChanges: Sets a value indicating whether changes should be automatically saved to the database. The default value is true.

• Don't forget: Add-Migration Update-Database

In-Memory RefreshToken:

• In Program Class: builder.Services.AddInMemoryRefreshToken<TUser, TKey>();

• You have an additional option Func<IServiceProvider, TKey, TUser>? GetUserById: Sets a function to retrieve a user by their ID.

Warning!!: You must set Func<IServiceProvider, TKey, TUser>? GetUserById option, if you use LimitPerProperty or LimitPerType.

5. Contributing

Contributions to EasyRefreshToken are welcome and encouraged! If you find any bugs, issues, or have feature requests, please open a new issue on the GitHub repository. If you would like to contribute code, please fork the repository, make your changes, and submit a pull request.

6. License

EasyRefreshToken is licensed under the MIT License.