JWT 和 Web API (JwtAuthForWebAPI?) - 寻找示例

问题描述

我有一个以 Angular 为前端的 Web API 项目，我想使用 JWT 令牌保护它.我已经进行了用户/通行证验证，所以我认为我只需要实现 JWT 部分.

I've got a Web API project fronted by Angular, and I want to secure it using a JWT token. I've already got user/pass validation happening, so I think i just need to implement the JWT part.

我相信我已经选择了 JwtAuthForWebAPI，所以一个使用它的例子会很棒.

I believe I've settled on JwtAuthForWebAPI so an example using that would be great.

我假设任何没有用 [Authorize] 修饰的方法都会像往常一样运行，并且如果客户端传递的令牌不匹配，任何用 [Authorize] 修饰的方法都会 401.

I assume any method not decorated with [Authorize] will behave as it always does, and that any method decorated with [Authorize] will 401 if the token passed by the client doesn't match.

我还不知道如何在初始身份验证时将令牌发送回客户端.

What I can't yet figure out it how to send the token back to the client upon initial authentication.

我试图只使用一个魔术字符串开始，所以我有这个代码:

I'm trying to just use a magic string to begin, so I have this code:

RegisterRoutes(GlobalConfiguration.Configuration.Routes);
var builder = new SecurityTokenBuilder();
var jwtHandler = new JwtAuthenticationMessageHandler
{
    AllowedAudience = "http://xxxx.com",
    Issuer = "corp",
    SigningToken = builder.CreateFromKey(Convert.ToBase64String(new byte[]{4,2,2,6}))
};

GlobalConfiguration.Configuration.MessageHandlers.Add(jwtHandler);

但我不确定最初是如何返回给客户的.我想我知道如何在客户端处理这个问题，但是如果你也可以展示这种交互的 Angular 方面，那么我会加分.

But I'm not sure how that gets back to the client initially. I think I understand how to handle this on the client, but bonus points if you can also show the Angular side of this interaction.

推荐答案

我最终不得不从几个不同的地方获取信息来创建一个适合我的解决方案(实际上，生产可行解决方案的开始 -但它有效！)

I ended-up having to take a information from several different places to create a solution that works for me (in reality, the beginnings of a production viable solution - but it works!)

我摆脱了 JwtAuthForWebAPI (尽管我确实从中借了一件，以允许没有授权标头的请求流向不受 [Authorize] 保护的 WebAPI 控制器方法).

I got rid of JwtAuthForWebAPI (though I did borrow one piece from it to allow requests with no Authorization header to flow through to WebAPI Controller methods not guarded by [Authorize]).

相反，我使用的是 Microsoft 的 JWT 库 (Microsoft 的 JSON Web 令牌处理程序.NET 框架 - 来自 NuGet).

Instead I'm using Microsoft's JWT Library (JSON Web Token Handler for the Microsoft .NET Framework - from NuGet).

在我的身份验证方法中，在进行实际身份验证后，我创建了令牌的字符串版本，并将其与经过身份验证的名称(在这种情况下传递给我的用户名相同)和一个角色一起传回，实际上, 可能是在身份验证期间派生的.

In my authentication method, after doing the actual authentication, I create the string version of the token and pass it back along with the authenticated name (the same username passed into me, in this case) and a role which, in reality, would likely be derived during authentication.

方法如下:

[HttpPost]
public LoginResult PostSignIn([FromBody] Credentials credentials)
{
    var auth = new LoginResult() { Authenticated = false };

    if (TryLogon(credentials.UserName, credentials.Password))
    {
        var tokenDescriptor = new SecurityTokenDescriptor
        {
            Subject = new ClaimsIdentity(new[]
            {
                new Claim(ClaimTypes.Name, credentials.UserName), 
                new Claim(ClaimTypes.Role, "Admin")
            }),

            AppliesToAddress = ConfigurationManager.AppSettings["JwtAllowedAudience"],
            TokenIssuerName = ConfigurationManager.AppSettings["JwtValidIssuer"],
            SigningCredentials = new SigningCredentials(new 
                InMemorySymmetricSecurityKey(JwtTokenValidationHandler.SymmetricKey),
                "http://www.w3.org/2001/04/xmldsig-more#hmac-sha256",
                "http://www.w3.org/2001/04/xmlenc#sha256")
            };

            var tokenHandler = new JwtSecurityTokenHandler();
            var token = tokenHandler.CreateToken(tokenDescriptor);
            var tokenString = tokenHandler.WriteToken(token);

            auth.Token = tokenString;
            auth.Authenticated = true;
        }

    return auth;
}

更新

有一个关于在后续请求中处理令牌的问题.我所做的是创建一个 DelegatingHandler 来尝试读取/解码令牌，然后创建一个 Principal 并将其设置为 Thread.CurrentPrincipal 和 HttpContext.Current.User (您需要将其设置为两者).最后，我用适当的访问限制来装饰控制器方法.

There was a question about handling the token on subsequent requests. What I did was create a DelegatingHandler to try and read/decode the token, then create a Principal and set it into Thread.CurrentPrincipal and HttpContext.Current.User (you need to set it into both). Finally, I decorate the controller methods with the appropriate access restrictions.

这是 DelegatingHandler 的主要内容:

Here's the meat of the DelegatingHandler:

private static bool TryRetrieveToken(HttpRequestMessage request, out string token)
{
    token = null;
    IEnumerable<string> authzHeaders;
    if (!request.Headers.TryGetValues("Authorization", out authzHeaders) || authzHeaders.Count() > 1)
    {
        return false;
    }
    var bearerToken = authzHeaders.ElementAt(0);
    token = bearerToken.StartsWith("Bearer ") ? bearerToken.Substring(7) : bearerToken;
    return true;
}


protected override Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
    HttpStatusCode statusCode;
    string token;

    var authHeader = request.Headers.Authorization;
    if (authHeader == null)
    {
        // missing authorization header
        return base.SendAsync(request, cancellationToken);
    }

    if (!TryRetrieveToken(request, out token))
    {
        statusCode = HttpStatusCode.Unauthorized;
        return Task<HttpResponseMessage>.Factory.StartNew(() => new HttpResponseMessage(statusCode));
    }

    try
    {
        JwtSecurityTokenHandler tokenHandler = new JwtSecurityTokenHandler();
        TokenValidationParameters validationParameters =
            new TokenValidationParameters()
            {
                AllowedAudience = ConfigurationManager.AppSettings["JwtAllowedAudience"],
                ValidIssuer = ConfigurationManager.AppSettings["JwtValidIssuer"],
                SigningToken = new BinarySecretSecurityToken(SymmetricKey)
            };

        IPrincipal principal = tokenHandler.ValidateToken(token, validationParameters);
        Thread.CurrentPrincipal = principal;
        HttpContext.Current.User = principal;

        return base.SendAsync(request, cancellationToken);
    }
    catch (SecurityTokenValidationException e)
    {
        statusCode = HttpStatusCode.Unauthorized;
    }
    catch (Exception)
    {
        statusCode = HttpStatusCode.InternalServerError;
    }

    return Task<HttpResponseMessage>.Factory.StartNew(() => new HttpResponseMessage(statusCode));
}

不要忘记将其添加到 MessageHandlers 管道中:

Don't forget to add it into the MessageHandlers pipeline:

public static void Start()
{
    GlobalConfiguration.Configuration.MessageHandlers.Add(new JwtTokenValidationHandler());
}

最后，装饰你的控制器方法:

Finally, decorate your controller methods:

[Authorize(Roles = "OneRoleHere")]
[GET("/api/admin/settings/product/allorgs")]
[HttpGet]
public List<Org> GetAllOrganizations()
{
    return QueryableDependencies.GetMergedOrganizations().ToList();
}

[Authorize(Roles = "ADifferentRoleHere")]
[GET("/api/admin/settings/product/allorgswithapproval")]
[HttpGet]
public List<ApprovableOrg> GetAllOrganizationsWithApproval()
{
    return QueryableDependencies.GetMergedOrganizationsWithApproval().ToList();
}

这篇关于JWT 和 Web API (JwtAuthForWebAPI?) - 寻找示例的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持跟版网！