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

ASP.NET Core 中使用 Cookie 身份验证

article 2025/1/11 22:44:39

在 ASP.NET Core 中使用 Cookie 身份验证，通常是为了实现用户的登录和授权。以下是配置 Cookie 身份验证的步骤。

1. 安装必要的 NuGet 包

首先，确保项目中包含 Microsoft.AspNetCore.Authentication.Cookies 包。你可以通过 NuGet 包管理器或命令行安装它：

dotnet add package Microsoft.AspNetCore.Authentication.Cookies

2. 配置 Cookie 身份验证

在 ASP.NET Core 6 或更高版本中，配置通常发生在 Program.cs 中。以下是一个典型的配置过程：

在 `Program.cs` 中配置 Cookie 身份验证

using Microsoft.AspNetCore.Authentication.Cookies;
using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var builder = WebApplication.CreateBuilder(args);

// 添加身份验证服务
builder.Services.AddAuthentication(CookieAuthenticationDefaults.AuthenticationScheme)
    .AddCookie(options =>
    {
        // 设置登录页面路由
        options.LoginPath = "/Account/Login"; // 登录路径
        options.LogoutPath = "/Account/Logout"; // 登出路径
        options.AccessDeniedPath = "/Account/AccessDenied"; // 访问被拒绝路径

        // 设置 Cookie 的过期时间
        options.SlidingExpiration = true; // 启用滑动过期
        options.ExpireTimeSpan = TimeSpan.FromMinutes(30); // 设置过期时间

        // 可选的其他设置
        // options.Cookie.Name = "YourAppAuthCookie"; // 自定义 Cookie 名称
      // options.Cookie.HttpOnly = true; // 禁止 JavaScript 访问 Cookie
    // options.Cookie.SecurePolicy = CookieSecurePolicy.Always; // 强制 HTTPS 使用 Cookie
    });

builder.Services.AddAuthorization(); // 添加授权服务

builder.Services.AddControllersWithViews(); // 添加 MVC 或 Razor Pages 支持

var app = builder.Build();

// 使用身份验证中间件
app.UseAuthentication(); // 必须在 UseAuthorization 之前

// 使用授权中间件
app.UseAuthorization();

app.MapDefaultControllerRoute(); // 设置默认路由

app.Run();

3. 实现登录逻辑

你需要创建一个控制器来处理登录逻辑，并设置用户的身份验证 cookie。

登录控制器

using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Authentication.Cookies;
using Microsoft.AspNetCore.Mvc;
using System.Security.Claims;
using System.Threading.Tasks;

publicclassAccountController : Controller
{
    // 登录页面
    [HttpGet]
    public IActionResult Login()
    {
        return View();
    }

    // 处理登录请求
    [HttpPost]
    public async Task<IActionResult> Login(string username, string password)
    {
        // 这里进行用户名和密码的验证，假设验证成功
        if (username == "admin" && password == "password") // 示例验证逻辑
        {
            // 创建用户的身份信息
            var claims = new List<Claim>
            {
                new Claim(ClaimTypes.Name, username),
                new Claim(ClaimTypes.Role, "Admin") // 添加角色信息
            };

            var claimsIdentity = new ClaimsIdentity(claims, CookieAuthenticationDefaults.AuthenticationScheme);
            var authProperties = new AuthenticationProperties
            {
                IsPersistent = true, // 设置为 true 则用户在浏览器关闭后仍然保持登录状态
            };

            // 执行身份验证并设置 Cookie
            await HttpContext.SignInAsync(CookieAuthenticationDefaults.AuthenticationScheme, 
                new ClaimsPrincipal(claimsIdentity), authProperties);

            return RedirectToAction("Index", "Home"); // 登录成功后重定向到主页
        }

        ModelState.AddModelError(string.Empty, "Invalid login attempt.");
        return View();
    }

    // 登出逻辑
    [HttpPost]
    public async Task<IActionResult> Logout()
    {
        await HttpContext.SignOutAsync(CookieAuthenticationDefaults.AuthenticationScheme); // 清除身份验证信息
        return RedirectToAction("Login", "Account"); // 重定向到登录页面
    }
}

4. 创建登录页面视图

你还需要为登录页面创建一个简单的视图。例如，在 Views/Account/Login.cshtml 中：

@{
    ViewData["Title"] = "Login";
}

<h2>Login</h2>

<form method="post">
    <div>
        <label for="username">Username</label>
        <input type="text" id="username" name="username" required />
    </div>
    <div>
        <label for="password">Password</label>
        <input type="password" id="password" name="password" required />
    </div>
    <div>
        <button type="submit">Login</button>
    </div>
</form>

5. 授权和授权策略

为了限制某些页面只能被已登录用户访问，你可以在控制器或页面上使用 [Authorize] 特性。

示例：使用 `[Authorize]` 特性

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

[Authorize] // 确保只有已登录的用户能访问
public class HomeController : Controller
{
    public IActionResult Index()
    {
        return View();
    }
}