草庐IT

c# - ASP.NET Web API 的 JWT 身份验证

coder 2023-07-06 原文

我正在尝试在我的 Web API 应用程序中支持 JWT 不记名 token (JSON Web token ),但我迷路了。

我看到了对 .NET Core 和 OWIN 应用程序的支持。
我目前在 IIS 中托管我的应用程序。

如何在我的应用程序中实现此身份验证模块?有什么办法可以使用 <authentication>配置类似于我使用表单/Windows 身份验证的方式?

最佳答案

我回答了这个问题:How to secure an ASP.NET Web API 4 年前使用 HMAC。
现在,安全方面发生了很多变化,尤其是 JWT 越来越流行。在这个答案中,我将尝试以最简单和基本的方式解释如何使用 JWT,这样我们就不会迷失在 OWIN、Oauth2、ASP.NET Identity 的丛林中...... :)
如果您不了解 JWT token ,则需要查看:
https://www.rfc-editor.org/rfc/rfc7519
基本上,JWT token 如下所示:

<base64-encoded header>.<base64-encoded claims>.<base64-encoded signature>
例子:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6ImN1b25nIiwibmJmIjoxNDc3NTY1NzI0LCJleHAiOjE0Nzc1NjY5MjQsImlhdCI6MTQ3NzU2NTcyNH0.6MzD1VwA5AcOcajkFyKhLYybr3h13iZjDyHm9zysDFQ


JWT token 包含三个部分:
  • header :采用 Base64 编码的 JSON 格式
  • 声明:以 Base64 编码的 JSON 格式。
  • 签名:基于以 Base64 编码的 Header 和 Claims 创建和签名。

  • 如果您使用网站jwt.io使用上面的 token ,您可以解码 token 并查看如下所示:

    从技术上讲,JWT 使用从 header 和声明中签名的签名,并使用 header 中指定的安全算法(例如:HMACSHA256)。因此,如果您在其声明中存储任何敏感信息,则必须通过 HTTP 传输 JWT。
    现在,为了使用 JWT 身份验证,如果您拥有旧版 Web Api 系统,则您实际上并不需要 OWIN 中间件。简单的概念是如何提供 JWT token 以及如何在请求到来时验证 token 。而已。
    demo I've created (github) , 为了保持 JWT token 的轻量级,我只存储 usernameexpiration time .但是这样的话,你必须重新构建新的本地身份(principal)来添加更多的信息,比如角色,如果你想做角色授权等。 但是,如果你想在 JWT 中添加更多信息,这取决于你:它非常灵活。
    您可以使用 Controller 操作简单地提供 JWT token 端点,而不是使用 OWIN 中间件:
    public class TokenController : ApiController
    {
        // This is naive endpoint for demo, it should use Basic authentication
        // to provide token or POST request
        [AllowAnonymous]
        public string Get(string username, string password)
        {
            if (CheckUser(username, password))
            {
                return JwtManager.GenerateToken(username);
            }
    
            throw new HttpResponseException(HttpStatusCode.Unauthorized);
        }
    
        public bool CheckUser(string username, string password)
        {
            // should check in the database
            return true;
        }
    }
    
    这是一种幼稚的行为;在生产中,您应该使用 POST 请求或基本身份验证端点来提供 JWT token 。
    如何基于username生成token ?
    您可以使用名为 System.IdentityModel.Tokens.Jwt 的 NuGet 包从 Microsoft 生成 token ,如果您愿意,甚至可以生成另一个包。在演示中,我使用 HMACSHA256SymmetricKey :
    /// <summary>
    /// Use the below code to generate symmetric Secret Key
    ///     var hmac = new HMACSHA256();
    ///     var key = Convert.ToBase64String(hmac.Key);
    /// </summary>
    private const string Secret = "db3OIsj+BXE9NZDy0t8W3TcNekrF+2d/1sFnWG4HnV8TZY30iTOdtVWJG8abWvB1GlOgJuQZdcF2Luqm/hccMw==";
    
    public static string GenerateToken(string username, int expireMinutes = 20)
    {
        var symmetricKey = Convert.FromBase64String(Secret);
        var tokenHandler = new JwtSecurityTokenHandler();
    
        var now = DateTime.UtcNow;
        var tokenDescriptor = new SecurityTokenDescriptor
        {
            Subject = new ClaimsIdentity(new[]
            {
                new Claim(ClaimTypes.Name, username)
            }),
    
            Expires = now.AddMinutes(Convert.ToInt32(expireMinutes)),
            
            SigningCredentials = new SigningCredentials(
                new SymmetricSecurityKey(symmetricKey), 
                SecurityAlgorithms.HmacSha256Signature)
        };
    
        var stoken = tokenHandler.CreateToken(tokenDescriptor);
        var token = tokenHandler.WriteToken(stoken);
    
        return token;
    }
    
    提供 JWT token 的端点已完成。
    请求到来时如何验证 JWT?
    demo ,我建了JwtAuthenticationAttribute继承自 IAuthenticationFilter (有关 here 中的身份验证过滤器的更多详细信息)。
    使用此属性,您可以验证任何操作:您只需将此属性放在该操作上。
    public class ValueController : ApiController
    {
        [JwtAuthentication]
        public string Get()
        {
            return "value";
        }
    }
    
    如果要验证 WebAPI 的所有传入请求(不特定于 Controller 或操作),也可以使用 OWIN 中间件或 DelegateHander
    以下是身份验证过滤器的核心方法:
    private static bool ValidateToken(string token, out string username)
    {
        username = null;
    
        var simplePrinciple = JwtManager.GetPrincipal(token);
        var identity = simplePrinciple.Identity as ClaimsIdentity;
    
        if (identity == null || !identity.IsAuthenticated)
            return false;
    
        var usernameClaim = identity.FindFirst(ClaimTypes.Name);
        username = usernameClaim?.Value;
    
        if (string.IsNullOrEmpty(username))
           return false;
    
        // More validate to check whether username exists in system
    
        return true;
    }
    
    protected Task<IPrincipal> AuthenticateJwtToken(string token)
    {
        string username;
    
        if (ValidateToken(token, out username))
        {
            // based on username to get more information from database 
            // in order to build local identity
            var claims = new List<Claim>
            {
                new Claim(ClaimTypes.Name, username)
                // Add more claims if needed: Roles, ...
            };
    
            var identity = new ClaimsIdentity(claims, "Jwt");
            IPrincipal user = new ClaimsPrincipal(identity);
    
            return Task.FromResult(user);
        }
    
        return Task.FromResult<IPrincipal>(null);
    }
    
    工作流程是使用JWT库(上面的NuGet包)验证JWT token 然后返回ClaimsPrincipal .您可以执行更多验证,例如检查系统上是否存在用户,并根据需要添加其他自定义验证。
    验证 JWT token 并取回主体的代码:
    public static ClaimsPrincipal GetPrincipal(string token)
    {
        try
        {
            var tokenHandler = new JwtSecurityTokenHandler();
            var jwtToken = tokenHandler.ReadToken(token) as JwtSecurityToken;
    
            if (jwtToken == null)
                return null;
    
            var symmetricKey = Convert.FromBase64String(Secret);
    
            var validationParameters = new TokenValidationParameters()
            {
                RequireExpirationTime = true,
                ValidateIssuer = false,
                ValidateAudience = false,
                IssuerSigningKey = new SymmetricSecurityKey(symmetricKey)
            };
    
            SecurityToken securityToken;
            var principal = tokenHandler.ValidateToken(token, validationParameters, out securityToken);
    
            return principal;
        }
        catch (Exception)
        {
            //should write log
            return null;
        }
    }
    
    如果验证了 JWT token 并返回了主体,您应该构建一个新的本地身份并将更多信息放入其中以检查角色授权。
    记得加config.Filters.Add(new AuthorizeAttribute()); (默认授权)在全局范围内,以防止对您的资源的任何匿名请求。
    您可以使用 Postman 来测试 demo :
    请求 token (我上面提到的幼稚,仅用于演示):
    GET http://localhost:{port}/api/token?username=cuong&password=1
    
    将 JWT token 放在授权请求的 header 中,例如:
    GET http://localhost:{port}/api/value
    
    Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6ImN1b25nIiwibmJmIjoxNDc3NTY1MjU4LCJleHAiOjE0Nzc1NjY0NTgsImlhdCI6MTQ3NzU2NTI1OH0.dSwwufd4-gztkLpttZsZ1255oEzpWCJkayR_4yvNL1s
    
    该演示可以在这里找到:https://github.com/cuongle/WebApi.Jwt

    关于c# - ASP.NET Web API 的 JWT 身份验证,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40281050/

    有关c# - ASP.NET Web API 的 JWT 身份验证的更多相关文章

    1. ruby-on-rails - 如何验证 update_all 是否实际在 Rails 中更新 - 2

      给定这段代码defcreate@upgrades=User.update_all(["role=?","upgraded"],:id=>params[:upgrade])redirect_toadmin_upgrades_path,:notice=>"Successfullyupgradeduser."end我如何在该操作中实际验证它们是否已保存或未重定向到适当的页面和消息? 最佳答案 在Rails3中,update_all不返回任何有意义的信息,除了已更新的记录数(这可能取决于您的DBMS是否返回该信息)。http://ar.ru

    2. ruby - 具有身份验证的私有(private) Ruby Gem 服务器 - 2

      我想安装一个带有一些身份验证的私有(private)Rubygem服务器。我希望能够使用公共(public)Ubuntu服务器托管内部gem。我读到了http://docs.rubygems.org/read/chapter/18.但是那个没有身份验证-如我所见。然后我读到了https://github.com/cwninja/geminabox.但是当我使用基本身份验证(他们在他们的Wiki中有)时,它会提示从我的服务器获取源。所以。如何制作带有身份验证的私有(private)Rubygem服务器?这是不可能的吗?谢谢。编辑:Geminabox问题。我尝试“捆绑”以安装新的gem..

    3. ruby-on-rails - 如果为空或不验证数值,则使属性默认为 0 - 2

      我希望我的UserPrice模型的属性在它们为空或不验证数值时默认为0。这些属性是tax_rate、shipping_cost和price。classCreateUserPrices8,:scale=>2t.decimal:tax_rate,:precision=>8,:scale=>2t.decimal:shipping_cost,:precision=>8,:scale=>2endendend起初,我将所有3列的:default=>0放在表格中,但我不想要这样,因为它已经填充了字段,我想使用占位符。这是我的UserPrice模型:classUserPrice回答before_val

    4. ruby-on-rails - 如何验证非模型(甚至非对象)字段 - 2

      我有一个表单,其中有很多字段取自数组(而不是模型或对象)。我如何验证这些字段的存在?solve_problem_pathdo|f|%>... 最佳答案 创建一个简单的类来包装请求参数并使用ActiveModel::Validations。#definedsomewhere,atthesimplest:require'ostruct'classSolvetrue#youcouldevencheckthesolutionwithavalidatorvalidatedoerrors.add(:base,"WRONG!!!")unlesss

    5. ruby-on-rails - 如何将验证与模型分开 - 2

      我有一些非常大的模型,我必须将它们迁移到最新版本的Rails。这些模型有相当多的验证(User有大约50个验证)。是否可以将所有这些验证移动到另一个文件中?说app/models/validations/user_validations.rb。如果可以,有人可以提供示例吗? 最佳答案 您可以为此使用关注点:#app/models/validations/user_validations.rbrequire'active_support/concern'moduleUserValidationsextendActiveSupport:

    6. ruby-on-rails - 跳过状态机方法的所有验证 - 2

      当我的预订模型通过rake任务在状态机上转换时,我试图找出如何跳过对ActiveRecord对象的特定实例的验证。我想在reservation.close时跳过所有验证!叫做。希望调用reservation.close!(:validate=>false)之类的东西。仅供引用,我们正在使用https://github.com/pluginaweek/state_machine用于状态机。这是我的预订模型的示例。classReservation["requested","negotiating","approved"])}state_machine:initial=>'requested

    7. ruby - 如何在 Rails 4 中使用表单对象之前的验证回调? - 2

      我有一个服务模型/表及其注册表。在表单中,我几乎拥有服务的所有字段,但我想在验证服务对象之前自动设置其中一些值。示例:--服务Controller#创建Action:defcreate@service=Service.new@service_form=ServiceFormObject.new(@service)@service_form.validate(params[:service_form_object])and@service_form.saverespond_with(@service_form,location:admin_services_path)end在验证@ser

    8. ruby - 如何验证 IO.copy_stream 是否成功 - 2

      这里有一个很好的答案解释了如何在Ruby中下载文件而不将其加载到内存中:https://stackoverflow.com/a/29743394/4852737require'open-uri'download=open('http://example.com/image.png')IO.copy_stream(download,'~/image.png')我如何验证下载文件的IO.copy_stream调用是否真的成功——这意味着下载的文件与我打算下载的文件完全相同,而不是下载一半的损坏文件?documentation说IO.copy_stream返回它复制的字节数,但是当我还没有下

    9. c# - 如何在 ruby​​ 中调用 C# dll? - 2

      如何在ruby​​中调用C#dll? 最佳答案 我能想到几种可能性:为您的DLL编写(或找人编写)一个COM包装器,如果它还没有,则使用Ruby的WIN32OLE库来调用它;看看RubyCLR,其中一位作者是JohnLam,他继续在Microsoft从事IronRuby方面的工作。(估计不会再维护了,可能不支持.Net2.0以上的版本);正如其他地方已经提到的,看看使用IronRuby,如果这是您的技术选择。有一个主题是here.请注意,最后一篇文章实际上来自JohnLam(看起来像是2009年3月),他似乎很自在地断言RubyCL

    10. C# 到 Ruby sha1 base64 编码 - 2

      我正在尝试在Ruby中复制Convert.ToBase64String()行为。这是我的C#代码:varsha1=newSHA1CryptoServiceProvider();varpasswordBytes=Encoding.UTF8.GetBytes("password");varpasswordHash=sha1.ComputeHash(passwordBytes);returnConvert.ToBase64String(passwordHash);//returns"W6ph5Mm5Pz8GgiULbPgzG37mj9g="当我在Ruby中尝试同样的事情时,我得到了相同sha

    随机推荐