WebApi身份认证解决方案：Basic基础认证

时间  2019-11-06
标签 webapi 身份 认证 解决 方案 basic 基础 繁體版
原文   原文链接

前言：最近，讨论到数据库安全的问题，因而就引出了WebApi服务没有加任何验证的问题。也就是说，任何人只要知道了接口的url，都可以模拟http请求去访问咱们的服务接口，从而去增删改查数据库，这后果想一想都恐怖。通过一番折腾，总算是加上了接口的身份认证，在此记录下，也给须要作身份认证的园友们提供参考。css

1、为何须要身份认证
在前言里面，咱们说了，若是没有启用身份认证，那么任何匿名用户只要知道了咱们服务的url，就能随意访问咱们的服务接口，从而访问或修改数据库。html

一、咱们不加身份认证，匿名用户能够直接经过url随意访问接口：前端

能够看到，匿名用户直接经过url就能访问咱们的数据接口，最终会发生什么事，你们能够随意畅想。ajax

二、增长了身份认证以后，只有带了咱们访问票据的请求才能访问咱们的接口。
例如咱们直接经过url访问，会返回401数据库

若是是正常流程的请求，带了票据，就OK了。bootstrap

能够看到，正常流程的请求，会在请求报文的头里面增长Authorization这一项，它的值就是咱们的Ticket票据信息。api

2、Basic基础认证的原理解析
一、常见的认证方式
咱们知道，asp.net的认证机制有不少种。对于WebApi也不例外，常见的认证方式有安全

FORM身份验证
集成WINDOWS验证
Basic基础认证
Digest摘要认证
园子里不少关于WebApi认证的文章，各类认证方式都会涉及到，但感受都不够细。这里也并不想去研究哪一种验证方式适用哪一种使用场景，由于博主仍是以为“贪多嚼不烂”，也多是博主能力所限。对于认证机制，弄懂其中一种，其余的都能融会贯通。此篇就使用Basic基础认证来详细讲解下整个的过程。session

二、Basic基础认证原理
咱们知道，认证的目的在于安全，那么如何能保证安全呢？经常使用的手段天然是加密。Basic认证也不例外，主要原理就是加密用户信息，生成票据，每次请求的时候将票据带过来验证。这样说可能有点抽象，咱们详细分解每一个步骤：asp.net

首先登录的时候验证用户名、密码，若是登录成功，则将用户名、密码按照必定的规则生成加密的票据信息Ticket，将票据信息返回到前端。
若是登录成功，前端会收到票据信息，而后跳转到主界面，而且将票据信息也带到主界面的ActionResult里面(例如跳转的url能够这样写：/Home/Index?Ticket=Ticket)
在主界面的ActionResult里面经过参数获得票据信息Ticket，而后将Ticket信息保存到ViewBag里面传到前端。
在主界面的前端，发送Ajax请求的时候将票据信息加入到请求的Head里面，将票据信息随着请求一块儿发送到服务端去。
在WebApi服务里面定义一个类，继承AuthorizeAttribute类，而后重写父类的OnAuthorization方法，在OnAuthorization方法里面取到当前http请求的Head，从Head里面取到咱们前端传过来的票据信息。解密票据信息，从解密的信息里面获得用户名和密码，而后验证用户名和密码是否正确。若是正确，表示验证经过，不然返回未验证的请求401。
这个基本的原理。下面就按照这个原理来看看每一步的代码如何实现。

3、Basic基础认证的代码示例
首先说下咱们的示例场景，上次介绍 CORS 的时候咱们在一个解决方案里面放了两个项目Web和WebApiCORS，咱们此次仍是以这个为例来讲明。

一、登陆过程
1.一、Web前端
复制代码


用户名：

密 码：




复制代码
复制代码
$(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
{
///


/// 用户登陆
///
///
///
///
[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();
}
}
复制代码
复制代码



Index







当前登陆用户：'@ViewBag.UserName' 

<div id="div_test">

</div>

复制代码
复制代码
$(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信息，而后校验用户名密码是否合理。
复制代码
　　 ///


/// 自定义此特性用于接口的身份验证
///
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.二、在具体的Api接口增长咱们上面自定义类的特性
复制代码
[RequestAuthorize]
public class ChargingController : ApiController
{
///


/// 获得全部数据
///
/// 返回数据
[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
{
///


/// 获得全部数据
///
/// 返回数据
[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
{
///


/// 获得全部数据
///
/// 返回数据
[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;
    }

　　} 复制代码 5、总结 以上结合一个实例讲解了下Basic认证的实现原理以及简单使用，本文观点都是来自博主本身的理解，若是有不全面的地方，还望园友们斧正。若是本文可以或多或少帮到你，不妨帮忙推荐，博主必定继续努力~~
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程