理解OAuth 2.0

OAuth是一个关于受权（authorization）的开放网络标准，在全世界获得普遍应用，目前的版本是2.0版。

本文对OAuth 2.0的设计思路和运行流程，作一个简明通俗的解释，主要参考材料为RFC 6749。

1、应用场景

为了理解OAuth的适用场合，让我举一个假设的例子。

有一个"云冲印"的网站，能够将用户储存在Google的照片，冲印出来。用户为了使用该服务，必须让"云冲印"读取本身储存在Google上的照片。

问题是只有获得用户的受权，Google才会赞成"云冲印"读取这些照片。那么，"云冲印"怎样得到用户的受权呢？

传统方法是，用户将本身的Google用户名和密码，告诉"云冲印"，后者就能够读取用户的照片了。这样的作法有如下几个严重的缺点。

（1）"云冲印"为了后续的服务，会保存用户的密码，这样很不安全。
（2）Google不得不部署密码登陆，而咱们知道，单纯的密码登陆并不安全。
（3）"云冲印"拥有了获取用户储存在Google全部资料的权力，用户无法限制"云冲印"得到受权的范围和有效期。
（4）用户只有修改密码，才能收回赋予"云冲印"的权力。可是这样作，会使得其余全部得到用户受权的第三方应用程序所有失效。
（5）只要有一个第三方应用程序被破解，就会致使用户密码泄漏，以及全部被密码保护的数据泄漏。

OAuth就是为了解决上面这些问题而诞生的。

2、名词定义

在详细讲解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的做用就是让"客户端"安全可控地获取"用户"的受权，与"服务商提供商"进行互动。

3、OAuth的思路

OAuth在"客户端"与"服务提供商"之间，设置了一个受权层（authorization layer）。"客户端"不能直接登陆"服务提供商"，只能登陆受权层，以此将用户与客户端区分开来。"客户端"登陆受权层所用的令牌（token），与用户的密码不一样。用户能够在登陆的时候，指定受权层令牌的权限范围和有效期。

"客户端"登陆受权层之后，"服务提供商"根据令牌的权限范围和有效期，向"客户端"开放用户储存的资料。

4、运行流程

OAuth 2.0的运行流程以下图，摘自RFC 6749。

（A）用户打开客户端之后，客户端要求用户给予受权。
（B）用户赞成给予客户端受权。
（C）客户端使用上一步得到的受权，向认证服务器申请令牌。
（D）认证服务器对客户端进行认证之后，确认无误，赞成发放令牌。
（E）客户端使用令牌，向资源服务器申请获取资源。
（F）资源服务器确认令牌无误，赞成向客户端开放资源。

不难看出来，上面六个步骤之中，B是关键，即用户怎样才能给于客户端受权。有了这个受权之后，客户端就能够获取令牌，进而凭令牌获取资源。

下面一一讲解客户端获取受权的四种模式。

5、客户端的受权模式

客户端必须获得用户的受权（authorization grant），才能得到令牌（access token）。OAuth 2.0定义了四种受权方式。

• 受权码模式（authorization code）
• 简化模式（implicit）
• 密码模式（resource owner password credentials）
• 客户端模式（client credentials）

6、受权码模式

受权码模式（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：表示客户端的当前状态，能够指定任意值，认证服务器会原封不动地返回这个值。

下面是一个例子

1 GET /authorize?response_type=code&client_id=s6BhdRkqt3&state=xyz
2         &redirect_uri=https%3A%2F%2Fclient%2Eexample%2Ecom%2Fcb HTTP/1.1
3 Host: server.example.com

C步骤中，服务器回应客户端的URI，包含如下参数：

• code：表示受权码，必选项。该码的有效期应该很短，一般设为10分钟，客户端只能使用该码一次，不然会被受权服务器拒绝。该码与客户端ID和重定向URI，是一一对应关系。
• state：若是客户端的请求中包含这个参数，认证服务器的回应也必须如出一辙包含这个参数。

下面是一个例子。

1 HTTP/1.1 302 Found
2 Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA
3           &state=xyz

D步骤中，客户端向认证服务器申请令牌的HTTP请求，包含如下参数：

• grant_type：表示使用的受权模式，必选项，此处的值固定为"authorization_code"。
• code：表示上一步得到的受权码，必选项。
• redirect_uri：表示重定向URI，必选项，且必须与A步骤中的该参数值保持一致。
• client_id：表示客户端ID，必选项。

下面是一个例子。

1 POST /token HTTP/1.1 Host: server.example.com Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW Content-Type: application/x-www-form-urlencoded
2 
3 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：表示权限范围，若是与客户端申请的范围一致，此项可省略。

下面是一个例子。

 1 HTTP/1.1 200 OK
 2 Content-Type: application/json;charset=UTF-8
 3 Cache-Control: no-store
 4 Pragma: no-cache
 5 
 6 {
 7     "access_token":"2YotnFZFEjr1zCsicMWpAA",
 8     "token_type":"example",
 9     "expires_in":3600,
10     "refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA",
11     "example_parameter":"example_value"
12 }

从上面代码能够看到，相关参数使用JSON格式发送（Content-Type: application/json）。此外，HTTP头信息中明确指定不得缓存。

下面是一个新浪微博的一个实际应用

新浪微博开发平台使用的就是受权码模式

 1 /**
 2      * Executes 新浪微博 将用户导向认证服务器 action
 3      *
 4      * @param sfRequest $request A request object
 5     */
 6     public function executeSina(sfWebRequest $request)
 7     {
 8         $code_url = $this->_sina_auth->getAuthorizeURL( $this->_sina_callback );
 9         $this->redirect($code_url);
10     }

用户给予受权后（重定向URI），认证服务器将用户导向客户端事先指定的"重定向URI"（redirection URI），同时附上一个受权码（code）

 1 /**
 2      * Executes 新浪微博回调 action
 3      *
 4      * @param sfRequest $request A request object
 5     */
 6     public function executeSinaCallback(sfWebRequest $req)
 7     {
 8         $code = trim($req->getParameter('code', '')); //受权码
 9         if (isset($code)) {
10             $keys = array();
11             $keys['code'] = $code;
12             $keys['redirect_uri'] = $this->_sina_callback;
13             try {
14                 $token = $this->_sina_auth->getAccessToken('code', $keys); //获取令牌
15             } catch (Exception $e) {
16                 
17             }
18         }
19         if ($token) {
20             //受权完成
21             setcookie('weibojs_'.$this->_sina_auth->client_id, http_build_query($token));
22             //获取微博用户信息
23             $c = new SaeTClientV2($this->_sina_app_id, $this->_sina_app_key, $token['access_token']);
24             $uid_get = $c->get_uid();
25             $uid = $uid_get['uid'];
26             $user_message = $c->show_user_by_id($uid);
27             if(empty($user_message)) {
28                 alertMsg2('获取微博用户信息失败');
29             }
30             //获取本地用户信息
31             //$user_name = !empty($user_message['screen_name'])?$user_message['screen_name']:$user_message['name'];
32             $user_name = $user_message['name'];
33             $result = $this->_writeSinaUserInfo($user_name,$user_message);
34             if($result !== false) {
35                 $this->redirect('@homepage');
36             }
37         } else {
38             alertMsg2('受权失败');
39         }
40         $this->setLayout(false);
41         return sfView::NONE;
42     }

本文转自：http://www.ruanyifeng.com/blog/2014/05/oauth_2_0.html