C#進階系列——WebApi 身份認證解決方案：Basic基礎認證 JS組件系列——封裝本身的JS組件，你也能夠
1、爲何須要身份認證
在前言裏面，咱們說了，若是沒有啓用身份認證，那麼任何匿名用戶只要知道了咱們服務的url，就能隨意訪問咱們的服務接口，從而訪問或修改數據庫。javascript
一、咱們不加身份認證，匿名用戶能夠直接經過url隨意訪問接口：
能夠看到，匿名用戶直接經過url就能訪問咱們的數據接口，最終會發生什麼事，你們能夠隨意暢想。css
二、增長了身份認證以後，只有帶了咱們訪問票據的請求才能訪問咱們的接口。
例如咱們直接經過url訪問，會返回401html
若是是正常流程的請求，帶了票據，就OK了。前端
能夠看到，正常流程的請求，會在請求報文的頭裏面增長Authorization這一項，它的值就是咱們的Ticket票據信息。java
2、Basic基礎認證的原理解析
一、常見的認證方式
咱們知道，asp.net的認證機制有不少種。對於WebApi也不例外，常見的認證方式有jquery
- FORM身份驗證
- 集成WINDOWS驗證
- Basic基礎認證
- Digest摘要認證
園子裏不少關於WebApi認證的文章，各類認證方式都會涉及到，但感受都不夠細。這裏也並不想去研究哪一種驗證方式適用哪一種使用場景，由於博主仍是以爲「貪多嚼不爛」，也多是博主能力所限。對於認證機制，弄懂其中一種，其餘的都能融會貫通。此篇就使用Basic基礎認證來詳細講解下整個的過程。ajax
二、Basic基礎認證原理
咱們知道，認證的目的在於安全，那麼如何能保證安全呢？經常使用的手段天然是加密。Basic認證也不例外，主要原理就是加密用戶信息，生成票據，每次請求的時候將票據帶過來驗證。這樣說可能有點抽象，咱們詳細分解每一個步驟：數據庫
- 首先登錄的時候驗證用戶名、密碼，若是登錄成功，則將用戶名、密碼按照必定的規則生成加密的票據信息Ticket，將票據信息返回到前端。
- 若是登錄成功，前端會收到票據信息，而後跳轉到主界面，而且將票據信息也帶到主界面的ActionResult裏面(例如跳轉的url能夠這樣寫：/Home/Index?Ticket=Ticket)
- 在主界面的ActionResult裏面經過參數獲得票據信息Ticket，而後將Ticket信息保存到ViewBag裏面傳到前端。
- 在主界面的前端，發送Ajax請求的時候將票據信息加入到請求的Head裏面，將票據信息隨着請求一塊兒發送到服務端去。
- 在WebApi服務裏面定義一個類，繼承AuthorizeAttribute類，而後重寫父類的OnAuthorization方法，在OnAuthorization方法裏面取到當前http請求的Head，從Head裏面取到咱們前端傳過來的票據信息。解密票據信息，從解密的信息裏面獲得用戶名和密碼，而後驗證用戶名和密碼是否正確。若是正確，表示驗證經過，不然返回未驗證的請求401。
這個基本的原理。下面就按照這個原理來看看每一步的代碼如何實現。bootstrap
3、Basic基礎認證的代碼示例
首先說下咱們的示例場景，上次介紹 CORS 的時候咱們在一個解決方案裏面放了兩個項目Web和WebApiCORS，咱們此次仍是以這個爲例來講明。api
一、登陸過程
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.二、登陸的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。
二、/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); 這一句向請求的報文頭裏面增長票據信息。就是由於這裏加了這一句，因此纔有咱們下圖中的紅線部分：
三、WebApiCORS驗證部分（重點）
咱們看到，上面的/Home/Index頁面裏面發送了ajax請求去訪問服務的 http://localhost:27221/api/Charging/GetAllChargingData 這個接口，那麼咱們在WebApi裏面怎麼去驗證這個請求和合法的請求呢？接下來咱們重點看看驗證的這個過程。
3.一、在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.二、在具體的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。
4、優化
經過上面的幾步，基本就能達到咱們想要的身份認證的效果，可是老是感受不太方便，主要不太方便的點有如下幾個。
- 每次新建一個API，對應的接口上面都要標註 [RequestAuthorize] 這個一個東西，感受好麻煩。
- 每次發送ajax請求，都要在beforeSend事件裏面加 XHR.setRequestHeader('Authorization', 'BasicAuth ' + Ticket); 這個，感受也麻煩。
- 若是有些WebApi服務的某些方法，咱們不想使用這個驗證，讓它能夠匿名用戶驗證（好比咱們的登陸方法Login）。該怎麼處理呢。
關於以上兩點，咱們優化下
一、解決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
二、解決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裏面寫了。
三、解決特殊不想使用驗證的方法
若是咱們某些方法不想使用驗證，使得它可讓匿名用戶訪問，咱們能夠在方法的上面加特性標註 [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;
}
}
相關文章
- 1. C#進階系列——WebApi 身份認證解決方案：Basic基礎認證
- 2. C#進階系列——WebApi身份認證解決方案：Basic基礎認證 （轉)
- 3. WebApi身份認證解決方案（1）：Basic基礎認證
- 4. WebApi身份認證解決方案：Basic基礎認證
- 5. WebApi 身份認證解決方案：Basic基礎認證
- 6. JS組件系列——封裝本身的JS組件，你也能夠
- 7. JS組件系列——封裝本身的JS組件
- 8. c# WebApi之身份驗證：Basic基礎認證
- 9. JS組件系列——本身動手封裝bootstrap-treegrid組件
- 10. OpenStack組件——Keystone身份認證
- 更多相關文章...
- • ASP AdRotator 組件 - ASP 教程
- • C# Windows 文件系統的操作 - C#教程
- • Docker容器實戰(七) - 容器眼光下的文件系統
- • SpringBoot中properties文件不能自動提示解決方法
相關標籤/搜索
每日一句
-
每一个你不满意的现在，都有一个你没有努力的曾经。
歡迎關注本站公眾號,獲取更多信息
相關文章
- 1. C#進階系列——WebApi 身份認證解決方案：Basic基礎認證
- 2. C#進階系列——WebApi身份認證解決方案：Basic基礎認證 （轉)
- 3. WebApi身份認證解決方案（1）：Basic基礎認證
- 4. WebApi身份認證解決方案：Basic基礎認證
- 5. WebApi 身份認證解決方案：Basic基礎認證
- 6. JS組件系列——封裝本身的JS組件，你也能夠
- 7. JS組件系列——封裝本身的JS組件
- 8. c# WebApi之身份驗證：Basic基礎認證
- 9. JS組件系列——本身動手封裝bootstrap-treegrid組件
- 10. OpenStack組件——Keystone身份認證