OAuth是一个关于授权(authorization)的开放网络标准,在全世界得到广泛应用,目前的版本是2.0版。
本文对OAuth 2.0的设计思路和运行流程,做一个简明通俗的解释,主要参考材料为RFC 6749。
一、应用场景
为了理解OAuth的适用场合,让我举一个假设的例子。
有一个"云冲印"的网站,可以将用户储存在Google的照片,冲印出来。用户为了使用该服务,必须让"云冲印"读取自己储存在Google上的照片。
问题是只有得到用户的授权,Google才会同意"云冲印"读取这些照片。那么,"云冲印"怎样获得用户的授权呢?
传统方法是,用户将自己的Google用户名和密码,告诉"云冲印",后者就可以读取用户的照片了。这样的做法有以下几个严重的缺点。
(1)"云冲印"为了后续的服务,会保存用户的密码,这样很不安全。
(2)Google不得不部署密码登录,而我们知道,单纯的密码登录并不安全。
(3)"云冲印"拥有了获取用户储存在Google所有资料的权力,用户没法限制"云冲印"获得授权的范围和有效期。
(4)用户只有修改密码,才能收回赋予"云冲印"的权力。但是这样做,会使得其他所有获得用户授权的第三方应用程序全部失效。
(5)只要有一个第三方应用程序被破解,就会导致用户密码泄漏,以及所有被密码保护的数据泄漏。
OAuth就是为了解决上面这些问题而诞生的。
二、名词定义
在详细讲解OAuth 2.0之前,需要了解几个专用名词。它们对读懂后面的讲解,尤其是几张图,至关重要。
(1) Third-party application:第三方应用程序,本文中又称"客户端"(client),即上一节例子中的"云冲印"。
(2)HTTP service:HTTP服务提供商,本文中简称"服务提供商",即上一节例子中的Google。
(3)Resource Owner:资源所有者,本文中又称"用户"(user)。
(4)User Agent:用户代理,本文中就是指浏览器。
(5)Authorization server:认证服务器,即服务提供商专门用来处理认证的服务器。
(6)Resource server:资源服务器,即服务提供商存放用户生成的资源的服务器。它与认证服务器,可以是同一台服务器,也可以是不同的服务器。
知道了上面这些名词,就不难理解,OAuth的作用就是让"客户端"安全可控地获取"用户"的授权,与"服务商提供商"进行互动。
三、OAuth的思路
OAuth在"客户端"与"服务提供商"之间,设置了一个授权层(authorization layer)。"客户端"不能直接登录"服务提供商",只能登录授权层,以此将用户与客户端区分开来。"客户端"登录授权层所用的令牌(token),与用户的密码不同。用户可以在登录的时候,指定授权层令牌的权限范围和有效期。
"客户端"登录授权层以后,"服务提供商"根据令牌的权限范围和有效期,向"客户端"开放用户储存的资料。
四、运行流程
OAuth 2.0的运行流程如下图,摘自RFC 6749。
(A)用户打开客户端以后,客户端要求用户给予授权。
(B)用户同意给予客户端授权。
(C)客户端使用上一步获得的授权,向认证服务器申请令牌。
(D)认证服务器对客户端进行认证以后,确认无误,同意发放令牌。
(E)客户端使用令牌,向资源服务器申请获取资源。
(F)资源服务器确认令牌无误,同意向客户端开放资源。
不难看出来,上面六个步骤之中,B是关键,即用户怎样才能给于客户端授权。有了这个授权以后,客户端就可以获取令牌,进而凭令牌获取资源。
下面一一讲解客户端获取授权的四种模式。
五、客户端的授权模式
客户端必须得到用户的授权(authorization grant),才能获得令牌(access token)。OAuth 2.0定义了四种授权方式。
- 授权码模式(authorization code)
- 简化模式(implicit)
- 密码模式(resource owner password credentials)
- 客户端模式(client credentials)
六、授权码模式
授权码模式(authorization code)是功能最完整、流程最严密的授权模式。它的特点就是通过客户端的后台服务器,与"服务提供商"的认证服务器进行互动。
它的步骤如下:
(A)用户访问客户端,后者将前者导向认证服务器。
(B)用户选择是否给予客户端授权。
(C)假设用户给予授权,认证服务器将用户导向客户端事先指定的"重定向URI"(redirection URI),同时附上一个授权码。
(D)客户端收到授权码,附上早先的"重定向URI",向认证服务器申请令牌。这一步是在客户端的后台的服务器上完成的,对用户不可见。
(E)认证服务器核对了授权码和重定向URI,确认无误后,向客户端发送访问令牌(access token)和更新令牌(refresh token)。
下面是上面这些步骤所需要的参数。
A步骤中,客户端申请认证的URI,包含以下参数:
- response_type:表示授权类型,必选项,此处的值固定为"code"
- client_id:表示客户端的ID,必选项
- redirect_uri:表示重定向URI,可选项
- scope:表示申请的权限范围,可选项
- state:表示客户端的当前状态,可以指定任意值,认证服务器会原封不动地返回这个值。
下面是一个例子。
GET /authorize?response_type=code&client_id=s6BhdRkqt3&state=xyz &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb HTTP/1.1 Host: server.example.com
C步骤中,服务器回应客户端的URI,包含以下参数:
- code:表示授权码,必选项。该码的有效期应该很短,通常设为10分钟,客户端只能使用该码一次,否则会被授权服务器拒绝。该码与客户端ID和重定向URI,是一一对应关系。
- state:如果客户端的请求中包含这个参数,认证服务器的回应也必须一模一样包含这个参数。
下面是一个例子。
HTTP/1.1 302 Found Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA &state=xyz
D步骤中,客户端向认证服务器申请令牌的HTTP请求,包含以下参数:
- grant_type:表示使用的授权模式,必选项,此处的值固定为"authorization_code"。
- code:表示上一步获得的授权码,必选项。
- redirect_uri:表示重定向URI,必选项,且必须与A步骤中的该参数值保持一致。
- client_id:表示客户端ID,必选项。
下面是一个例子。
POST /token HTTP/1.1 Host: server.example.com Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW Content-Type: application/x-www-form-urlencoded grant_type=authorization_code&code=SplxlOBeZQQYbYS6WxSbIA &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb
E步骤中,认证服务器发送的HTTP回复,包含以下参数:
- access_token:表示访问令牌,必选项。
- token_type:表示令牌类型,该值大小写不敏感,必选项,可以是bearer类型或mac类型。
- expires_in:表示过期时间,单位为秒。如果省略该参数,必须其他方式设置过期时间。
- refresh_token:表示更新令牌,用来获取下一次的访问令牌,可选项。
- scope:表示权限范围,如果与客户端申请的范围一致,此项可省略。
下面是一个例子。
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Cache-Control: no-store Pragma: no-cache { "access_token":"2YotnFZFEjr1zCsicMWpAA", "token_type":"example", "expires_in":3600, "refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA", "example_parameter":"example_value" }
从上面代码可以看到,相关参数使用JSON格式发送(Content-Type: application/json)。此外,HTTP头信息中明确指定不得缓存。
七、简化模式
简化模式(implicit grant type)不通过第三方应用程序的服务器,直接在浏览器中向认证服务器申请令牌,跳过了"授权码"这个步骤,因此得名。所有步骤在浏览器中完成,令牌对访问者是可见的,且客户端不需要认证。
它的步骤如下:
(A)客户端将用户导向认证服务器。
(B)用户决定是否给于客户端授权。
(C)假设用户给予授权,认证服务器将用户导向客户端指定的"重定向URI",并在URI的Hash部分包含了访问令牌。
(D)浏览器向资源服务器发出请求,其中不包括上一步收到的Hash值。
(E)资源服务器返回一个网页,其中包含的代码可以获取Hash值中的令牌。
(F)浏览器执行上一步获得的脚本,提取出令牌。
(G)浏览器将令牌发给客户端。
下面是上面这些步骤所需要的参数。
A步骤中,客户端发出的HTTP请求,包含以下参数:
- response_type:表示授权类型,此处的值固定为"token",必选项。
- client_id:表示客户端的ID,必选项。
- redirect_uri:表示重定向的URI,可选项。
- scope:表示权限范围,可选项。
- state:表示客户端的当前状态,可以指定任意值,认证服务器会原封不动地返回这个值。
下面是一个例子。
GET /authorize?response_type=token&client_id=s6BhdRkqt3&state=xyz &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb HTTP/1.1 Host: server.example.com
C步骤中,认证服务器回应客户端的URI,包含以下参数:
- access_token:表示访问令牌,必选项。
- token_type:表示令牌类型,该值大小写不敏感,必选项。
- expires_in:表示过期时间,单位为秒。如果省略该参数,必须其他方式设置过期时间。
- scope:表示权限范围,如果与客户端申请的范围一致,此项可省略。
- state:如果客户端的请求中包含这个参数,认证服务器的回应也必须一模一样包含这个参数。
下面是一个例子。
HTTP/1.1 302 Found Location: http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA &state=xyz&token_type=example&expires_in=3600
在上面的例子中,认证服务器用HTTP头信息的Location栏,指定浏览器重定向的网址。注意,在这个网址的Hash部分包含了令牌。
根据上面的D步骤,下一步浏览器会访问Location指定的网址,但是Hash部分不会发送。接下来的E步骤,服务提供商的资源服务器发送过来的代码,会提取出Hash中的令牌。
八、密码模式
密码模式(Resource Owner Password Credentials Grant)中,用户向客户端提供自己的用户名和密码。客户端使用这些信息,向"服务商提供商"索要授权。
在这种模式中,用户必须把自己的密码给客户端,但是客户端不得储存密码。这通常用在用户对客户端高度信任的情况下,比如客户端是操作系统的一部分,或者由一个著名公司出品。而认证服务器只有在其他授权模式无法执行的情况下,才能考虑使用这种模式。
它的步骤如下:
(A)用户向客户端提供用户名和密码。
(B)客户端将用户名和密码发给认证服务器,向后者请求令牌。
(C)认证服务器确认无误后,向客户端提供访问令牌。
B步骤中,客户端发出的HTTP请求,包含以下参数:
- grant_type:表示授权类型,此处的值固定为"password",必选项。
- username:表示用户名,必选项。
- password:表示用户的密码,必选项。
- scope:表示权限范围,可选项。
下面是一个例子。
POST /token HTTP/1.1 Host: server.example.com Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW Content-Type: application/x-www-form-urlencoded grant_type=password&username=johndoe&password=A3ddj3w
C步骤中,认证服务器向客户端发送访问令牌,下面是一个例子。
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Cache-Control: no-store Pragma: no-cache { "access_token":"2YotnFZFEjr1zCsicMWpAA", "token_type":"example", "expires_in":3600, "refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA", "example_parameter":"example_value" }
上面代码中,各个参数的含义参见《授权码模式》一节。
整个过程中,客户端不得保存用户的密码。
九、客户端模式
客户端模式(Client Credentials Grant)指客户端以自己的名义,而不是以用户的名义,向"服务提供商"进行认证。严格地说,客户端模式并不属于OAuth框架所要解决的问题。在这种模式中,用户直接向客户端注册,客户端以自己的名义要求"服务提供商"提供服务,其实不存在授权问题。
它的步骤如下:
(A)客户端向认证服务器进行身份认证,并要求一个访问令牌。
(B)认证服务器确认无误后,向客户端提供访问令牌。
A步骤中,客户端发出的HTTP请求,包含以下参数:
- granttype:表示授权类型,此处的值固定为"clientcredentials",必选项。
- scope:表示权限范围,可选项。
POST /token HTTP/1.1 Host: server.example.com Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW Content-Type: application/x-www-form-urlencoded grant_type=client_credentials
认证服务器必须以某种方式,验证客户端身份。
B步骤中,认证服务器向客户端发送访问令牌,下面是一个例子。
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Cache-Control: no-store Pragma: no-cache { "access_token":"2YotnFZFEjr1zCsicMWpAA", "token_type":"example", "expires_in":3600, "example_parameter":"example_value" }
上面代码中,各个参数的含义参见《授权码模式》一节。
十、更新令牌
如果用户访问的时候,客户端的"访问令牌"已经过期,则需要使用"更新令牌"申请一个新的访问令牌。
客户端发出更新令牌的HTTP请求,包含以下参数:
- granttype:表示使用的授权模式,此处的值固定为"refreshtoken",必选项。
- refresh_token:表示早前收到的更新令牌,必选项。
- scope:表示申请的授权范围,不可以超出上一次申请的范围,如果省略该参数,则表示与上一次一致。
下面是一个例子。
POST /token HTTP/1.1 Host: server.example.com Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW Content-Type: application/x-www-form-urlencoded grant_type=refresh_token&refresh_token=tGzv3JOkF0XG5Qx2TlKWIA
(完)
周梦康 说:
阮老师的文章都是精品,真正做到深入浅出。
2014年5月12日 22:10 | 档案 | 引用
hutusi 说:
留名,慢慢看~
2014年5月12日 22:58 | 档案 | 引用
chility 说:
今天培训老师讲了这部分,恰好阮老师写了这篇文章介绍,加深理解。
2014年5月13日 00:31 | 档案 | 引用
phi 说:
那什么,没看懂。能不能用位图。ASCII图看的很不习惯。谢谢
2014年5月13日 01:24 | 档案 | 引用
WhatDoesTheFoxSay 说:
授权码模式这部分中的“E步骤中,客户端发送的HTTP回复,包含以下参数“这句话,是否应为”认证服务器发送的HTTP回复“?
2014年5月13日 05:00 | 档案 | 引用
Charles 说:
本文关于state参数的解释,是语焉不详的。事实上,绝大多数的互联网中文文档对这个参数都语焉不详。我想,对于造成近期互联网上危害广泛的OAuth漏洞来说,众多中文技术资料对这个参数解释不到位,对这个参数的实现没有给出清晰的指导,也是成因的一部分。原文是这么说的:RECOMMENDED. An opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client. The parameter SHOULD be used for preventing cross-site request forgery as described in Section 10.12.如果阮老师只是翻译为什么“客户端状态”之类的话,还有什么“可以随便填”,这算不上一种到位的解释。首先,这个参数是“RECOMMENDED”,并非什么可有可无的东西,事实是很多厂商都实现成了可有可无,其次,这个参数是“SHOULD”,为啥“SHOULD”呢,因为会引发“CSRF”。
2014年5月13日 07:41 | 档案 | 引用
阮一峰 说:
谢谢指出,已经改过来了。
2014年5月13日 08:44 | 档案 | 引用
Tonni 说:
阮兄的博客又更新了,前几天买的《黑客与画家》昨天到了,很不错的书。
2014年5月13日 09:05 | 档案 | 引用
YG 说:
看了这么多OAuth的文章,阮老师的这篇是最好懂的,拜读了
2014年5月14日 08:19 | 档案 | 引用
M16 说:
说白了oauth就是一个网络版的usbkey
2014年5月17日 13:50 | 档案 | 引用
洋子 说:
支付宝链接已失效
2014年5月18日 22:56 | 档案 | 引用
Nicole 说:
非常感谢老师的分享,收益了。。
2014年5月20日 09:13 | 档案 | 引用
匆匆过客 说:
仔细一看,确实,如果state项不用动态数据的话会存在CSRF漏洞
2014年5月20日 09:39 | 档案 | 引用
smilexu 说:
(E)客户端使用令牌,向资源服务器申请获取资源。
令牌就可以?整个过程都没有用户名和密码的获得,那资源服务器又是如何确认用户的?
2014年5月21日 12:01 | 档案 | 引用
万文婷 说:
我是比较文学与世界文学的硕士生,希望您能联系我,探讨一下卡尔维诺。
2014年5月21日 16:19 | 档案 | 引用
niannian 说:
授权码模式中,D步骤,文中说client_id是必选项,但是随后的例子中没有这项
2014年5月23日 14:12 | 档案 | 引用
spojus 说:
收款主页下线啦
2014年5月24日 23:01 | 档案 | 引用
loddit 说:
同ls的niannian
另外 granttype authorizationcode 都没加 _ 下划线
2014年5月24日 23:20 | 档案 | 引用
Ike 说:
話說,RFC本來就是純文字檔案,這樣的圖其實看了很親切。。。
2014年5月25日 16:14 | 档案 | 引用
rhgb 说:
2014年6月 7日 16:47 | 档案 | 引用
king 说:
如果客户端做一个假的验证授权页面,来套取用户,用户名和密码,是有可能的吧?
2014年6月12日 11:30 | 档案 | 引用
jucelin 说:
我也有此疑问。weibo.com提供的都提示"请认准本页URL地址必须以 api.weibo.com 开头",这提示基本上没用。
2014年6月16日 20:41 | 档案 | 引用
mll 说:
协议中的 SHOULD,应该等同于 MUST 来对待。
2014年6月19日 17:25 | 档案 | 引用
sjh 说:
工商银行的网银在开通时要求用户自己说一句话,每次使用网银付款时网站会向用户出示这句话以证明网站的合法性。这个感觉要好些吧~
2014年7月18日 17:27 | 档案 | 引用
lvqiuyi 说:
有两点不太明白
1.授权码授权里,为什么要两次传递重定向url呢?有什么好处?
2.D步骤里,传递的参数有Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW,什么作用呢?
2014年8月 5日 11:24 | 档案 | 引用
lvqiuyi 说:
懂了,Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW,应该是对于应用client的授权认证,这样就相当于有两层保护,一层是认证客户端,一层是认证用户,不过basic的加密方式,是不是不太安全呢?
2014年8月 5日 14:44 | 档案 | 引用
suolaiwo 说:
请问一下,授权码code,其作用是什么?
2014年9月 8日 14:29 | 档案 | 引用
guest 说:
本质的作用是避免Access Token通过URL返回,有篇视频讲这个比较详细《[开放平台]一步一步理解OAuth2协议-全网首发》
http://edu.51cto.com/index.php?do=course&m=addlession&course_id=2035
2014年9月16日 14:30 | 档案 | 引用
zhiwen 说:
请问你这个是使用什么框架实现的OAuth的相关服务器端的?
2014年9月18日 13:55 | 档案 | 引用
陈伟 说:
正在学习OAuth2,写得太好了!非常容易理解!
2014年10月21日 16:57 | 档案 | 引用
hebidu 说:
我想知道 如何 生成access_token ,refresh_token 。
2014年10月22日 12:45 | 档案 | 引用
James 说:
生成access_token ,refresh_token 很简单,取一唯一的随机信息再做BASE64编码即可,它本身不包含任何有效信息的;服务端把它和用户受权关联以校验其受权的有效性.
2014年10月29日 10:45 | 档案 | 引用
惜今草 说:
请问,OAuth2.0客户端认证模式怎么限制客户端到认证服务器申请权限的范围(Scope)?
2014年11月12日 16:11 | 档案 | 引用
yxwoods 说:
通俗易懂!感觉如等到风来吹开京都雾霾,重见蓝天白云!
2014年11月13日 09:25 | 档案 | 引用
jinlong 说:
引导用户到授权界面,用户会先登录后授权,整个授权过程中没有提到究竟是为“谁”授权的啊? 那token是怎么和userid进行映射的呢?
我开始理解的是,用户同意授权后,会告诉授权服务器client_id等参数外还会有userid。
2014年11月21日 16:12 | 档案 | 引用
HM 说:
阮老师为啥只发文而不答复上面技术性的探讨呢?
2014年12月 9日 12:47 | 档案 | 引用
feiniu5566 说:
你要知道这个授权的目的是给第三方应用授权,让他有权利去获取用户放在服务器上的资源,所以你应该站在第三方应用的角度来看待这篇文章,你的目的就是获取用户
QQ空间里的图片,就这么理解吧,差不想为那个什么讯发广告
2014年12月 9日 16:31 | 档案 | 引用
yuandghn 说:
确实是这样的,很多时候大家都忽略了这个state参数存在的意义。企鹅家的OAuth2.0文档里倒是把这个参数说的很详细(非广告,实话实说)。
2015年1月25日 18:00 | 档案 | 引用
smithfox 说:
密码模式的例子中Request Header 中的 Authorization 是怎么来的?
2015年1月28日 12:39 | 档案 | 引用
xiaozi0lei 说:
文章写的不错,深入浅出,正好在找Oauth 2.0相关的介绍文章,有帮助,多谢!
2015年3月 3日 15:49 | 档案 | 引用
alleme 说:
确实,刚查了腾讯文档 "state 可选 client端的状态值。用于第三方应用防止CSRF攻击,成功授权后回调时会原样带回。"
2015年3月11日 11:05 | 档案 | 引用
Shion 说:
拿到访问令牌(access token)后,是不是每次请求资源都必须附上访问令牌?OAuth2是不是只适合Http,基于OAuth2的都只能通过客户端轮询来获取最新状态而不能由服务端进行推送?
2015年4月10日 16:38 | 档案 | 引用
test 说:
简化模式中:
C)假设用户给予授权,认证服务器将用户导向客户端指定的"重定向URI",并在URI的Hash部分包含了访问令牌。
(D)浏览器向资源服务器发出请求,其中不包括上一步收到的Hash值。
(E)资源服务器返回一个网页,其中包含的代码可以获取Hash值中的令牌。
c处的hash有没有多余呢?谢谢
2015年4月14日 08:21 | 档案 | 引用