进阶之路—WebAPI的Basic基础认证

之前的文章中,我们熟悉了 WebAPI 同时也了解到,在现在很多公司的项目中已经项目的架构已经有很多不仅仅是建造 MVC 项目了,在很多时候,人们更喜欢建立一个自带 WebAPI  的项目用以代替 MVC 项目,但是在 WebAPI 中,用户权限的认证是比较麻烦的,倘若不设置权限认证,对网站来讲又是不安全的。

WebAPI 的用户权限认证的方式大致可以分为4种,今天我们就来一起探索一下当前比较流行的一种认证方式 Basic 基础认证。

本次的讲解代码源自于网络文章:http://www.cnblogs.com/landeanfen/archive/2016/03/24/5287064.html

接下来,我们看一下程序的目录

项目目录

在新建的一个带 WebAPI 的 MVC 项目中,我创建了一些文件和控制器,还有两个模型。

BasicTestController: 是将被调用的接口功能,

HomeController: 系统自带的,我在里边写了两个 action 一个是登陆用的,一个是主页

MyWebAPITestController: 我在这里边写了登陆功能以及生成票据,返回对象的方法

ValidateUser: 里是登陆的时候用到的查询数据库代码

BasicVerification:是我自定义的一个特性,这个特性是负责判断用户认证的

接下来我们从头开始看代码

HomeController

只有两个 action ,我们首先打开网站默认进入的是 Login() 

js代码
前端代码

再起对应的页面中我嵌套了一段 JS 代码,并且画了两个文本框,一个按钮(丑的一匹),我来用我的理解解释一下 JS 代码片段,就是当你点击按钮的时候,以 Get 方式传一个 Ajax 请求到上面的地址中去,并且传入两个参数(文本框中的值),如果请求成功,就判断返回的对象的 bRes 属性,判断是否登陆成功,失败的话直接提示登陆失败并且返回登陆页面,成功的话提示登陆成功,并跳转到主页。

MyWebAPITestController中的Login action

我们来看一看上面的这段代码,这段代码主要的意义是:当点击完登陆按钮之后,跳转到这个方法,将传入的参数传到另一个验证用户登录方法中,之后生成票据(FormsAuthenticationTicket 生成票据的类,位于 System.Web.Security 命名空间中),最后将查询到的各种属性以及加密后的票据信息存到一个 UserInfo 对象中。(后面的 Session 存不存无所谓,不是重点,我们这个认证用不到 Session,而且在 WebAPI 中开启 Session 需要进行一些设置)。

VerificationUser中的ValidateUser方法

这个方法就是单纯的连接数据库查询登陆用户是否存在的方法,但是在实际的生产环境中这种方法我们是不会写在这里的。此时登陆成功的话,会跳转到程序的主页,也就是 Index 页面中

js代码
前端代码

上图的 JS 中,有一段代码:

XHR.setRequestHeader('Authorization', 'BasicAuth ' + Ticket);

这段代码所表示的含义是在执行 Ajax 请求之前,会向请求的头文件中加入一段名为 Authorization 的"没有意义的"票据信息,这个票据信息就是之前我们生成的票据

在GetUser的请求头文件中的票据信息

接下来,我们看一下在程序中是怎么具体实现 Basic 认证的

BasicVerification中的解密票据信息
BasicVerification中的验证用户存在

上面个两张图是 Basic 验证的具体实现,这个类是我们自定义的一个特性契约,,只需要在想要进行验证的方法的类名上面添加上这个特性就可以了,要注意的是,这个特性必须要继承 AuthorizeAttribute 类(该类需要引用 System.Web.Http 命名空间),之后我们重写父类中的 OnAuthorization 方法:传入从 Http 获取的信息,并获取头信息里的 Authorization 信息,然后跳转到下面的校验用户名信息的方法中,在下面的方法中,先将传入的票据信息解密,然后通过解析字符串的方式取出里面的用户名和密码,然后上数据库中查询。最后返回一个 bool 类型结果拿到第一个方法中判断,如果为真就表示授权成功,反则表示授权失败。

另外说一点,在某些情况中,我们再写被调用的方法的时候,有的方法是不希望有用户验证的,这种情况下我们可以单独的为这个方法标识上      [ RequestAuthorize ] 特性,这样,在调用这个方法的时候就会自动跳过用户认证。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 198,932评论 5 466
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,554评论 2 375
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 145,894评论 0 328
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,442评论 1 268
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,347评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,899评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,325评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,980评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,196评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,163评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,085评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,826评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,389评论 3 302
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,501评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,753评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,171评论 2 344
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,616评论 2 339

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,226评论 25 707
  • 术语http://www.tuicool.com/articles/2mQjIr 本文翻译自IdentitySer...
    灭蒙鸟阅读 8,334评论 1 13
  • 一、概念(载录于:http://www.cnblogs.com/EricaMIN1987_IT/p/3837436...
    yuantao123434阅读 8,323评论 6 152
  • 好的婚姻关系,是彼此势均力敌?从结果上看,好的婚姻关系是两个人彼此得到比相互付出的多,可是这个得到和付出就要看各自...
    林林叶阅读 180评论 0 0
  • 奇葩说摘 | 分手该不该当面说 影秋千® 很喜欢最近这一期的《奇葩说》的辩论,理性和感性的碰撞,几位辩手的语言都特...
    影秋千阅读 5,087评论 0 2