在无状态 ASP.NET Core 8 Web API 中实现 CSRF 令牌,无需 Views/MVC!

如果您喜欢此文章,请收藏、点赞、评论,谢谢,祝您快乐每一天。

之所以要写这篇文章,是因为找不到其他好的教程。看到的搜索结果全是关于服务器端渲染视图的。所以花了数个小时在网上搜索,学习了 CSRF 令牌、cookie 以及所有相关的知识。最终,对这个主题有了相当全面的了解。

后端环境基于.NET,前端环境则是一个客户端渲染项目。
以下是详细搭建步骤。

首先,对 Program.cs 文件进行了修改:

using Microsoft.AspNetCore.Antiforgery;

builder.Services.AddAntiforgery(options =>

{

options.Cookie = new CookieBuilder {

HttpOnly = true, // for security purposes, this means that when csrf endpoint responses with "set-cookie" header then the cookie is httpOnly which means the cookie is stored to the browser, BUT webpage's javascript can't access it.

Domain = "your-site-url-here.com",

Expiration = new TimeSpan(TimeSpan.TicksPerMinute),

Path = "/", // I had to put it to just a slash, otherwise the set-cookie would work for me. Maybe some configuration can fix other paths.

Name = "csrf"

// SameSite = SameSiteMode.None, // for localhost I had to use SameSite.None, but in test server it broke things for me.

// SecurePolicy = CookieSecurePolicy.Always // for localhost I had to use it according to Chrome's dev tool network tab for the set-cookie to apply to cookies. But did not need it in test server.

},

options.HeaderName = "X-CSRF-TOKEN"; // This name is also important, because the same name must be present in your request's headers from frontend

options.SuppressXFrameOptionsHeader = false; // For Clickjacking

});

builder.Services.AddControllersWithViews(options => {

// Only AddControllersWithViews works, "AddControllers" is not enough here.

options.Filters.Add(new Microsoft.AspNetCore.Mvc.ValidateAntiForgeryTokenAttribute());

// Adds CSRF token validation to all controllers and their actions

});

// after var app = builder.Build();

app.UseAntiforgery();

然后添加了一个用于获取 CSRF 令牌的控制器:

using Microsoft.AspNetCore.Antiforgery;

using Microsoft.AspNetCore.Authorization;

using Microsoft.AspNetCore.Mvc;

namespace Your.Controllers;

ApiController

Route("api/csrf")

public class CsrfController(IAntiforgery antiforgery) {

HttpGet("")

AllowAnonymous

IgnoreAntiforgeryToken

// So the CSRF token validation is turned off for this action because you have to get an acces to this endpoint always for a token.

public IActionResult GetCsrf() {

var tokenSet = antiforgery.GetAndStoreTokens(HttpContext); // This generates the tokens for your cookies and requests and adds needed response headers for your browser.

// The response contains the request token as in "Ok" method and if you look in browser response headers then there is "set-cookie" named header which contains cookie token which is automatically set to your browsers cookies which are inaccessible for javascript but the csrf cookie is sent automatically with the next request you make from frontend.

return Ok(tokenSet.RequestToken);

}

}

最后,预先从前端对所有 API 请求应用了 CSRF 令牌获取机制:

const getCsrfToken = async () => {

return fetch(`${APIURL}/api/csrf`)

.then(data => data.json())

.catch(error => console.error("Error fetchin CSRF token: ", error))

}

const apiFetch = async (url, params..., and so on) => {

const csrfResult = await getCsrfToken();

// in your fetch add "X-CSRF-TOKEN" to headers with value <csrfResult> (or request_token, depending on your casing settings in backend)

}

希望这篇文章对大家有所帮助。如果发现任何错误,请随时留言指正。

如果您喜欢此文章,请收藏、点赞、评论,谢谢,祝您快乐每一天。

相关推荐
M ? A2 小时前
Vue转React最佳工具对比:Vuera、Veaury与VuReact
前端·javascript·vue.js·经验分享·react.js
We་ct2 小时前
JS手撕:函数进阶 & 设计模式解析
开发语言·前端·javascript·设计模式·面试·前端框架
悟空瞎说3 小时前
前端老鸟实战:纯 CSS 实现小红书「真・瀑布流」,零 JS、自动错落、生产可用
前端
yuki_uix3 小时前
当 reduce 遇到二维数据:从"聚合直觉"到"复合 Map"的思维跃迁
前端·javascript·面试
我叫黑大帅3 小时前
Vue3中的computed 与 watch 的区别
前端·javascript·面试
暗不需求3 小时前
# 一文搞懂 JavaScript 内存机制:从栈和堆,到闭包为什么“活得更久”
前端·javascript
CharlesY3 小时前
JavaScript HTML5 Cache Manifest:离线应用缓存机制考古
前端·javascript
yuki_uix3 小时前
前端解题的 6 个思维模型:比记答案更有用的东西
前端·面试
Bigger3 小时前
第三章:我是如何剖析 Claude Code 工具系统与命令执行机制的
前端·claude·源码阅读