C#進(jìn)階系列 WebApi身份認(rèn)證解決方案推薦:Basic基礎(chǔ)認(rèn)證

更新時(shí)間：2016年03月24日 14:31:24 投稿：jingxian

下面小編就為大家?guī)?lái)一篇C#進(jìn)階系列 WebApi身份認(rèn)證解決方案推薦:Basic基礎(chǔ)認(rèn)證。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家。給大家一個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧

前言：最近，討論到數(shù)據(jù)庫(kù)安全的問(wèn)題，于是就引出了WebApi服務(wù)沒(méi)有加任何驗(yàn)證的問(wèn)題。也就是說(shuō)，任何人只要知道了接口的url，都能夠模擬http請(qǐng)求去訪問(wèn)我們的服務(wù)接口，從而去增刪改查數(shù)據(jù)庫(kù)，這后果想想都恐怖。經(jīng)過(guò)一番折騰，總算是加上了接口的身份認(rèn)證，在此記錄下，也給需要做身份認(rèn)證的園友們提供參考。

一、為什么需要身份認(rèn)證

在前言里面，我們說(shuō)了，如果沒(méi)有啟用身份認(rèn)證，那么任何匿名用戶只要知道了我們服務(wù)的url，就能隨意訪問(wèn)我們的服務(wù)接口，從而訪問(wèn)或修改數(shù)據(jù)庫(kù)。

1、我們不加身份認(rèn)證，匿名用戶可以直接通過(guò)url隨意訪問(wèn)接口：

可以看到，匿名用戶直接通過(guò)url就能訪問(wèn)我們的數(shù)據(jù)接口，最終會(huì)發(fā)生什么事，大家可以隨意暢想。

2、增加了身份認(rèn)證之后，只有帶了我們?cè)L問(wèn)票據(jù)的請(qǐng)求才能訪問(wèn)我們的接口。

例如我們直接通過(guò)url訪問(wèn)，會(huì)返回401

如果是正常流程的請(qǐng)求，帶了票據(jù)，就OK了。

可以看到，正常流程的請(qǐng)求，會(huì)在請(qǐng)求報(bào)文的頭里面增加Authorization這一項(xiàng)，它的值就是我們的Ticket票據(jù)信息。

二、Basic基礎(chǔ)認(rèn)證的原理解析

1、常見(jiàn)的認(rèn)證方式

我們知道，asp.net的認(rèn)證機(jī)制有很多種。對(duì)于WebApi也不例外，常見(jiàn)的認(rèn)證方式有

FORM身份驗(yàn)證
集成WINDOWS驗(yàn)證
Basic基礎(chǔ)認(rèn)證
Digest摘要認(rèn)證

園子里很多關(guān)于WebApi認(rèn)證的文章，各種認(rèn)證方式都會(huì)涉及到，但感覺(jué)都不夠細(xì)。這里也并不想去研究哪種驗(yàn)證方式適用哪種使用場(chǎng)景，因?yàn)椴┲鬟€是覺(jué)得“貪多嚼不爛”，也可能是博主能力所限。對(duì)于認(rèn)證機(jī)制，弄懂其中一種，其他的都能融會(huì)貫通。此篇就使用Basic基礎(chǔ)認(rèn)證來(lái)詳細(xì)講解下整個(gè)的過(guò)程。

2、Basic基礎(chǔ)認(rèn)證原理

我們知道，認(rèn)證的目的在于安全，那么如何能保證安全呢？常用的手段自然是加密。Basic認(rèn)證也不例外，主要原理就是加密用戶信息，生成票據(jù)，每次請(qǐng)求的時(shí)候?qū)⑵睋?jù)帶過(guò)來(lái)驗(yàn)證。這樣說(shuō)可能有點(diǎn)抽象，我們?cè)敿?xì)分解每個(gè)步驟：

首先登陸的時(shí)候驗(yàn)證用戶名、密碼，如果登陸成功，則將用戶名、密碼按照一定的規(guī)則生成加密的票據(jù)信息Ticket，將票據(jù)信息返回到前端。
如果登陸成功，前端會(huì)收到票據(jù)信息，然后跳轉(zhuǎn)到主界面，并且將票據(jù)信息也帶到主界面的ActionResult里面(例如跳轉(zhuǎn)的url可以這樣寫(xiě)：/Home/Index?Ticket=Ticket)
在主界面的ActionResult里面通過(guò)參數(shù)得到票據(jù)信息Ticket，然后將Ticket信息保存到ViewBag里面?zhèn)鞯角岸恕?/li>
在主界面的前端，發(fā)送Ajax請(qǐng)求的時(shí)候?qū)⑵睋?jù)信息加入到請(qǐng)求的Head里面，將票據(jù)信息隨著請(qǐng)求一起發(fā)送到服務(wù)端去。
在WebApi服務(wù)里面定義一個(gè)類，繼承AuthorizeAttribute類，然后重寫(xiě)父類的OnAuthorization方法，在OnAuthorization方法里面取到當(dāng)前http請(qǐng)求的Head，從Head里面取到我們前端傳過(guò)來(lái)的票據(jù)信息。解密票據(jù)信息，從解密的信息里面得到用戶名和密碼，然后驗(yàn)證用戶名和密碼是否正確。如果正確，表示驗(yàn)證通過(guò)，否則返回未驗(yàn)證的請(qǐng)求401。

這個(gè)基本的原理。下面就按照這個(gè)原理來(lái)看看每一步的代碼如何實(shí)現(xiàn)。

三、Basic基礎(chǔ)認(rèn)證的代碼示例

首先說(shuō)下我們的示例場(chǎng)景，上次介紹 CORS 的時(shí)候我們?cè)谝粋€(gè)解決方案里面放了兩個(gè)項(xiàng)目Web和WebApiCORS，我們這次還是以這個(gè)為例來(lái)說(shuō)明。

1、登錄過(guò)程1.1、Web前端

<body>
 <div style="text-align:center;"> 
  <div>用戶名：<input type="text" id="txt_username" /></div>
  <div>密 碼：<input type="password" id="txt_password" /></div>
  <div><input type="button" value="登錄" id="btn_login" class="btn-default" /></div>
 </div>
</body>

$(function () {
 $("#btn_login").click(function () {
  $.ajax({
   type: "get",
   url: "http://localhost:27221/api/User/Login",
   data: { strUser: $("#txt_username").val(), strPwd: $("#txt_password").val() },
   success: function (data, status) {
    if (status == "success") {
     if (!data.bRes){
      alert("登錄失敗");
      return;
     }
     alert("登錄成功");
　　　　　　　　　　　 //登錄成功之后將用戶名和用戶票據(jù)帶到主界面
     window.location = "/Home/Index?UserName=" + data.UserName + "&Ticket=" + data.Ticket;
    }
   },
   error: function (e) {
   },
   complete: function () {

   }

  });
 });
});

1.2、登錄的API接口

　　public class UserController : ApiController
 {
  /// <summary>
  /// 用戶登錄
  /// </summary>
  /// <param name="strUser"></param>
  /// <param name="strPwd"></param>
  /// <returns></returns>
  [HttpGet]
  public object Login(string strUser, string strPwd)
  {
   if (!ValidateUser(strUser, strPwd))
   {
    return new { bRes = false };
   }
   FormsAuthenticationTicket ticket = new FormsAuthenticationTicket(0, strUser, DateTime.Now,
       DateTime.Now.AddHours(1), true, string.Format("{0}&{1}", strUser, strPwd),
       FormsAuthentication.FormsCookiePath);
   //返回登錄結(jié)果、用戶信息、用戶驗(yàn)證票據(jù)信息
   var oUser = new UserInfo { bRes = true, UserName = strUser, Password = strPwd, Ticket = FormsAuthentication.Encrypt(ticket) };
   //將身份信息保存在session中，驗(yàn)證當(dāng)前請(qǐng)求是否是有效請(qǐng)求
   HttpContext.Current.Session[strUser] = oUser;
   return oUser;
  }

  //校驗(yàn)用戶名密碼（正式環(huán)境中應(yīng)該是數(shù)據(jù)庫(kù)校驗(yàn)）
  private bool ValidateUser(string strUser, string strPwd)
  {
   if (strUser == "admin" && strPwd == "123456")
   {
    return true;
   }
   else
   {
    return false;
   }
  }
 }

 public class UserInfo
 {
  public bool bRes { get; set; }

  public string UserName { get; set; }

  public string Password { get; set; }

  public string Ticket { get; set; }
 }

這里有一點(diǎn)需要注意的是，因?yàn)閃ebApi默認(rèn)是沒(méi)有開(kāi)啟Session的，所以需要我們作一下配置，手動(dòng)去啟用session。，請(qǐng)參考：http://www.dbjr.com.cn/article/143197.htm

正如上面的原理部分說(shuō)的，登錄如果失敗，則直接返回；如果成功，則將生成的票據(jù)Ticket帶到前端，傳到主界面/Home/Index，下面，我們就來(lái)看看主界面Home/Index。

2、/Home/Index主界面

　　public class HomeController : Controller
 {
  // GET: Home
  public ActionResult Index(string UserName, string Ticket)
  {
   ViewBag.UserName = UserName;
   ViewBag.Ticket = Ticket;
   return View();
  }
 }

<html>
<head>
 <meta name="viewport" content="width=device-width" />
 <title>Index</title>
 <script src="~/Content/jquery-1.9.1.js"></script>
 <link href="~/Content/bootstrap/css/bootstrap.css" rel="stylesheet" />
 <script src="~/Content/bootstrap/js/bootstrap.js"></script>
 <script src="~/Scripts/Home/Index.js"></script>
 <script type="text/javascript">
  //打開(kāi)頁(yè)面的時(shí)候保存票據(jù)信息
  var UserName = '@ViewBag.UserName';
  var Ticket = '@ViewBag.Ticket';
 </script>
</head>
<body>
 <div>當(dāng)前登錄用戶：'@ViewBag.UserName'</div>

 <div id="div_test">

 </div>
</body>
</html>

$(function () {
 $.ajax({
  type: "get",
  url: "http://localhost:27221/api/Charging/GetAllChargingData",
  data: {},
  beforeSend: function (XHR) {
   //發(fā)送ajax請(qǐng)求之前向http的head里面加入驗(yàn)證信息
   XHR.setRequestHeader('Authorization', 'BasicAuth ' + Ticket);
  },
  success: function (data, status) {
   if (status == "success") {
    $("#div_test").html(data);
   }
  },
  error: function (e) {
   $("#div_test").html("Error");
  },
  complete: function () {

  }

 });
});

這里需要說(shuō)明的是，我們?cè)诎l(fā)送ajax請(qǐng)求之前，通過(guò) XHR.setRequestHeader('Authorization', 'BasicAuth ' + Ticket); 這一句向請(qǐng)求的報(bào)文頭里面增加票據(jù)信息。就是因?yàn)檫@里加了這一句，所以才有我們下圖中的紅線部分：

3、WebApiCORS驗(yàn)證部分（重點(diǎn)）

我們看到，上面的/Home/Index頁(yè)面里面發(fā)送了ajax請(qǐng)求去訪問(wèn)服務(wù)的 http://localhost:27221/api/Charging/GetAllChargingData 這個(gè)接口，那么我們?cè)赪ebApi里面怎么去驗(yàn)證這個(gè)請(qǐng)求和合法的請(qǐng)求呢？接下來(lái)我們重點(diǎn)看看驗(yàn)證的這個(gè)過(guò)程。

3.1、在WebApiCORS項(xiàng)目里面自定義一個(gè)類RequestAuthorizeAttribute，去繼承我們的AuthorizeAttribute這個(gè)類。然后重寫(xiě)OnAuthorization方法，在這個(gè)方法里面取到請(qǐng)求頭的Ticket信息，然后校驗(yàn)用戶名密碼是否合理。

　　 /// <summary>
 /// 自定義此特性用于接口的身份驗(yàn)證
 /// </summary>
 public class RequestAuthorizeAttribute : AuthorizeAttribute
 {
  //重寫(xiě)基類的驗(yàn)證方式，加入我們自定義的Ticket驗(yàn)證
  public override void OnAuthorization(System.Web.Http.Controllers.HttpActionContext actionContext)
  {
   //從http請(qǐng)求的頭里面獲取身份驗(yàn)證信息，驗(yàn)證是否是請(qǐng)求發(fā)起方的ticket
   var authorization = actionContext.Request.Headers.Authorization;
   if ((authorization != null) && (authorization.Parameter != null))
   {
    //解密用戶ticket,并校驗(yàn)用戶名密碼是否匹配
    var encryptTicket = authorization.Parameter;
    if (ValidateTicket(encryptTicket))
    {
     base.IsAuthorized(actionContext);
    }
    else
    {
     HandleUnauthorizedRequest(actionContext);
    }
   }
   //如果取不到身份驗(yàn)證信息，并且不允許匿名訪問(wèn)，則返回未驗(yàn)證401
   else
   {
    var attributes = actionContext.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().OfType<AllowAnonymousAttribute>();
    bool isAnonymous = attributes.Any(a => a is AllowAnonymousAttribute);
    if (isAnonymous) base.OnAuthorization(actionContext);
    else HandleUnauthorizedRequest(actionContext);
   }
  }

  //校驗(yàn)用戶名密碼（正式環(huán)境中應(yīng)該是數(shù)據(jù)庫(kù)校驗(yàn)）
  private bool ValidateTicket(string encryptTicket)
  {
   //解密Ticket
   var strTicket = FormsAuthentication.Decrypt(encryptTicket).UserData;

   //從Ticket里面獲取用戶名和密碼
   var index = strTicket.IndexOf("&");
   string strUser = strTicket.Substring(0, index);
   string strPwd = strTicket.Substring(index + 1);

   if (strUser == "admin" && strPwd == "123456")
   {
    return true;
   }
   else
   {
    return false;
   }
  }
 }

3.2、在具體的Api接口增加我們上面自定義類的特性

[RequestAuthorize]
 public class ChargingController : ApiController
 {
  /// <summary>
  /// 得到所有數(shù)據(jù)
  /// </summary>
  /// <returns>返回?cái)?shù)據(jù)</returns>
  [HttpGet]
  public string GetAllChargingData()
  {
   return "Success";
  }

  /// <summary>
  /// 得到當(dāng)前Id的所有數(shù)據(jù)
  /// </summary>
  /// <param name="id">參數(shù)Id</param>
  /// <returns>返回?cái)?shù)據(jù)</returns>
  [HttpGet]
  public string GetAllChargingData(string id)
  {
   return "ChargingData" + id;
  }

 }

增加了特性標(biāo)注之后，每次請(qǐng)求這個(gè)API里面的接口之前，程序會(huì)先進(jìn)入到我們override過(guò)的 OnAuthorization() 方法里面，驗(yàn)證通過(guò)之后，才會(huì)進(jìn)到相應(yīng)的方法里面去執(zhí)行，否則返回401。

四、優(yōu)化
通過(guò)上面的幾步，基本就能達(dá)到我們想要的身份認(rèn)證的效果，但是總是感覺(jué)不太方便，主要不太方便的點(diǎn)有以下幾個(gè)。

1.每次新建一個(gè)API，對(duì)應(yīng)的接口上面都要標(biāo)注 [RequestAuthorize] 這個(gè)一個(gè)東西，感覺(jué)好麻煩。
2.每次發(fā)送ajax請(qǐng)求，都要在beforeSend事件里面加 XHR.setRequestHeader('Authorization', 'BasicAuth ' + Ticket); 這個(gè)，感覺(jué)也麻煩。
關(guān)于以上兩點(diǎn)，我們優(yōu)化下

1、解決API的問(wèn)題
在API里面加一個(gè)公共的父類，在父類上面標(biāo)注 [RequestAuthorize] 即可。

namespace WebApiCORS.Controllers
{
 [RequestAuthorize]
 [EnableCors(origins: "*", headers: "*", methods: "*")]
 public class BaseApiController : ApiController
 {
 }
}

namespace WebApiCORS.Controllers
{
 public class ChargingController : BaseApiController
 {
  /// <summary>
  /// 得到所有數(shù)據(jù)
  /// </summary>
  /// <returns>返回?cái)?shù)據(jù)</returns>
  [HttpGet]
  public string GetAllChargingData()
  {
   return "Success";
  }

  /// <summary>
  /// 得到當(dāng)前Id的所有數(shù)據(jù)
  /// </summary>
  /// <param name="id">參數(shù)Id</param>
  /// <returns>返回?cái)?shù)據(jù)</returns>
  [HttpGet]
  public string GetAllChargingData(string id)
  {
   return "ChargingData" + id;
  }
　　}
}

注意：我們登錄的請(qǐng)求是不需要驗(yàn)證的，因?yàn)榈卿浀臅r(shí)候還沒(méi)有產(chǎn)生票據(jù)，所以登錄的API不能夠繼承 BaseApiController

2、解決ajax的問(wèn)題
還記得我們?cè)?a target="_blank" href="http://www.dbjr.com.cn/article/112472.htm">JS組件系列——封裝自己的JS組件，你也可以這篇里面介紹的增加ajax的error事件的公共處理方法嗎？我們是否也可以通過(guò)同樣的機(jī)制去增加這個(gè)呢。新建一個(gè)文件Jquery_ajax_extention.js

(function ($) {
 //1.得到$.ajax的對(duì)象
 var _ajax = $.ajax;
 $.ajax = function (options) {
  //2.每次調(diào)用發(fā)送ajax請(qǐng)求的時(shí)候定義默認(rèn)的error處理方法
  var fn = {
   error: function (XMLHttpRequest, textStatus, errorThrown) {
    toastr.error(XMLHttpRequest.responseText, '錯(cuò)誤消息', { closeButton: true, timeOut: 0, positionClass: 'toast-top-full-width' });
   },
   success: function (data, textStatus) { },
   beforeSend: function (XHR) { },
   complete: function (XHR, TS) { }
  }
  //3.擴(kuò)展原生的$.ajax方法，返回最新的參數(shù)
  var _options = $.extend({}, {
   error: function (XMLHttpRequest, textStatus, errorThrown) {
    fn.error(XMLHttpRequest, textStatus, errorThrown);
   },
   success: function (data, textStatus) {
    fn.success(data, textStatus);
   },
   beforeSend: function (XHR) {
    XHR.setRequestHeader('Authorization', 'BasicAuth ' + Ticket);
    fn.beforeSend(XHR);
   },
   complete: function (XHR, TS) {
    fn.complete(XHR, TS);
   }
  }, options);
  //4.將最新的參數(shù)傳回ajax對(duì)象
  _ajax(_options);
 };
})(jQuery);

引用這個(gè)js后再發(fā)送ajax不必在每個(gè)請(qǐng)求的beforeSend里面寫(xiě)了。

五、總結(jié)
以上結(jié)合一個(gè)實(shí)例講解了下Basic認(rèn)證的實(shí)現(xiàn)原理以及簡(jiǎn)單使用，本文觀點(diǎn)都是來(lái)自博主自己的理解，如果有不全面的地方，還望園友們斧正。如果本文能夠或多或少幫到你，不妨幫忙推薦

以上這篇C#進(jìn)階系列 WebApi身份認(rèn)證解決方案推薦:Basic基礎(chǔ)認(rèn)證就是小編分享給大家的全部?jī)?nèi)容了，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: