Web API使用记录系列（四）OAuth授权与身份校验

　　呼，开干第四篇，基于OWIN搭建OAuth认证授权服务器与接口身份校验。

　　OAuth包含授权码模式、密码模式、客户端模式和简化模式，这里我们文章记录的是密码模式和客户端模式。

　　目录

　　引用安装

　　授权处理-发放Token

　　　　用户名密码授权

　　　　客户端授权

　　身份校验-校验失败自定义返回信息

　　TestClient增加token获取

　　一、引用安装

　　除了Owin使用时安装的引用外，还需要安装以下引用　　

　　Microsoft.Owin.Security.OAuth

　　Microsoft.Owin.Security.Cookies

　　Microsoft.AspNet.Identity.Owin

　　二、搭建授权认证

　　修改StartUp，添加关键词partial

　　在App_Start下新建StartUp.Auth，同样使用关键词partial，添加ConfiguerAuth，代码如下：

　　

 public partial class StartUp
     {
         /// <summary>
         /// OAuth配置
         /// </summary>
         /// <param name="app"></param>
         public void ConfigureAuth(IAppBuilder app)
         {
             app.UseOAuthBearerTokens(new OAuthAuthorizationServerOptions
             {
                 AllowInsecureHttp = true,
                 TokenEndpointPath = new PathString("/api/token"),//授权地址
                 AccessTokenExpireTimeSpan = TimeSpan.FromHours(), //过期时间
                 AuthenticationMode = Microsoft.Owin.Security.AuthenticationMode.Active,
                 Provider = new SampleAuthorizationServerProvider() //授权服务
             });
         }
     }

　　SampleAuthorizationServerProvider是提供授权服务的方法，继承自OAuthAuthorizationServerProvider，包含客户端认证和用户名密码认证，代码如下

 /// <summary>
     /// 授权服务
     /// </summary>
     public class SampleAuthorizationServerProvider : OAuthAuthorizationServerProvider
     {
         #region 客户端授权
         /// <summary>
         /// 客户端验证
         /// </summary>
         /// <param name="context"></param>
         /// <returns></returns>
         public override Task ValidateClientAuthentication(OAuthValidateClientAuthenticationContext context)
         {
             string clientId = "";
             string clientSecret = "";
             //获取传入的客户端id和客户端校验码
             context.TryGetFormCredentials(out clientId, out clientSecret);
             if (clientId == "发放的客户端id" && clientSecret == "发放的客户端校验码")
             {
                 context.Validated(clientId);
             }
             else
             {
                 context.SetError("invalid_client", "client is not valid");
             }
             return base.ValidateClientAuthentication(context);
         }

         /// <summary>
         /// 客户端授权-生成access token
         /// </summary>
         /// <param name="context"></param>
         /// <returns></returns>
         public override Task GrantClientCredentials(OAuthGrantClientCredentialsContext context)
         {
             var oAuthIdentity = new ClaimsIdentity(context.Options.AuthenticationType);
             oAuthIdentity.AddClaim(new Claim(ClaimTypes.Name, "app"));//可以继续加一些其它信息
             var ticket = new AuthenticationTicket(oAuthIdentity, new AuthenticationProperties() { AllowRefresh = false });
             context.Validated(ticket);
             return base.GrantClientCredentials(context);
         }
         #endregion

         #region 用户名密码授权
         public override Task GrantResourceOwnerCredentials(OAuthGrantResourceOwnerCredentialsContext context)
         {
             if (context.UserName == "用户名" && context.Password == "用户密码")
             {
                 var props = new AuthenticationProperties(new Dictionary<string, string>
                 {
                     {
                         "userName", context.UserName
                     }
                 });
                 var identity = new ClaimsIdentity("userinfo");
                 identity.AddClaim(new Claim("DisplayName", "张三"));
                 identity.AddClaim(new Claim("DutyName", "总监"));

                 var ticket = new AuthenticationTicket(identity, props);

                 context.Validated(ticket);
             }
             else
             {
                 context.SetError("invalid_user", "username or password error");
             }
             return base.GrantResourceOwnerCredentials(context);
         }
         #endregion

     }

　 在根目录App_Start中增加  ConfigureAuth(app);

　 请求Token（以客户端验证为示例）

           $.ajax({
                 url: '/api/token',
                 type: 'post',
                 data: {
                     "grant_type": "client_credentials",
                     "client_id": $("#clientid").val(),
                     "client_secret": $("#clientscuret").val()
                 },
                 dataType: "json",
                 success: function (data) {
                     var accessToken = data.access_token;
                     console.log("获取到的token："+accessToken);
                 }
             });    

　　三、身份认证与身份认证失败自定义返回

　　增加身份认证，只需要在需要使用的controller上增加 特性 [Authorize]

　　不需要启用验证的使用特性 [AllowAnonymous]

　　认证失败返回401，但为了和我们项目的返回数据结构一致，我们需要在认证失败的时候修改返回，新建过滤器继承AuthorizeAttribute，完事将使用Authorized的地方替换为自定义的过滤器

　　

 public class CustomAuthorizeAttribute:AuthorizeAttribute
     {
         protected override void HandleUnauthorizedRequest(HttpActionContext actionContext)
         {
             base.HandleUnauthorizedRequest(actionContext);
             actionContext.Response = new HttpResponseMessage(System.Net.HttpStatusCode.OK)
             {
                 Content = new StringContent("项目返回的数据格式数据")
             };
         }
     }

　　四、TestClient

　　为了方便在线测试接口添加token的方便，我们需要给弹出的调用窗口增加authorization的header信息、获取token的操作；并将获取到的token存储到cookie，打开窗口时存在自填充，省去每次的获取操作

　　》文件TestClientDialogs文件，在<div class="panel"> 内添加如下代码

　　

 <div style="margin-bottom:10px;background:#EFEFEF;border:1px solid #ccc;padding:10px">
             <div>
                 客户端id：
                 <input type="text" id="clientid" value="admin" />
                 客户端securet:
                 <input type="password" id="clinetsecuret" value="admin" />
                 <a href='javascript:;' id="btngettk">获取 Token</a>
             </div>
             <div style="padding:5px;background:#ffd800;" id="getmsg"> <span> 正在获取Token,请稍后...</span></div>
         </div>

         <hr />

　　》WebApiTestClient.js中修改如下（TestClientViewModel方法末尾添加）：

 //支持弹出窗口自动填充token
         var accessToken;
         try {
             accessToken = $.cookie("token");
         } catch (e) {
             console.log(e);
         }
         addOrReplaceHeader(self.RequestHeaders, "authorization", "Bearer " + accessToken);
         //不存在token时点击获取按钮获取token
         $("#getmsg").hide();
         $("#btngettk").click(function () {
             $("#getmsg").show();
             $.ajax({
                 url: '/api/token',
                 type: 'post',
                 data: {
                     "grant_type": "client_credentials",
                     "client_id": $("#txtusername").val(),
                     "client_secret": $("#txtpwd").val()
                 },
                 dataType: "json",
                 success: function (data) {
                     var headers = self.RequestHeaders;
                     var accessToken = data.access_token;
                     $.cookie("token", accessToken, { path: "/", expires:  });
                     addOrReplaceHeader(headers, "authorization", "Bearer " + accessToken);
                     $("#getmsg").hide();
                 }
             });

         })

　　

本系列使用记录到此，有用到的再补充，有不对的地方希望大家帮忙指正修改，感谢！