ASP.NET Web API：返回 401/未授权响应的正确方法

Question

我有一个 MVC webapi 站点，它使用 OAuth/token 身份验证来验证请求。所有相关控制器都具有正确的属性，并且身份验证工作正常。

问题在于，并非所有请求都可以在属性范围内获得授权 - 必须在控制器方法调用的代码中执行一些授权检查 - 返回 401 未授权响应的正确方法是什么？这种情况？

我已经尝试过throw new HttpException(401, "Unauthorized access");，但是当我这样做时，响应状态码是 500，我还得到了堆栈跟踪。即使在我们的日志记录 DelegatingHandler 中，我们也可以看到响应是 500，而不是 401。

Answer 1

作为其他答案的替代方案，如果您想在 ASP.NET 控制器中返回 IActionResult，也可以使用此代码。

ASP.NET

 return Content(HttpStatusCode.Unauthorized, "My error message");

更新：ASP.NET Core

以上代码在 ASP.NET Core 中不起作用，您可以改用以下代码之一：

 return StatusCode((int)System.Net.HttpStatusCode.Unauthorized, "My error message");
 return StatusCode(Microsoft.AspNetCore.Http.StatusCodes.Status401Unauthorized, "My error message");
 return StatusCode(401, "My error message");

显然原因短语是可选的 (Can an HTTP response omit the Reason-Phrase?)

Answer 2

您也遵循以下代码：

var response = new HttpResponseMessage(HttpStatusCode.NotFound)
{
      Content = new StringContent("Users doesn't exist", System.Text.Encoding.UTF8, "text/plain"),
      StatusCode = HttpStatusCode.NotFound
 }
 throw new HttpResponseException(response);

Answer 3

在.Net Core中可以使用

return new ForbidResult();

而不是

return Unauthorized();

它的优点是重定向到默认的未经授权的页面 (Account/AccessDenied)，而不是直接给出 401

要更改默认位置，请修改您的 startup.cs

services.AddAuthentication(options =>...)
            .AddOpenIdConnect(options =>...)
            .AddCookie(options =>
            {
                options.AccessDeniedPath = "/path/unauthorized";

            })

Answer 4

要添加到 ASP.NET Core >= 1.0 中的现有答案，您可以

return Unauthorized();

return Unauthorized(object value);

要将信息传递给客户端，您可以这样调用：

return Unauthorized(new { Ok = false, Code = Constants.INVALID_CREDENTIALS, ...});

在客户端上，除了 401 响应之外，您还将获得传递的数据。例如，在大多数客户端上，您可以await response.json() 获取它。

Answer 5

您可以在 asp.net core 2.0 中使用以下代码：

public IActionResult index()
{
     return new ContentResult() { Content = "My error message", StatusCode = (int)HttpStatusCode.Unauthorized };
}

Answer 6

只需返回以下内容：

return Unauthorized();

Answer 7

您应该从您的 API 方法中抛出 HttpResponseException，而不是 HttpException：

throw new HttpResponseException(HttpStatusCode.Unauthorized);

或者，如果您想提供自定义消息：

var msg = new HttpResponseMessage(HttpStatusCode.Unauthorized) { ReasonPhrase = "Oops!!!" };
throw new HttpResponseException(msg);

Answer 8

您收到 500 响应代码，因为您抛出了异常（HttpException），表明某种服务器错误，这是错误的方法。

只需设置响应状态码.e.g

Response.StatusCode = (int)HttpStatusCode.Unauthorized;