BotSharp/src/Infrastructure/BotSharp.Abstraction/Users/IAuthenticationHook.cs

using BotSharp.Abstraction.Users.Models;
using System.IdentityModel.Tokens.Jwt;
using System.Security.Claims;

namespace BotSharp.Abstraction.Users;

public interface IAuthenticationHook
{
    /// <summary>
    /// Interupt the authentication process, and return the user object if the user is authenticated
    /// </summary>
    /// <param name="id"></param>
    /// <param name="password"></param>
    /// <returns></returns>
    Task<User> Authenticate(string id, string password);

    /// <summary>
    /// Add extra claims to user
    /// </summary>
    /// <param name="claims"></param>
    /// <returns></returns>
    bool AddClaims(List<Claim> claims)
        => true;

    /// <summary>
    /// User authenticated successfully
    /// </summary>
    /// <param name="token"></param>
    /// <returns></returns>
    bool UserAuthenticated(JwtSecurityToken token)
        => true;

    /// <summary>
    /// Bfore user updating
    /// </summary>
    /// <param name="user"></param>
    /// <returns></returns>
    Task UserUpdating(User user);

    /// <summary>
    /// After user created
    /// </summary>
    /// <param name="user"></param>
    /// <returns></returns>
    Task UserCreated(User user);

    /// <summary>
    /// Reset password
    /// </summary>
    /// <param name="user"></param>
    /// <returns></returns>
    Task VerificationCodeResetPassword(User user);

    /// <summary>
    /// Delete users
    /// </summary>
    /// <param name="userIds"></param>
    /// <returns></returns>
    Task DelUsers(List<string> userIds);
}