前言：最近，討論到資料庫安全的問題，於是就引出了WebApi服務沒有加任何驗證的問題。也就是說，任何人只要知道了介面的url，都能夠模擬http請求去訪問我們的服務介面，從而去增刪改查資料庫，這後果想想都恐怖。經過一番折騰，總算是加上了介面的身份認證，
一、為什麼需要身份認證
在前言裡面，我們說了，如果沒有啟用身份認證，那麼任何匿名使用者只要知道了我們服務的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前端
|
1 2 3 4 5 6 7 |
<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> |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
$(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介面
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
public class UserController : ApiController { /// /// 使用者登入 /// /// /// /// [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主介面
|
1 2 3 4 5 6 7 8 9 10 |
public class HomeController : Controller { // GET: Home public ActionResult Index(string UserName, string Ticket) { ViewBag.UserName = UserName; ViewBag.Ticket = Ticket; return View(); } } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
<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> |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
$(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資訊，然後校驗使用者名稱密碼是否合理。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
/// /// 自定義此特性用於介面的身份驗證 /// 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().OfType(); 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介面增加我們上面自定義類的特性
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
[RequestAuthorize] public class ChargingController : ApiController { /// /// 得到所有資料 /// /// 返回資料 [HttpGet] public string GetAllChargingData() { return "Success"; } /// /// 得到當前Id的所有資料 /// /// 引數Id /// 返回資料 [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] 即可。
|
1 2 3 4 5 6 7 8 |
namespace WebApiCORS.Controllers { [RequestAuthorize] [EnableCors(origins: "*", headers: "*", methods: "*")] public class BaseApiController : ApiController { } } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 |
namespace WebApiCORS.Controllers { public class ChargingController : BaseApiController { /// /// 得到所有資料 /// /// 返回資料 [HttpGet] public string GetAllChargingData() { return "Success"; } /// /// 得到當前Id的所有資料 /// /// 引數Id /// 返回資料 [HttpGet] public string GetAllChargingData(string id) { return "ChargingData" + id; } } } |
注意：我們登入的請求是不需要驗證的，因為登入的時候還沒有產生票據，所以登入的API不能夠繼承 BaseApiController
2、解決ajax的問題
還記得我們在 JS元件系列——封裝自己的JS元件，你也可以 這篇裡面介紹的增加ajax的error事件的公共處理方法嗎？我們是否也可以通過同樣的機制去增加這個呢。新建一個檔案Jquery_ajax_extention.js
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
(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] ，申明該方法執行匿名訪問。比如：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
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認證的實現原理以及簡單使用，本文觀點都是來自博主自己的理解。
WebAPI系列文章：