前言:最近,討論到數據庫安全的問題,於是就引出了WebApi服務沒有加任何驗證的問題。也就是說,任何人只要知道了接口的url,都能夠模擬http請求去訪問我們的服務接口,從而去增刪改查數據庫,這后果想想都恐怖。經過一番折騰,總算是加上了接口的身份認證,在此記錄下,也給需要做身份認證的園友們提供參考。
WebApi系列文章
- C#進階系列——WebApi接口測試工具:WebApiTestClient
- C#進階系列——WebApi 跨域問題解決方案:CORS
- C#進階系列——WebApi身份認證解決方案:Basic基礎認證
- C#進階系列——WebApi接口傳參不再困惑:傳參詳解
- C#進階系列——WebApi接口返回值不困惑:返回值類型詳解
- C#進階系列——WebApi異常處理解決方案
- C#進階系列——WebApi區域Area使用小結
一、為什么需要身份認證
在前言里面,我們說了,如果沒有啟用身份認證,那么任何匿名用戶只要知道了我們服務的url,就能隨意訪問我們的服務接口,從而訪問或修改數據庫。
1、我們不加身份認證,匿名用戶可以直接通過url隨意訪問接口:
可以看到,匿名用戶直接通過url就能訪問我們的數據接口,最終會發生什么事,大家可以隨意暢想。
2、增加了身份認證之后,只有帶了我們訪問票據的請求才能訪問我們的接口。
例如我們直接通過url訪問,會返回401
如果是正常流程的請求,帶了票據,就OK了。
可以看到,正常流程的請求,會在請求報文的頭里面增加Authorization這一項,它的值就是我們的Ticket票據信息。
二、Basic基礎認證的原理解析
1、常見的認證方式
我們知道,asp.net的認證機制有很多種。對於WebApi也不例外,常見的認證方式有
- FORM身份驗證
- 集成WINDOWS驗證
- Basic基礎認證
- Digest摘要認證
園子里很多關於WebApi認證的文章,各種認證方式都會涉及到,但感覺都不夠細。這里也並不想去研究哪種驗證方式適用哪種使用場景,因為博主還是覺得“貪多嚼不爛”,也可能是博主能力所限。對於認證機制,弄懂其中一種,其他的都能融會貫通。此篇就使用Basic基礎認證來詳細講解下整個的過程。
2、Basic基礎認證原理
我們知道,認證的目的在於安全,那么如何能保證安全呢?常用的手段自然是加密。Basic認證也不例外,主要原理就是加密用戶信息,生成票據,每次請求的時候將票據帶過來驗證。這樣說可能有點抽象,我們詳細分解每個步驟:
- 首先登陸的時候驗證用戶名、密碼,如果登陸成功,則將用戶名、密碼按照一定的規則生成加密的票據信息Ticket,將票據信息返回到前端。
- 如果登陸成功,前端會收到票據信息,然后跳轉到主界面,並且將票據信息也帶到主界面的ActionResult里面(例如跳轉的url可以這樣寫:/Home/Index?Ticket=Ticket)
- 在主界面的ActionResult里面通過參數得到票據信息Ticket,然后將Ticket信息保存到ViewBag里面傳到前端。
- 在主界面的前端,發送Ajax請求的時候將票據信息加入到請求的Head里面,將票據信息隨着請求一起發送到服務端去。
- 在WebApi服務里面定義一個類,繼承AuthorizeAttribute類,然后重寫父類的OnAuthorization方法,在OnAuthorization方法里面取到當前http請求的Head,從Head里面取到我們前端傳過來的票據信息。解密票據信息,從解密的信息里面得到用戶名和密碼,然后驗證用戶名和密碼是否正確。如果正確,表示驗證通過,否則返回未驗證的請求401。
這個基本的原理。下面就按照這個原理來看看每一步的代碼如何實現。
三、Basic基礎認證的代碼示例
首先說下我們的示例場景,上次介紹 CORS 的時候我們在一個解決方案里面放了兩個項目Web和WebApiCORS,我們這次還是以這個為例來說明。
1、登錄過程
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("登錄成功");
//登錄成功之后將用戶名和用戶票據帶到主界面 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); //返回登錄結果、用戶信息、用戶驗證票據信息 var oUser = new UserInfo { bRes = true, UserName = strUser, Password = strPwd, Ticket = FormsAuthentication.Encrypt(ticket) }; //將身份信息保存在session中,驗證當前請求是否是有效請求 HttpContext.Current.Session[strUser] = oUser; return oUser; } //校驗用戶名密碼(正式環境中應該是數據庫校驗) 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; } }
這里有一點需要注意的是,因為WebApi默認是沒有開啟Session的,所以需要我們作一下配置,手動去啟用session。如何開啟WebApi里面的Session,請參考:http://www.cnblogs.com/tinya/p/4563641.html
正如上面的原理部分說的,登錄如果失敗,則直接返回;如果成功,則將生成的票據Ticket帶到前端,傳到主界面/Home/Index,下面,我們就來看看主界面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"> //打開頁面的時候保存票據信息 var UserName = '@ViewBag.UserName'; var Ticket = '@ViewBag.Ticket'; </script> </head> <body> <div>當前登錄用戶:'@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) { //發送ajax請求之前向http的head里面加入驗證信息 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 () { } }); });
這里需要說明的是,我們在發送ajax請求之前,通過 XHR.setRequestHeader('Authorization', 'BasicAuth ' + Ticket); 這一句向請求的報文頭里面增加票據信息。就是因為這里加了這一句,所以才有我們下圖中的紅線部分:
3、WebApiCORS驗證部分(重點)
我們看到,上面的/Home/Index頁面里面發送了ajax請求去訪問服務的 http://localhost:27221/api/Charging/GetAllChargingData 這個接口,那么我們在WebApi里面怎么去驗證這個請求和合法的請求呢?接下來我們重點看看驗證的這個過程。
3.1、在WebApiCORS項目里面自定義一個類RequestAuthorizeAttribute,去繼承我們的AuthorizeAttribute這個類。然后重寫OnAuthorization方法,在這個方法里面取到請求頭的Ticket信息,然后校驗用戶名密碼是否合理。
/// <summary> /// 自定義此特性用於接口的身份驗證 /// </summary> public class RequestAuthorizeAttribute : AuthorizeAttribute { //重寫基類的驗證方式,加入我們自定義的Ticket驗證 public override void OnAuthorization(System.Web.Http.Controllers.HttpActionContext actionContext) { //從http請求的頭里面獲取身份驗證信息,驗證是否是請求發起方的ticket var authorization = actionContext.Request.Headers.Authorization; if ((authorization != null) && (authorization.Parameter != null)) { //解密用戶ticket,並校驗用戶名密碼是否匹配 var encryptTicket = authorization.Parameter; if (ValidateTicket(encryptTicket)) { base.IsAuthorized(actionContext); } else { HandleUnauthorizedRequest(actionContext); } } //如果取不到身份驗證信息,並且不允許匿名訪問,則返回未驗證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); } } //校驗用戶名密碼(正式環境中應該是數據庫校驗) 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> /// 得到所有數據 /// </summary> /// <returns>返回數據</returns> [HttpGet] public string GetAllChargingData() { return "Success"; } /// <summary> /// 得到當前Id的所有數據 /// </summary> /// <param name="id">參數Id</param> /// <returns>返回數據</returns> [HttpGet] public string GetAllChargingData(string id) { return "ChargingData" + id; } }
增加了特性標注之后,每次請求這個API里面的接口之前,程序會先進入到我們override過的 OnAuthorization() 方法里面,驗證通過之后,才會進到相應的方法里面去執行,否則返回401。
四、優化
通過上面的幾步,基本就能達到我們想要的身份認證的效果,但是總是感覺不太方便,主要不太方便的點有以下幾個。
- 每次新建一個API,對應的接口上面都要標注 [RequestAuthorize] 這個一個東西,感覺好麻煩。
- 每次發送ajax請求,都要在beforeSend事件里面加 XHR.setRequestHeader('Authorization', 'BasicAuth ' + Ticket); 這個,感覺也麻煩。
- 如果有些WebApi服務的某些方法,我們不想使用這個驗證,讓它可以匿名用戶驗證(比如我們的登錄方法Login)。該怎么處理呢。
關於以上兩點,我們優化下
1、解決API的問題
在API里面加一個公共的父類,在父類上面標注 [RequestAuthorize] 即可。
namespace WebApiCORS.Controllers { [RequestAuthorize] [EnableCors(origins: "*", headers: "*", methods: "*")] public class BaseApiController : ApiController { } }
namespace WebApiCORS.Controllers { public class ChargingController : BaseApiController { /// <summary> /// 得到所有數據 /// </summary> /// <returns>返回數據</returns> [HttpGet] public string GetAllChargingData() { return "Success"; } /// <summary> /// 得到當前Id的所有數據 /// </summary> /// <param name="id">參數Id</param> /// <returns>返回數據</returns> [HttpGet] public string GetAllChargingData(string id) { return "ChargingData" + id; } } }
注意:我們登錄的請求是不需要驗證的,因為登錄的時候還沒有產生票據,所以登錄的API不能夠繼承 BaseApiController
2、解決ajax的問題
還記得我們在 JS組件系列——封裝自己的JS組件,你也可以 這篇里面介紹的增加ajax的error事件的公共處理方法嗎?我們是否也可以通過同樣的機制去增加這個呢。新建一個文件Jquery_ajax_extention.js
(function ($) { //1.得到$.ajax的對象 var _ajax = $.ajax; $.ajax = function (options) { //2.每次調用發送ajax請求的時候定義默認的error處理方法 var fn = { error: function (XMLHttpRequest, textStatus, errorThrown) { toastr.error(XMLHttpRequest.responseText, '錯誤消息', { closeButton: true, timeOut: 0, positionClass: 'toast-top-full-width' }); }, success: function (data, textStatus) { }, beforeSend: function (XHR) { }, complete: function (XHR, TS) { } } //3.擴展原生的$.ajax方法,返回最新的參數 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.將最新的參數傳回ajax對象 _ajax(_options); }; })(jQuery);
引用這個js后再發送ajax不必在每個請求的beforeSend里面寫了。
3、解決特殊不想使用驗證的方法
如果我們某些方法不想使用驗證,使得它可以讓匿名用戶訪問,我們可以在方法的上面加特性標注 [AllowAnonymous] ,申明該方法運行匿名訪問。比如:
public class ChargingController : BaseApiController { /// <summary> /// 得到所有數據 /// </summary> /// <returns>返回數據</returns> [HttpGet] public string GetAllChargingData() { return "Success"; } /// <summary> /// 得到當前Id的所有數據 /// </summary> /// <param name="id">參數Id</param> /// <returns>返回數據</returns> [HttpGet] [AllowAnonymous] public string GetAllChargingData(string id) { return "ChargingData" + id; } }
五、總結
以上結合一個實例講解了下Basic認證的實現原理以及簡單使用,本文觀點都是來自博主自己的理解,如果有不全面的地方,還望園友們斧正。如果本文能夠或多或少幫到你,不妨幫忙推薦,博主一定繼續努力~~