在 ASP.NET Core 防止跨站点请求伪造 (XSRF/CSRF) 攻击Prevent Cross-Site Request Forgery (XSRF/CSRF) attacks in ASP.NET Core

本文内容

作者： Rick Anderson、 Fiyaz Hasan和Steve Smith

跨站点请求伪造（也称为 XSRF 或 CSRF）是一种针对 web 托管应用的攻击，恶意 web 应用可能会影响客户端浏览器与信任该浏览器的 web 应用之间的交互。这些攻击是可能的，因为 web 浏览器会自动向网站发送每个请求的身份验证令牌。这种形式的攻击也称为一键式攻击或会话 riding ，因为攻击利用用户以前的经过身份验证的会话。

CSRF 攻击的示例：

• 用户使用窗体身份验证登录 www.good-banking-site.com。服务器对用户进行身份验证，并发出包含身份验证 cookie 的响应。此站点容易受到攻击，因为它信任使用有效的身份验证 cookie 接收的任何请求。

• 用户访问恶意网站 www.bad-crook-site.com。

恶意网站 www.bad-crook-site.com包含如下所示的 HTML 格式：

<h1>Congratulations! You're a Winner!</h1>
<form action="http://good-banking-site.com/api/account" method="post">
    <input type="hidden" name="Transaction" value="withdraw">
    <input type="hidden" name="Amount" value="1000000">
    <input type="submit" value="Click to collect your prize!">
</form>

请注意，窗体的 action 会发布到易受攻击的站点，而不是恶意站点。这是 CSRF 的 "跨站点" 部分。

• 用户选择 "提交" 按钮。浏览器发出请求并自动包含请求域的身份验证 cookie，www.good-banking-site.com。

• 请求使用用户的身份验证上下文在 www.good-banking-site.com 服务器上运行，并可执行允许经过身份验证的用户执行的任何操作。

除了用户选择按钮以提交窗体的情况外，恶意网站还可以：

• 运行自动提交窗体的脚本。
• 以 AJAX 请求形式发送窗体提交。
• 使用 CSS 隐藏窗体。

除最初访问恶意网站外，这些备选方案不需要用户执行任何操作或输入。

使用 HTTPS 不会阻止 CSRF 攻击。恶意站点可以发送 https://www.good-banking-site.com/ 请求，就像发送不安全请求一样容易。

某些攻击目标是响应 GET 请求的终结点，在这种情况下，可以使用图像标记执行操作。这种形式的攻击在允许图像但阻止 JavaScript 的论坛站点上很常见。在 GET 请求上更改状态的应用（其中变量或资源被更改）很容易受到恶意攻击。更改状态的 GET 请求是不安全的。最佳做法是从不更改 GET 请求的状态。

对于使用 cookie 进行身份验证的 web 应用，可能会受到 CSRF 攻击，因为：

• 浏览器存储 web 应用颁发的 cookie。
• 存储的 cookie 包括经过身份验证的用户的会话 cookie。
• 无论在浏览器中生成应用程序请求的方式如何，浏览器都会将与域关联的所有 cookie 发送到 web 应用。

但是，CSRF 攻击并不局限于利用 cookie。例如，基本身份验证和摘要式身份验证也容易受到攻击。用户使用基本或摘要式身份验证登录后，浏览器会自动发送凭据，直到会话† 结束。

†在此上下文中， session是指在其中对用户进行身份验证的客户端会话。它与服务器端会话或ASP.NET Core 会话中间件无关。

用户可以采取预防措施来防止 CSRF 漏洞：

• 使用完 web 应用后，将其注销。
• 定期清除浏览器 cookie。

但是，CSRF 漏洞在本质上是 web 应用的问题，而不是最终用户的问题。

身份验证基础知识Authentication fundamentals

基于 Cookie 的身份验证是一种常用的身份验证形式。基于令牌的身份验证系统不断增长，尤其是对于单页面应用程序（Spa）。

基于 Cookie 的身份验证Cookie-based authentication

用户使用其用户名和密码进行身份验证时，将颁发令牌，其中包含可用于身份验证和授权的身份验证票证。令牌存储为每个客户端发出的请求附带的 cookie。生成和验证此 cookie 由 Cookie 身份验证中间件来执行。中间件将用户主体序列化为加密的 cookie。在后续请求中，中间件将验证 cookie，重新创建主体，并将主体分配给HttpContext的用户属性。

基于令牌的身份验证Token-based authentication

在对用户进行身份验证时，他们将颁发一个令牌（而不是防伪令牌）。令牌包含声明形式的用户信息或引用令牌，该令牌将应用指向应用中维护的用户状态。当用户尝试访问要求身份验证的资源时，会将令牌发送到应用程序，并以持有者令牌的形式提供附加的授权标头。这使应用无状态。在每个后续请求中，将在请求服务器端验证时传递该令牌。此标记未加密;编码。在服务器上，将解码令牌来访问其信息。若要在后续请求中发送令牌，请将该令牌存储在浏览器的本地存储中。如果令牌存储在浏览器的本地存储中，请不要担心 CSRF 漏洞。如果标记存储在 cookie 中，则需要考虑 CSRF。有关详细信息，请参阅 GitHub 问题SPA 代码示例添加两个 cookie。

在一个域中托管多个应用Multiple apps hosted at one domain

共享宿主环境容易遭受会话劫持、登录 CSRF 和其他攻击。

尽管 example1.contoso.net 和 example2.contoso.net 是不同主机，但 *.contoso.net 域下的主机之间存在隐式信任关系。这种隐式信任关系允许可能不受信任的主机影响彼此的 cookie （控制 AJAX 请求的相同来源策略并不一定适用于 HTTP cookie）。

如果不共享域，则可以阻止利用同一域中托管的应用之间的受信任 cookie 的攻击。当每个应用托管在其自己的域中时，没有要利用的隐式 cookie 信任关系。

ASP.NET Core antiforgery 配置ASP.NET Core antiforgery configuration

警告

ASP.NET Core 使用ASP.NET Core 数据保护来实现防伪。必须将数据保护堆栈配置为在服务器场中运行。有关详细信息，请参阅配置数据保护。

在 Startup.ConfigureServices中调用以下某个 Api 时，会将防伪中间件添加到依赖关系注入容器中：

• AddMvc
• MapRazorPages
• MapControllerRoute
• MapBlazorHub

当在中调用 AddMvc 时，防伪中间件将添加到依赖关系注入容器 Startup.ConfigureServices

在 ASP.NET Core 2.0 或更高版本中， FormTagHelper将防伪标记注入 HTML 窗体元素。Razor 文件中的以下标记会自动生成防伪标记：

<form method="post">
    ...
</form>

同样，如果窗体的方法不获取，则默认情况下， IHtmlHelper将生成防伪标记。

当 <form> 标记包含 method="post" 属性并且满足以下任一条件时，会自动生成 HTML 窗体元素的防伪令牌：

• 操作属性为空（action=""）。
• 未提供操作属性（<form method="post">）。

可以禁用 HTML 窗体元素的自动生成防伪标记：

• 显式禁用 asp-antiforgery 属性的防伪令牌：

<form method="post" asp-antiforgery="false">
    ...
</form>

• Form 元素使用 Tag Helper ！ opt out 符号选择退出标记帮助器：

<!form method="post">
    ...
</!form>

• 从视图中删除 FormTagHelper。可以通过将以下指令添加到 Razor 视图来从视图中删除 FormTagHelper：

@removeTagHelper Microsoft.AspNetCore.Mvc.TagHelpers.FormTagHelper, Microsoft.AspNetCore.Mvc.TagHelpers

备注

自动从 XSRF/CSRF 保护Razor Pages 。有关详细信息，请参阅XSRF/CSRF 和 Razor Pages。

防御 CSRF 攻击的最常见方法是使用同步器令牌模式（STP）。当用户请求包含窗体数据的页面时，将使用 STP：

• 服务器向客户端发送与当前用户的标识关联的令牌。
• 客户端将该令牌发送回服务器以进行验证。
• 如果服务器收到的令牌与经过身份验证的用户的标识不匹配，则会拒绝该请求。
  该令牌是唯一的且不可预测的。令牌还可用于确保对一系列请求进行正确排序（例如，确保的请求序列为： page 1 – 第2页 – 第3页）。ASP.NET Core MVC 和 Razor 页模板中的窗体的所有生成 antiforgery 令牌。以下对视图示例将生成防伪令牌：

<form asp-controller="Manage" asp-action="ChangePassword" method="post">
    ...
</form>
@using (Html.BeginForm("ChangePassword", "Manage"))
{
    ...
}

将防伪标记显式添加到 <form> 元素，而不将标记帮助程序与 HTML helper @Html.AntiForgeryToken一起使用：

<form action="/" method="post">
    @Html.AntiForgeryToken()
</form>

在每个前面的情况下，ASP.NET Core 添加类似于以下一个隐藏的表单字段：

<input name="__RequestVerificationToken" type="hidden" value="CfDJ8NrAkS ... s2-m9Yw">

ASP.NET Core 包括三个用于处理防伪令牌的筛选器：

• ValidateAntiForgeryToken
• AutoValidateAntiforgeryToken
• IgnoreAntiforgeryToken

防伪选项Antiforgery options

自定义 Startup.ConfigureServices中的防伪选项：

services.AddAntiforgery(options => 
{
    // Set Cookie properties using CookieBuilder properties†.
    options.FormFieldName = "AntiforgeryFieldname";
    options.HeaderName = "X-CSRF-TOKEN-HEADERNAME";
    options.SuppressXFrameOptionsHeader = false;
});

†使用CookieBuilder类的属性设置防伪 Cookie 属性。

services.AddAntiforgery(options => 
{
    options.CookieDomain = "contoso.com";
    options.CookieName = "X-CSRF-TOKEN-COOKIENAME";
    options.CookiePath = "Path";
    options.FormFieldName = "AntiforgeryFieldname";
    options.HeaderName = "X-CSRF-TOKEN-HEADERNAME";
    options.RequireSsl = false;
    options.SuppressXFrameOptionsHeader = false;
});

有关详细信息，请参阅cookieauthenticationoptions.authenticationtype。

通过 IAntiforgery 配置防伪功能Configure antiforgery features with IAntiforgery

IAntiforgery提供用于配置防伪功能的 API。可在 Startup 类的 Configure 方法中请求 IAntiforgery。下面的示例使用应用程序主页中的中间件来生成防伪标记，并将其作为 cookie 发送到响应中（使用本主题后面部分介绍的默认角度命名约定）：

public void Configure(IApplicationBuilder app, IAntiforgery antiforgery)
{
    app.Use(next => context =>
    {
        string path = context.Request.Path.Value;
        if (
            string.Equals(path, "/", StringComparison.OrdinalIgnoreCase) ||
            string.Equals(path, "/index.html", StringComparison.OrdinalIgnoreCase))
        {
            // The request token can be sent as a JavaScript-readable cookie, 
            // and Angular uses it by default.
            var tokens = antiforgery.GetAndStoreTokens(context);
            context.Response.Cookies.Append("XSRF-TOKEN", tokens.RequestToken, 
                new CookieOptions() { HttpOnly = false });
        }
        return next(context);
    });
}

需要防伪验证Require antiforgery validation

ValidateAntiForgeryToken是一个可应用于单个操作、控制器或全局的操作筛选器。将阻止对应用了此筛选器的操作发出的请求，除非该请求包含有效的防伪令牌。

[HttpPost]
[ValidateAntiForgeryToken]
public async Task<IActionResult> RemoveLogin(RemoveLoginViewModel account)
{
    ManageMessageId? message = ManageMessageId.Error;
    var user = await GetCurrentUserAsync();
    if (user != null)
    {
        var result = 
            await _userManager.RemoveLoginAsync(
                user, account.LoginProvider, account.ProviderKey);
        if (result.Succeeded)
        {
            await _signInManager.SignInAsync(user, isPersistent: false);
            message = ManageMessageId.RemoveLoginSuccess;
        }
    }
    return RedirectToAction(nameof(ManageLogins), new { Message = message });
}

ValidateAntiForgeryToken 特性要求对其标记的操作方法（包括 HTTP GET 请求）发出请求的令牌。如果在应用的控制器上应用 ValidateAntiForgeryToken 属性，则可以通过 IgnoreAntiforgeryToken 属性将其重写。

备注

ASP.NET Core 不支持自动将 antiforgery 令牌添加到 GET 请求。

仅自动验证不安全 HTTP 方法的防伪令牌Automatically validate antiforgery tokens for unsafe HTTP methods only

ASP.NET Core 应用不生成 antiforgery 令牌进行安全的 HTTP 方法 （GET、 HEAD、 选项和跟踪）。可以使用AutoValidateAntiforgeryToken属性，而不是广泛应用 ValidateAntiForgeryToken 属性，然后使用 IgnoreAntiforgeryToken 属性将其重写。此特性与 ValidateAntiForgeryToken 特性的工作方式相同，不同之处在于，它不需要使用以下 HTTP 方法发出的请求的令牌：

• GET
• HEAD
• OPTIONS
• TRACE

建议为非 API 方案广泛使用 AutoValidateAntiforgeryToken。这可确保默认情况下保护后操作。另一种方法是默认忽略防伪标记，除非将 ValidateAntiForgeryToken 应用到各个操作方法。在这种情况下，更有可能在此方案中，不受错误阻止的 POST 操作方法，使应用容易受到 CSRF 攻击。所有Post请求都应发送防伪令牌。

Api 没有用于发送令牌的非 cookie 部分的自动机制。实现可能取决于客户端代码实现。下面显示了一些示例：

类级别的示例：

[Authorize]
[AutoValidateAntiforgeryToken]
public class ManageController : Controller
{

全局示例：

服务器.Addmvc 以（options = > 选项。Filters。 Add （new AutoValidateAntiforgeryTokenAttribute （）））;

services.AddControllersWithViews(options =>
    options.Filters.Add(new AutoValidateAntiforgeryTokenAttribute()));

重写全局或控制器防伪属性Override global or controller antiforgery attributes

IgnoreAntiforgeryToken筛选器用于消除给定操作（或控制器）的防伪标记的需要。应用此筛选器时，会覆盖在更高级别（全局或控制器上）指定 ValidateAntiForgeryToken 和 AutoValidateAntiforgeryToken 筛选器。

[Authorize]
[AutoValidateAntiforgeryToken]
public class ManageController : Controller
{
    [HttpPost]
    [IgnoreAntiforgeryToken]
    public async Task<IActionResult> DoSomethingSafe(SomeViewModel model)
    {
        // no antiforgery token required
    }
}

身份验证后刷新令牌Refresh tokens after authentication

通过将用户重定向到视图或 Razor Pages 页面来对用户进行身份验证后，应刷新标记。

JavaScript、AJAX 和 SpaJavaScript, AJAX, and SPAs

在传统的基于 HTML 的应用程序中，使用隐藏的窗体字段将防伪令牌传递给服务器。在基于 JavaScript 的新式应用和 Spa 中，许多请求是以编程方式进行的。这些 AJAX 请求可能使用其他技术（例如请求标头或 cookie）来发送令牌。

如果使用 cookie 来存储身份验证令牌，并在服务器上对 API 请求进行身份验证，则 CSRF 是一个潜在问题。如果使用本地存储来存储令牌，可能会降低 CSRF 漏洞，因为本地存储中的值不会随每个请求自动发送到服务器。因此，使用本地存储在客户端上存储防伪令牌并将令牌作为请求标头进行发送是建议的方法。

JavaScriptJavaScript

将 JavaScript 用于视图，可以使用视图中的服务创建令牌。将AspNetCore 防伪 IAntiforgery服务插入到视图中，并调用GetAndStoreTokens：

@{
    ViewData["Title"] = "AJAX Demo";
}
@inject Microsoft.AspNetCore.Antiforgery.IAntiforgery Xsrf
@functions{
    public string GetAntiXsrfRequestToken()
    {
        return Xsrf.GetAndStoreTokens(Context).RequestToken;
    }
}
<input type="hidden" id="RequestVerificationToken" 
       name="RequestVerificationToken" value="@GetAntiXsrfRequestToken()">
<h2>@ViewData["Title"].</h2>
<h3>@ViewData["Message"]</h3>
<div class="row">
    <p><input type="button" id="antiforgery" value="Antiforgery"></p>
    <script>
        var xhttp = new XMLHttpRequest();
        xhttp.onreadystatechange = function() {
            if (xhttp.readyState == XMLHttpRequest.DONE) {
                if (xhttp.status == 200) {
                    alert(xhttp.responseText);
                } else {
                    alert('There was an error processing the AJAX request.');
                }
            }
        };
        document.addEventListener('DOMContentLoaded', function() {
            document.getElementById("antiforgery").onclick = function () {
                xhttp.open('POST', '@Url.Action("Antiforgery", "Home")', true);
                xhttp.setRequestHeader("RequestVerificationToken", 
                    document.getElementById('RequestVerificationToken').value);
                xhttp.send();
            }
        });
    </script>
</div>

此方法无需直接处理来自服务器的 cookie 设置，也无需从客户端读取它。

前面的示例使用 JavaScript 读取 AJAX POST 标头的隐藏字段值。

JavaScript 还可以访问 cookie 中的令牌，并使用 cookie 的内容创建带有令牌值的标头。

context.Response.Cookies.Append("CSRF-TOKEN", tokens.RequestToken, 
    new Microsoft.AspNetCore.Http.CookieOptions { HttpOnly = false });

假设脚本请求将令牌发送到名为 X-CSRF-TOKEN的标头，请将防伪服务配置为查找 X-CSRF-TOKEN 标头：

services.AddAntiforgery(options => options.HeaderName = "X-CSRF-TOKEN");

下面的示例使用 JavaScript 通过适当的标头发出 AJAX 请求：

function getCookie(cname) {
    var name = cname + "=";
    var decodedCookie = decodeURIComponent(document.cookie);
    var ca = decodedCookie.split(';');
    for(var i = 0; i <ca.length; i++) {
        var c = ca[i];
        while (c.charAt(0) == ' ') {
            c = c.substring(1);
        }
        if (c.indexOf(name) == 0) {
            return c.substring(name.length, c.length);
        }
    }
    return "";
}
var csrfToken = getCookie("CSRF-TOKEN");
var xhttp = new XMLHttpRequest();
xhttp.onreadystatechange = function() {
    if (xhttp.readyState == XMLHttpRequest.DONE) {
        if (xhttp.status == 200) {
            alert(xhttp.responseText);
        } else {
            alert('There was an error processing the AJAX request.');
        }
    }
};
xhttp.open('POST', '/api/password/changepassword', true);
xhttp.setRequestHeader("Content-type", "application/json");
xhttp.setRequestHeader("X-CSRF-TOKEN", csrfToken);
xhttp.send(JSON.stringify({ "newPassword": "ReallySecurePassword999$$$" }));

AngularJSAngularJS

AngularJS 使用约定来寻址 CSRF。如果服务器发送 XSRF-TOKEN名称的 cookie，则在向服务器发送请求时，AngularJS $http 服务会将 cookie 值添加到标头。此过程是自动进行的。不需要在客户端中显式设置标头。标头名称为 X-XSRF-TOKEN。服务器应检测此标头并验证其内容。

对于在应用程序启动时使用此约定的 ASP.NET Core API：

• 将应用配置为在名为 XSRF-TOKEN的 cookie 中提供令牌。
• 配置防伪服务以查找名为 X-XSRF-TOKEN的标头。

public void Configure(IApplicationBuilder app, IAntiforgery antiforgery)
{
    app.Use(next => context =>
    {
        string path = context.Request.Path.Value;
        if (
            string.Equals(path, "/", StringComparison.OrdinalIgnoreCase) ||
            string.Equals(path, "/index.html", StringComparison.OrdinalIgnoreCase))
        {
            // The request token can be sent as a JavaScript-readable cookie, 
            // and Angular uses it by default.
            var tokens = antiforgery.GetAndStoreTokens(context);
            context.Response.Cookies.Append("XSRF-TOKEN", tokens.RequestToken, 
                new CookieOptions() { HttpOnly = false });
        }
        return next(context);
    });
}
public void ConfigureServices(IServiceCollection services)
{
    // Angular's default header name for sending the XSRF token.
    services.AddAntiforgery(options => options.HeaderName = "X-XSRF-TOKEN");
}

查看或下载示例代码（如何下载）

扩展防伪Extend antiforgery

IAntiForgeryAdditionalDataProvider类型允许开发人员通过往返每个标记中的其他数据来扩展反 CSRF 系统的行为。每次生成字段标记时都会调用GetAdditionalData方法，并且返回值嵌入到生成的标记中。在验证令牌时，实施者可以返回时间戳、nonce 或任何其他值，然后调用ValidateAdditionalData来验证此数据。客户端的用户名已嵌入到生成的令牌中，因此不需要包含此信息。如果令牌包含补充数据但未配置 IAntiForgeryAdditionalDataProvider，则不会验证补充数据。

其他资源Additional resources

• CSRF)打开 Web 应用程序安全项目（OWASP）。
• 在 Web 场中托管 ASP.NET Core