拿nodejs快速搭建简单Oauth认证和restful API server攻略
拿nodejs快速搭建简单Oauth认证和restful API server攻略:http://blog.csdn.net/zhaoweitco/article/details/21708955
最近一直在鼓捣这个东西,拿出来分享下一下经验吧,其实很简单,一点也不难。
首先需求是这样,给自己的网站要增加API服务,API分为两种,公共的和私有授权的,授权的使用Oauth方法认证身份,API格式均为JOSN和JSONP。
嗯,别的语言我也没怎么学过,首先是找合适的框架进行实现吧。本身网站使用的express2.x开发的,再在express2.x的基础上开发api接口感觉太累了,找到了社区推荐的restify http://mcavage.github.io/node-restify/ 进行API开发,然后又搜到了一个开源的oauth的express中间件,https://github.com/ammmir/node-oauth2-provider
数据源是mongodb,那么开搞吧。
首先是把api的策略和需求文档整理出来,这里有个还没开发完的例子:
https://github.com/xiaojue/tuer.me/blob/master/docs/index.md
首先是授权方法和api讲解,然后是api列表和实现地址与接口简单说明,参数说明等。
当然这写都是在开始写api之前要先大概设计好的。参见上面的地址。我也是参考了别的网站的api文档自己胡乱写的。大概就那么个意思吧。。
然后在说具体开发的细节时,得先讲明白啥是Oauth认证和restful,百科上有官方解释,我就不自己忽悠了。我在这里说下自己的白话理解。
首先restful是api的格式和规范,使用restify应该是帮你会保持好格式和一些特定的特征的,这里我没做过多了解,文档实在太多。。我只知道就像普通网站开发一下,写好json接口就好了。
但是这写api需要认证使用者的身份,这里的使用者分为2种身份,一种为api调用程序,也就是开发者写的代码,一种是使用程序的普通用户的身份需要验证。
对程序的认证,我使用appkey和secret的方式认证,没有这2个,是不允许请求api的。
appkey和secret简单来说就是对程序的另外一份密码和帐号的实现。当开发者申请了一个appkey的时候,我通过算法来进行生成这2个东东,在程序请求api的时候通过对这2个的核对,来确保程序来源。
首先在自己网站上要先写一个申请api的服务,然后做一个简单的后台对申请后的应用就行审核,审核其实就是生成appkey和secret的过程。
应用拥有了appkey和secret之后,公开的api可以直接用参数带appkey的方式获取资源。授权api则需要通过用户授权了,这里就需要用到secret了。
具体流程是:
用户使用第三方应用之前,第三方应用给出本站的一个授权页面地址,参数夹带appkey和回调地址,回调地址和之前申请的地址要一致,确保不会被钓鱼。
用户抵达我的站点授权应用之后,我会把浏览器重新定向到那个回调地址,带一个临时的code码,这个code码是和appkey成对应的。
第三方应用把这个code码获取之后,用这个code码加appkey加程序的secret,来本站换取用户的token,这个时候的secret不会对外部有暴露,就像密码一样,post给我,我再和对code和secret信息,完成对appkey的第二次校验,之后根据这个用户的特征给这个用户生成一个token,2份,我本地一份,第三方一份。
这个token就是用于校验用户身份的了,算法一般是采用可逆的加密方式,但是要有密钥才可以解开的。这里就不详细说了,可以自行搜索serializer这个模块,就是干这个的。
token在加密的时候,本身会注入一些信息,比如这个用户的id,生成时间戳,以及其他一些你觉得有用的信息。
在下次第三方应用发token换取授权api的时候,主站可以解开这个token,核对时间戳【看token的有效期是否合法】看id是否存在,检查一些其他隐藏属性是否被修改等,来进行再次身份确认。
我的程序token是100天的有效期。当然还会提供刷新token的方法,方法就和上面的过程类似了,拿老token换新token,2边同步下即可。
ok,oauth算是大概说明白流程了。上面看起来很复杂的,但是有了最开始说的2个模块之后,很多事情就不需要自己来干了。
这里给出2个参考文件:
https://github.com/xiaojue/tuer.me/blob/master/lib/OAP.js
这个是oauth在主站的路由控制,详细api可以见oauth2-provider的项目例子。里面提供生成token的方法,生成授权表单的路由,对header拦截和校验的功能等。很方便,只需要自己相应填空就行,当然要结合自己网站的数据进行查询和校验。
还有一个就是api的实现了,restify有不少的坑需要一一说明,首先是对中文的实现,编码utf-8在官方的例子是设置req.setChart 但是,真正的最新2.x版本又去掉了这个功能,所以必须自己手动设置。
还有就是对oauth2的支持也并不好,如果用他的Authorization header parsing插件,对token放在url中,或者可能自己需要扩展的认证方法,很难修改【要改他的源码。你pull request了吧,人家肯定也不收。。】所以我是自己用restify的use自己写了一个,参考代码如下:
https://github.com/xiaojue/tuer.me/blob/master/api.js#L75
写的很搓。。不过很通俗易懂了。。大概就是校验几个接受token的地方,然后解开token进行核对确认身份,再看是否需要拦截。
当然在具体的api接口中,还是需要再次确认了,比如一个api,是修改用户资料,那么应用传了一个token,虽然合法,但是可能不是这个用户的token,所以还是需要在api中需要的地方再次进行身份认证。
所以我在req.authorization又进行了token的存储。方便在接口中再次获取校验。
ok,然后就是编写你自己的业务api了,和写网站差不多,语法和思路和express也是一样的。再给一个例子:
https://github.com/xiaojue/tuer.me/blob/master/routes/apis/feed.js
这是网站feed的api实现,一看就很简单了。。需要注意的是,在往外吐的时候,还是要配置个白名单。否则获取用户信息把pwd也反回去就囧了。。
ok。再详细的攻略等我把api全部开发好了,上线之后再上 客户端的demo例子吧。
拿nodejs快速搭建简单Oauth认证和restful API server攻略的更多相关文章
- 使用Django快速搭建简单的数据管理后台
使用Django快速搭建简单的数据管理后台 概述 需求描述: 数据表已建好,能可视化操作增删改查,避免直接操作数据库 简版的管理系统 环境 Windows 10 x64 Python 3.6.3 (A ...
- 【重学Node.js 第1&2篇】本地搭建Node环境并起RESTful Api服务
本地搭建Node环境并起RESTful Api服务 课程介绍看这里:https://www.cnblogs.com/zhangran/p/11963616.html 项目github地址:https: ...
- Laravel 中使用 JWT 认证的 Restful API
Laravel 中使用 JWT 认证的 Restful API 5天前/ 678 / 3 / 更新于 3天前 在此文章中,我们将学习如何使用 JWT 身份验证在 Laravel 中构建 r ...
- 使用Node.js快速搭建简单的静态文件服务器
做前端有时会采用一些复杂框架,在文件系统中直接打开页面(用file:///方式打开),往往会报跨域的错,类似于“XMLHttpRequest cannot load ...(文件名). Cross o ...
- 用pytorch1.0快速搭建简单的神经网络
用pytorch1.0搭建简单的神经网络 import torch import torch.nn.functional as F # 包含激励函数 # 建立神经网络 # 先定义所有的层属性(__in ...
- k8s使用自定义证书将客户端认证接入到API Server
自定义证书使用kubectl认证接入API Serverkubeconfig是API Server的客户端连入API Server时使用的认证格式的客户端配置文件.使用kubectl config v ...
- json server的简单使用(附:使用nodejs快速搭建本地服务器)
作为前端开发人员,经常需要模拟后台数据,我们称之为mock.通常的方式为自己搭建一个服务器,返回我们想要的数据.json server 作为工具,因为它足够简单,写少量数据,即可使用. 安装 首先需要 ...
- 快速搭建简单的LBS程序——地图服务
很多时候,我们的程序需要提供需要搭建基于位置的服务(LBS),本文这里简单的介绍一下其涉及的一些基本知识. 墨卡托投影 地图本身是一个三维图像,但在电脑上展示时,往往需要将其转换为二维的平面图形,需要 ...
- Django + mysql 快速搭建简单web投票系统
了解学习pyhton web的简单demo 1. 安装Django, 安装pyhton 自行百度 2. 执行命令创建project django-admin.py startproject mysi ...
随机推荐
- linux,下载与安装
1.下载地址 1.网易开源镜像站 http://mirrors.163.com 2.centos 官方站 http://www.centos.org 2.虚拟机 VirtualBox ------- ...
- 自己写getElementsByClass()方法
// 根据类名获取元素 function getElementsByClass(oParent,sClass){ var aResult = []; var aNode = oParent.getEl ...
- List-ApI及详解
1.API : add(Object o) remove(Object o) clear() indexOf(Object o) get(int i) size() iterator() isEmpt ...
- Jquery图片上传预览效果
uploadPreview.js jQuery.fn.extend({ uploadPreview: function (opts) { var _self = this, _this = $(thi ...
- 关于linux软连接
以前一直搞不懂linux软连接用什么 只知道是类似于linux的快捷方式 sudo ln -s /home/hadoop/bigdata/jdk1.7.0_79/ /usr/local/jdk(创建软 ...
- svn 安装 、使用(1)
写在开头: 虽然网络极大的方便了我们查找答案,而且有很多人写各样的博客.但每个人在实际中的情况不一样,遇到的问题也不一样,大牛们会把步骤写的很简单,可能真的是怕麻烦,但显然就有一些东西已经不适合一部分 ...
- hdu1285 拓扑序
题意:有N个比赛队(1<=N<=500),编号依次为1,2,3,....,N进行比赛,比赛结束后,裁判委员会要将所有参赛队伍从前往后依次排名,但现在裁判委员会不能直接获得每个队的比赛成绩, ...
- Android项目——短信发送器
因为应用要使用手机的短信服务,所以要在清单文件AndroidManifest.xml中添加短信服务权限: <?xml version="1.0" encoding=" ...
- 为mysql在表的某一位置增加一列
如果想在一个已经建好的表中添加一列,可以用诸如: alter table t1 add column addr varchar(20) not null; 这条语句会向已有的表t1中加入一列addr, ...
- m3u8文件简介
1. M3U8文件概念 M3U8文件是指UTF-8编码格式的M3U文件.M3U文件是记录了一个索引纯文本文件,打开它时播放软件并不是播放它,而是根据它的索引找到对应的音视频文件的网络地址进行在线播 ...