FastEndpoints项目中的JWT对称密钥配置问题解析

背景介绍

在ASP.NET Core 9中，使用FastEndpoints.Security.AuthExtensions.AddAuthenticationJwtBearer()方法配置JWT认证时，开发者可能会遇到HTTP 401未授权的问题，特别是在使用对称签名密钥的情况下。这个问题在.NET 8中并不存在，但在升级到.NET 9后开始出现。

问题本质

问题的核心在于FastEndpoints库处理对称签名密钥的方式。当开发者提供一个base64编码的字符串作为签名密钥时，库内部使用Encoding.ASCII.GetBytes()方法进行转换，这会导致数据丢失，因为ASCII编码只能处理0-127范围内的字符，超出范围的字符会被替换为0x3f。

技术细节分析

1. 对称密钥处理机制：

   • FastEndpoints期望对称密钥是原始ASCII字符串，而不是base64编码后的字符串
   • 当使用dotnet user-jwts工具生成本地令牌时，该工具会将密钥以base64格式存储

2. 版本差异：

   • 在.NET 8中，JwtSecurityTokenHandler 8.0.11会自动从配置中查找签名密钥
   • 在.NET 9中，JwtSecurityTokenHandler 9.0.0不再有这种行为，导致认证失败

3. 数据转换问题：

   • 使用ASCII.GetBytes()转换base64字符串会导致信息丢失
   • 正确的做法应该是使用Convert.FromBase64String()进行转换

解决方案

虽然直接修改FastEndpoints库的源代码可以解决问题，但这会破坏现有项目的兼容性。因此，官方建议采用以下替代方案：

1. 手动解码base64密钥：

   Encoding.UTF8.GetString(Convert.FromBase64String(builder.Configuration["..."]))
   

2. 自定义TokenValidationParameters：

   builder.Services
       .AddAuthenticationJwtBearer(signingOptions => { ... },
       bearerOptions =>
       {
           var key = new SymmetricSecurityKey(Convert.FromBase64String(base64SigningKey));
           bearerOptions.TokenValidationParameters.IssuerSigningKey = key;
       })
   

最佳实践建议

1. 在使用对称密钥时，避免直接将base64编码的字符串作为签名密钥
2. 如果需要使用dotnet user-jwts工具生成的密钥，务必先进行base64解码
3. 考虑使用非对称密钥方案，可以避免这类编码转换问题
4. 在升级到.NET 9时，特别注意JWT认证相关代码的兼容性测试

总结

这个问题揭示了在JWT认证配置中密钥处理方式的重要性。开发者需要清楚地了解所使用的工具和库对密钥格式的期望，特别是在跨版本升级时。FastEndpoints库保持现有行为是为了向后兼容，而开发者可以通过适当的密钥预处理或自定义配置来解决这个问题。