当前位置：首页 > article >正文

使用 JWT 实现 .NET 应用的授权与鉴权

article 2024/11/5 13:10:07

使用 JWT 实现 .NET 应用的授权与鉴权

引言

在现代 Web 应用中，JWT（JSON Web Token）是一种流行的身份验证和授权机制。本篇博客将详细介绍如何在 .NET 应用中使用 JWT 来进行用户的登录、授权和鉴权。我们将创建一个简单的 ASP.NET Core Web API 项目，涵盖从用户输入登录名和密码到生成和验证 JWT 的全过程。代码示例将特别详细，确保每一步都清晰易懂。

环境准备

确保你已经安装以下工具：

.NET SDK（推荐使用 .NET 6 或更高版本）
Visual Studio 2022 或 Visual Studio Code

创建项目

新建项目：打开终端，执行以下命令创建一个新的 ASP.NET Core Web API 项目。
```
dotnet new webapi -n JwtAuthDemo
cd JwtAuthDemo
```
安装 NuGet 包：为了使用 JWT，我们需要安装 Microsoft.AspNetCore.Authentication.JwtBearer 包。
```
dotnet add package Microsoft.AspNetCore.Authentication.JwtBearer
```

配置 JWT

在 Program.cs 文件中进行 JWT 的配置。

using Microsoft.AspNetCore.Authentication.JwtBearer;
using Microsoft.IdentityModel.Tokens;
using System.Text;

var builder = WebApplication.CreateBuilder(args);

// 添加 JWT 认证服务
builder.Services.AddAuthentication(options =>
{
    options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
    options.DefaultChallengeScheme = JwtBearerDefaults.AuthenticationScheme;
})
.AddJwtBearer(options =>
{
    options.TokenValidationParameters = new TokenValidationParameters
    {
        ValidateIssuer = true,
        ValidateAudience = true,
        ValidateLifetime = true,
        ValidateIssuerSigningKey = true,
        ValidIssuer = builder.Configuration["Jwt:Issuer"],
        ValidAudience = builder.Configuration["Jwt:Audience"],
        IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(builder.Configuration["Jwt:Key"]))
    };
});

// 添加控制器服务
builder.Services.AddControllers();

var app = builder.Build();

// 使用认证中间件
app.UseAuthentication();
app.UseAuthorization();

app.MapControllers();

app.Run();

配置 JWT 相关信息

在 appsettings.json 文件中添加 JWT 配置项：

{
  "Jwt": {
    "Key": "YourSuperSecretKeyHere", 
    "Issuer": "JwtAuthDemo",
    "Audience": "JwtAuthDemoUsers"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*"
}

创建用户模型

在 Models 文件夹下创建一个 User.cs 文件：

namespace JwtAuthDemo.Models
{
    public class User
    {
        public string Username { get; set; }
        public string Password { get; set; }
    }
}

创建用户控制器

在 Controllers 文件夹下创建一个 AuthController.cs 文件：

using JwtAuthDemo.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.IdentityModel.Tokens;
using System.IdentityModel.Tokens.Jwt;
using System.Security.Claims;
using System.Text;

namespace JwtAuthDemo.Controllers
{
    [ApiController]
    [Route("api/[controller]")]
    public class AuthController : ControllerBase
    {
        private readonly IConfiguration _configuration;

        public AuthController(IConfiguration configuration)
        {
            _configuration = configuration;
        }

        [HttpPost("login")]
        public IActionResult Login([FromBody] User user)
        {
            // 这里应该有数据库验证用户的逻辑，这里仅为演示用
            if (user.Username != "test" || user.Password != "password")
            {
                return Unauthorized();
            }

            var token = GenerateJwtToken(user.Username);
            return Ok(new { token });
        }

        private string GenerateJwtToken(string username)
        {
            var claims = new[]
            {
                new Claim(JwtRegisteredClaimNames.Sub, username),
                new Claim(JwtRegisteredClaimNames.Jti, Guid.NewGuid().ToString())
            };

            var key = new SymmetricSecurityKey(Encoding.UTF8.GetBytes(_configuration["Jwt:Key"]));
            var creds = new SigningCredentials(key, SecurityAlgorithms.HmacSha256);

            var token = new JwtSecurityToken(
                issuer: _configuration["Jwt:Issuer"],
                audience: _configuration["Jwt:Audience"],
                claims: claims,
                expires: DateTime.Now.AddMinutes(30),
                signingCredentials: creds);

            return new JwtSecurityTokenHandler().WriteToken(token);
        }
    }
}

创建受保护的控制器

我们可以创建一个受保护的控制器来验证 JWT：

在 Controllers 文件夹下创建一个 ValuesController.cs 文件：

using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;

namespace JwtAuthDemo.Controllers
{
    [Authorize]
    [ApiController]
    [Route("api/[controller]")]
    public class ValuesController : ControllerBase
    {
        [HttpGet]
        public IActionResult GetValues()
        {
            return Ok(new string[] { "value1", "value2" });
        }
    }
}

运行应用

启动应用：在项目根目录下运行以下命令以启动应用：
```
dotnet run
```
测试登录功能：
- 使用 Postman 或其他 API 客户端，发送一个 POST 请求到 http://localhost:5000/api/auth/login，请求体为：
```
{
  "username": "test",
  "password": "password"
}
```
- 如果用户名和密码正确，你将获得一个 JWT token。
测试受保护的路由：
- 发送一个 GET 请求到 http://localhost:5000/api/values，并在请求头中添加 Authorization 字段：
```
Authorization: Bearer {your_token}
```
- 如果 token 有效，你将获得 ["value1", "value2"] 的响应。

代码解析

JWT 配置：
- 在 Program.cs 中配置了 JWT 的验证参数，包括签发者、受众以及签名密钥。
用户模型：
- 创建了一个简单的用户模型来接收登录信息。
授权控制器：
- AuthController 中的 Login 方法负责验证用户信息并生成 JWT token。
- GenerateJwtToken 方法负责创建 JWT，包含用户信息的声明（Claims）。
受保护的控制器：
- ValuesController 需要有效的 JWT 才能访问，利用 [Authorize] 特性进行保护。