.NET 实现 JWT 登录验证

.NET 实现 JWT 登录验证

在现代 Web 应用程序中，身份验证和授权是必不可少的功能。JSON Web Token (JWT) 是一种广泛使用的身份验证和授权机制，它可以用于安全地传输用户信息和授权数据。在本篇博文中，我们将学习如何在 C# .NET 中实现 JWT 登录验证，并处理用户信息的加密、刷新 Token、以及各种验证规则。
准备工作

在开始之前，我们需要在项目中安装以下 NuGet 包：

• Microsoft.AspNetCore.Authentication.JwtBearer：用于处理 JWT 认证
  
• Microsoft.IdentityModel.Tokens：用于处理 JWT Token
  可以通过 Visual Studio NuGet 包管理器或者通过命令行使用 dotnet add package 命令来安装这两个包。
  

创建 JwtAuthenticationManager 类

首先，我们需要创建一个 JwtAuthenticationManager 类，负责生成和验证 JWT Token。该类包含以下功能：

• 生成 JWT Token，包括用户信息的加密和过期时间的设置
  
• 验证 JWT Token，包括对 Token 的签名、过期时间等进行验证
  
• 刷新 Token，当 Token 过期时可以生成新的 Token
  
• 其他验证规则，例如验证 Token 的颁发者、受众等。
  

下面是 JwtAuthenticationManager 类的代码：

1. using System;
2. using System.Collections.Generic;
3. using System.IdentityModel.Tokens.Jwt;
4. using System.Security.Claims;
5. using System.Text;
6. using Microsoft.IdentityModel.Tokens;
8. public class JwtAuthenticationManager
9. {
10.         private readonly string _secretKey;
11.         private readonly string _issuer;
12.         private readonly string _audience;
13.         private readonly double _tokenLifetimeMinutes;
15.         public JwtAuthenticationManager(string secretKey, string issuer, string audience, double tokenLifetimeMinutes = 30)
16.         {
17.             _secretKey = secretKey;
18.             _issuer = issuer;
19.             _audience = audience;
20.             _tokenLifetimeMinutes = tokenLifetimeMinutes;
21.         }
23.         // 生成 JWT Token
24.         public string GenerateToken(Dictionary<string, string> userInfo)
25.         {
26.             var tokenHandler = new JwtSecurityTokenHandler();
27.             var key = Encoding.ASCII.GetBytes(_secretKey);
28.             var tokenDescriptor = new SecurityTokenDescriptor
29.             {
30.                 Subject = new ClaimsIdentity(new ClaimsIdentity(userInfo.Select(kvp => new Claim(kvp.Key, kvp.Value)))),
31.                 Expires = DateTime.UtcNow.AddMinutes(_tokenLifetimeMinutes),
32.                 Issuer = _issuer,
33.                 Audience = _audience,
34.                 SigningCredentials = new SigningCredentials(new SymmetricSecurityKey(key), SecurityAlgorithms.HmacSha256Signature)
35.             };
36.             var token = tokenHandler.CreateToken(tokenDescriptor);
37.             return tokenHandler.WriteToken(token);
38.         }
40.         // 验证 JWT Token
41.         public ClaimsPrincipal ValidateToken(string token)
42.         {
43.             var tokenHandler = new JwtSecurityTokenHandler();
44.             var key = Encoding.ASCII.GetBytes(_secretKey);
45.             var validationParameters = new TokenValidationParameters
46.             {
47.                 ValidateIssuer = true,
48.                 ValidateAudience = true,
49.                 ValidateIssuerSigningKey = true,
50.                 ValidIssuer = _issuer,
51.                 ValidAudience = _audience,
52.                 IssuerSigningKey = new SymmetricSecurityKey(key)
53.             };
54.             try
55.             {
56.                 var claimsPrincipal = tokenHandler.ValidateToken(token, validationParameters, out var validatedToken);
57.                 return claimsPrincipal;
58.             }
59.            catch (Exception ex)
60.            {
61.                 // 验证失败，返回 null
62.                 return null;
63.            }
64.         }
66.         // 刷新 Token
67.         public string RefreshToken(string token)
68.         {
69.             var tokenHandler = new JwtSecurityTokenHandler();
70.             var key = Encoding.ASCII.GetBytes(_secretKey);
71.             var validatedToken = tokenHandler.ReadToken(token) as JwtSecurityToken;
72.             var userInfo = new Dictionary<string, string>();
73.             foreach (var claim in validatedToken.Claims)
74.             {
75.                 userInfo.Add(claim.Type, claim.Value);
76.             }
77.             // 重新生成 Token，并返回
78.             return GenerateToken(userInfo);
79.         }
81.         // 其他验证规则，例如验证 Token 的颁发者、受众等
82.         public bool ValidateOtherRules(string token)
83.         {
84.             var tokenHandler = new JwtSecurityTokenHandler();
85.             var validatedToken = tokenHandler.ReadToken(token) as JwtSecurityToken;
86.             // 在这里添加其他验证规则的逻辑
87.             // 示例：验证 Token 的颁发者是否是指定的颁发者
88.             if (validatedToken.Issuer != _issuer)
89.             {
90.                 return false;
91.             }
92.             // 示例：验证 Token 的受众是否是指定的受众
93.             if (validatedToken.Audiences.All(a => a != _audience))
94.             {
95.                 return false;
96.             }
97.             // 其他验证规则...
98.             return true;
99.         }
100. }

复制代码

在 ASP.NET Core 中使用 JwtAuthenticationManager

在 ASP.NET Core 中使用 JwtAuthenticationManager 进行 JWT 登录验证的步骤如下：

• 在 Startup.cs 文件的 ConfigureServices 方法中添加 JWT 认证服务的配置：
  1. services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
  2.     .AddJwtBearer(options =>
  3.     {
  4.         options.TokenValidationParameters = new TokenValidationParameters
  5.         {
  6.             ValidateIssuer = true,
  7.             ValidateAudience = true,
  8.             ValidateIssuerSigningKey = true,
  9.             ValidIssuer = "your_issuer",
  10.             ValidAudience = "your_audience",
  11.             IssuerSigningKey = new SymmetricSecurityKey(Encoding.ASCII.GetBytes("your_secret_key"))
  12.         };
  13.     });

  复制代码
• 在 Startup.cs 文件的 Configure 方法中添加 JWT 认证中间件的配置：
  1. app.UseAuthentication();
  2. app.UseAuthorization();

  复制代码
• 在登录验证的逻辑中使用 JwtAuthenticationManager 类来生成和验证 JWT Token，示例如下：
  1. // 生成 Token
  2. var jwtManager = new JwtAuthenticationManager("your_secret_key", "your_issuer", "your_audience");
  3. var userInfo = new Dictionary<string, string>
  4. {
  5.     { "userId", "1" },
  6.     { "userName", "exampleuser" },
  7.     // 添加其他用户信息...
  8. };
  9. var token = jwtManager.GenerateToken(userInfo);
  11. // 验证 Token
  12. var claimsPrincipal = jwtManager.ValidateToken(token);
  13. if (claimsPrincipal == null)
  14. {
  15.     // Token 验证失败
  16.     // 处理验证失败的逻辑...
  17. }
  18. else
  19. {
  20.     // Token 验证成功
  21.     // 处理验证成功的逻辑...
  22. }
  24. // 刷新 Token
  25. var refreshedToken = jwtManager.RefreshToken(token);

  复制代码
• 在需要验证用户身份的地方，可以通过 HttpContext.User.Claims 来获取用户的声明信息，示例如下：
  1. var userId = HttpContext.User.Claims.FirstOrDefault(c => c.Type == "userId")?.Value;
  2. var userName = HttpContext.User.Claims.FirstOrDefault(c => c.Type == "userName")?.Value;
  3. // 处理获取到的用户声明信息...

  复制代码
• 在需要验证 Token 是否合法的地方，可以调用 JwtAuthenticationManager 类的 ValidateOtherRules 方法进行其他验证规则的验证，示例如下：
  1. var isTokenValid = jwtManager.ValidateOtherRules(token);
  2. if (isTokenValid)
  3. {
  4.     // Token 合法
  5.     // 处理合法 Token 的逻辑...
  6. }
  7. else
  8. {
  9.     // Token 非法
  10.     // 处理非法 Token 的逻辑...
  11. }

  复制代码

这样，就可以在 ASP.NET Core 中使用 JwtAuthenticationManager 类实现 JWT 登录验证，并处理用户信息的加密、刷新 Token、各种验证规则等功能。可以根据具体的业务需求，进一步定制化和扩展 JwtAuthenticationManager 类的功能，以满足项目的要求。
参考链接

• ASP.NET Core 官方文档
  
• JWT 官方文档
  
• ASP.NET Core 中使用 JWT 进行身份验证和授权
  
• ASP.NET Core 3.0 JWT 授权认证
  
• ASP.NET Core 中使用 JWT 进行身份验证和授权
  

总结

本篇博文通过一个简单的案例，介绍了如何使用 C# .NET 实现 JWT 登录验证，并处理用户信息的加密、刷新 Token、各种验证规则等功能。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！