在无状态 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)

}

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

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

相关推荐
FRing037 小时前
vue3干货总结3(defineOptions(Vue3.3)、defineModel(Vue3.4)、Pinia)
开发语言·前端·vue.js·vue3
Bczheng17 小时前
组件化服务端渲染模式SSR
前端
whitelbwwww9 小时前
CUDA C++实战--中级
开发语言·前端·c++
张紫娃9 小时前
Chrome插件-Stylus(屏蔽博客广告)
前端·chrome·stylus
Yannik9 小时前
在 Apple Silicon Mac 上用 Jenkins + Fastlane 搭建 iOS CI:从自动打包到 MR 检查流水线的完整实践
前端
Nayana9 小时前
《Web 到 HarmonyOS》-- 打包:Vite 产物 → HAP / HAR / HSP
前端
inksci9 小时前
用飞帆做了个小网页
前端·javascript·css·html
去伪存真9 小时前
被 pnpm 打包坑惨后,我彻底盘明白了硬链接与软链接
前端·electron
zhensherlock10 小时前
Protocol Launcher 系列:CodeHub 移动端 GitHub 协作利器
前端·javascript·typescript·node.js·自动化·github·js
tryCbest15 小时前
Vue3——第 22 篇:Pinia——新一代状态管理(上)
前端·javascript·vue.js