From bf84d4a87ada08dca81d53ad6b08ed2f7fdcc3f3 Mon Sep 17 00:00:00 2001
From: Haiping Chen <haiping008@gmail.com>
Date: Sat, 19 Oct 2024 10:06:24 -0500
Subject: [PATCH] UserAuthenticated

---
 .../BotSharp.Abstraction.csproj               |  1 +
 .../Users/IAuthenticationHook.cs              | 49 ++++++++++++++++++-
 .../Users/Services/UserService.cs             |  2 +-
 3 files changed, 49 insertions(+), 3 deletions(-)

diff --git a/src/Infrastructure/BotSharp.Abstraction/BotSharp.Abstraction.csproj b/src/Infrastructure/BotSharp.Abstraction/BotSharp.Abstraction.csproj
index e94cf839..474dcf56 100644
--- a/src/Infrastructure/BotSharp.Abstraction/BotSharp.Abstraction.csproj
+++ b/src/Infrastructure/BotSharp.Abstraction/BotSharp.Abstraction.csproj
@@ -32,6 +32,7 @@
     <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="8.0.0" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
     <PackageReference Include="System.ComponentModel.Annotations" Version="5.0.0" />
+    <PackageReference Include="System.IdentityModel.Tokens.Jwt" Version="7.1.2" />
     <PackageReference Include="System.Memory.Data" Version="8.0.0" />
     <PackageReference Include="System.Text.Json" Version="8.0.5" />
     <PackageReference Include="Serilog.Sinks.Console" Version="5.0.1" />
diff --git a/src/Infrastructure/BotSharp.Abstraction/Users/IAuthenticationHook.cs b/src/Infrastructure/BotSharp.Abstraction/Users/IAuthenticationHook.cs
index afb0e40e..36b07f11 100644
--- a/src/Infrastructure/BotSharp.Abstraction/Users/IAuthenticationHook.cs
+++ b/src/Infrastructure/BotSharp.Abstraction/Users/IAuthenticationHook.cs
@@ -1,15 +1,60 @@
 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);
-    void AddClaims(List<Claim> claims);
-    void BeforeSending(Token token);
+
+    /// <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);
 }
diff --git a/src/Infrastructure/BotSharp.Core/Users/Services/UserService.cs b/src/Infrastructure/BotSharp.Core/Users/Services/UserService.cs
index 10dbe8de..5d08c51f 100644
--- a/src/Infrastructure/BotSharp.Core/Users/Services/UserService.cs
+++ b/src/Infrastructure/BotSharp.Core/Users/Services/UserService.cs
@@ -275,7 +275,7 @@ public class UserService : IUserService
 
         foreach (var hook in hooks)
         {
-            hook.BeforeSending(token);
+            hook.UserAuthenticated(jwt);
         }
 
         return token;