天天看点

oauth2.0理解与应用

相关内容整理自阮一峰文档:​​理解OAuth 2.0​​​   ​​ 《OAuth 2.0 教程》​​

​​OAuth​​​是一个关于授权(authorization)的开放网络标准,在全世界得到广泛应用,目前的版本是2.0版,可参考:​​RFC 6749​​。

OAuth 引入了一个授权层,用来分离两种不同的角色:客户端和资源所有者。资源所有者同意以后,资源服务器可以向客户端颁发令牌。客户端通过令牌,去请求数据。Oauth的核心就是向第三方应用颁发令牌(token)。

为了理解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在"客户端"与"服务提供商"之间,设置了一个授权层(authorization layer)。"客户端"不能直接登录"服务提供商",只能登录授权层,以此将用户与客户端区分开来。"客户端"登录授权层所用的令牌(token),与用户的密码不同。用户可以在登录的时候,指定授权层令牌的权限范围和有效期。

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

OAuth 2.0的运行流程如下图,摘自RFC 6749。

oauth2.0理解与应用
(A)用户打开客户端以后,客户端要求用户给予授权。 (B)用户同意给予客户端授权。 (C)客户端使用上一步获得的授权,向认证服务器申请令牌。 (D)认证服务器对客户端进行认证以后,确认无误,同意发放令牌。 (E)客户端使用令牌,向资源服务器申请获取资源。 (F)资源服务器确认令牌无误,同意向客户端开放资源。

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

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

客户端必须得到用户的授权(authorization grant),才能获得令牌(access token)。OAuth 2.0 规定了四种获得令牌的流程。你可以选择最适合自己的那一种,向第三方应用颁发令牌。

授权码模式(authorization code)

简化模式(implicit)

密码模式(resource owner password credentials)

客户端模式(client credentials)

注意,不管哪一种授权方式,第三方应用申请令牌之前,都必须先到系统备案,说明自己的身份,然后会拿到两个身份识别码:客户端 ID(client ID)和客户端密钥(client secret)。这是为了防止令牌被滥用,没有备案过的第三方应用,是不会拿到令牌的。

授权码(authorization code)方式,指的是第三方应用先申请一个授权码,然后再用该码获取令牌。

这种方式是最常用的流程,安全性也最高,它适用于那些有后端的 Web 应用。授权码通过前端传送,令牌则是储存在后端,而且所有与资源服务器的通信都在后端完成。这样的前后端分离,可以避免令牌泄漏。

第一步,A 网站提供一个链接,用户点击后就会跳转到 B 网站,授权用户数据给 A 网站使用。下面就是 A 网站跳转 B 网站的一个示意链接。

上面 URL 中,​<code>​response_type​</code>​​参数表示要求返回授权码(​<code>​code​</code>​​),​<code>​client_id​</code>​​参数让 B 知道是谁在请求,​<code>​redirect_uri​</code>​​参数是 B 接受或拒绝请求后的跳转网址,​<code>​scope​</code>​参数表示要求的授权范围(这里是只读)。

oauth2.0理解与应用

第二步,用户跳转后,B 网站会要求用户登录,然后询问是否同意给予 A 网站授权。用户表示同意,这时 B 网站就会跳回​<code>​redirect_uri​</code>​参数指定的网址。跳转时,会传回一个授权码,就像下面这样。

上面 URL 中,​<code>​code​</code>​参数就是授权码。

oauth2.0理解与应用

第三步,A 网站拿到授权码以后,就可以在后端,向 B 网站请求令牌。

上面 URL 中,​<code>​client_id​</code>​​参数和​<code>​client_secret​</code>​​参数用来让 B 确认 A 的身份(​<code>​client_secret​</code>​​参数是保密的,因此只能在后端发请求),​<code>​grant_type​</code>​​参数的值是​<code>​AUTHORIZATION_CODE​</code>​​,表示采用的授权方式是授权码,​<code>​code​</code>​​参数是上一步拿到的授权码,​<code>​redirect_uri​</code>​参数是令牌颁发后的回调网址。

oauth2.0理解与应用

第四步,B 网站收到请求以后,就会颁发令牌。具体做法是向​<code>​redirect_uri​</code>​指定的网址,发送一段 JSON 数据。

上面 JSON 数据中,​<code>​access_token​</code>​字段就是令牌,A 网站在后端拿到了。

oauth2.0理解与应用

有些 Web 应用是纯前端应用,没有后端。这时就不能用上面的方式了,必须将令牌储存在前端。RFC 6749 就规定了第二种方式,允许直接向前端颁发令牌。这种方式没有授权码这个中间步骤,所以称为(授权码)"隐藏式"(implicit)。

第一步,A 网站提供一个链接,要求用户跳转到 B 网站,授权用户数据给 A 网站使用。

上面 URL 中,​<code>​response_type​</code>​​参数为​<code>​token​</code>​,表示要求直接返回令牌。

第二步,用户跳转到 B 网站,登录后同意给予 A 网站授权。这时,B 网站就会跳回​<code>​redirect_uri​</code>​参数指定的跳转网址,并且把令牌作为 URL 参数,传给 A 网站。

上面 URL 中,​<code>​token​</code>​参数就是令牌,A 网站因此直接在前端拿到令牌。

注意,令牌的位置是 URL 锚点(fragment),而不是查询字符串(querystring),这是因为 OAuth 2.0 允许跳转网址是 HTTP 协议,因此存在"中间人攻击"的风险,而浏览器跳转时,锚点不会发到服务器,就减少了泄漏令牌的风险。

oauth2.0理解与应用

这种方式把令牌直接传给前端,是很不安全的。因此,只能用于一些安全要求不高的场景,并且令牌的有效期必须非常短,通常就是会话期间(session)有效,浏览器关掉,令牌就失效了。

如果你高度信任某个应用,RFC 6749 也允许用户把用户名和密码,直接告诉该应用。该应用就使用你的密码,申请令牌,这种方式称为"密码式"(password)。

第一步,A 网站要求用户提供 B 网站的用户名和密码。拿到以后,A 就直接向 B 请求令牌。

上面 URL 中,​<code>​grant_type​</code>​​参数是授权方式,这里的​<code>​password​</code>​​表示"密码式",​<code>​username​</code>​​和​<code>​password​</code>​是 B 的用户名和密码。

第二步,B 网站验证身份通过后,直接给出令牌。注意,这时不需要跳转,而是把令牌放在 JSON 数据里面,作为 HTTP 回应,A 因此拿到令牌。

这种方式需要用户给出自己的用户名/密码,显然风险很大,因此只适用于其他授权方式都无法采用的情况,而且必须是用户高度信任的应用。

最后一种方式是凭证式(client credentials),适用于没有前端的命令行应用,即在命令行下请求令牌。

第一步,A 应用在命令行向 B 发出请求。

上面 URL 中,​<code>​grant_type​</code>​​参数等于​<code>​client_credentials​</code>​​表示采用凭证式,​<code>​client_id​</code>​​和​<code>​client_secret​</code>​用来让 B 确认 A 的身份。

第二步,B 网站验证通过以后,直接返回令牌。

这种方式给出的令牌,是针对第三方应用的,而不是针对用户的,即有可能多个用户共享同一个令牌。

A 网站拿到令牌以后,就可以向 B 网站的 API 请求数据了。

此时,每个发到 API 的请求,都必须带有令牌。具体做法是在请求的头信息,加上一个​<code>​Authorization​</code>​字段,令牌就放在这个字段里面。

上面命令中,​<code>​ACCESS_TOKEN​</code>​就是拿到的令牌。

令牌的有效期到了,如果让用户重新走一遍上面的流程,再申请一个新的令牌,很可能体验不好,而且也没有必要。OAuth 2.0 允许用户自动更新令牌。

具体方法是,B 网站颁发令牌的时候,一次性颁发两个令牌,一个用于获取数据,另一个用于获取新的令牌(refresh token 字段)。令牌到期前,用户使用 refresh token 发一个请求,去更新令牌。

上面 URL 中,​<code>​grant_type​</code>​​参数为​<code>​refresh_token​</code>​​表示要求更新令牌,​<code>​client_id​</code>​​参数和​<code>​client_secret​</code>​​参数用于确认身份,​<code>​refresh_token​</code>​参数就是用于更新令牌的令牌。

B 网站验证通过以后,就会颁发新的令牌。

很多网站登录时,允许使用第三方网站的身份,这称为“第三方登录”。下面演示如何通过OAuth获取github的API数据。

所谓第三方登录,实质就是 OAuth 授权。用户想要登录 A 网站,A 网站让用户提供第三方网站的数据,证明自己的身份。获取第三方网站的身份数据,就需要 OAuth 授权。

举例来说,A 网站允许 GitHub 登录,背后就是下面的流程。

A 网站让用户跳转到 GitHub。 GitHub 要求用户登录,然后询问"A 网站要求获得 xx 权限,你是否同意?" 用户同意,GitHub 就会重定向回 A 网站,同时发回一个授权码。 A 网站使用授权码,向 GitHub 请求令牌。 GitHub 返回令牌. A 网站使用令牌,向 GitHub 请求用户数据。

下面就是这个流程的代码实现。

一个应用要求 OAuth 授权,必须先到对方网站登记,让对方知道是谁在请求。

所以,你要先去 GitHub 登记一下。当然,我已经登记过了,你使用我的登记信息也可以,但为了完整走一遍流程,还是建议大家自己登记。这是免费的。

访问这个​​网址​​,填写登记表。

oauth2.0理解与应用

应用的名称随便填,主页 URL 填写​<code>​http://localhost:8080​</code>​​,跳转网址填写 ​<code>​http://localhost:8080/oauth/redirect​</code>​。

提交表单以后,GitHub 应该会返回客户端 ID(client ID)和客户端密钥(client secret),这就是应用的身份识别码。

我写了一个​​代码仓库​​,请将它克隆到本地。

两个配置项要改一下,写入上一步的身份识别码。

​​index.js​​​:改掉变量​<code>​clientID​</code>​​ and ​<code>​clientSecret​</code>​ ​​public/index.html​​​:改掉变量​<code>​client_id​</code>​

然后,安装依赖。

启动服务。

浏览器访问​<code>​http://localhost:8080​</code>​,就可以看到这个示例了。

示例的首页很简单,就是一个链接,让用户跳转到 GitHub。

oauth2.0理解与应用

跳转的 URL 如下。

这个 URL 指向 GitHub 的 OAuth 授权网址,带有两个参数:​<code>​client_id​</code>​​告诉 GitHub 谁在请求,​<code>​redirect_uri​</code>​是稍后跳转回来的网址。

用户点击到了 GitHub,GitHub 会要求用户登录,确保是本人在操作。

登录后,GitHub 询问用户,该应用正在请求数据,你是否同意授权。

oauth2.0理解与应用

用户同意授权, GitHub 就会跳转到​<code>​redirect_uri​</code>​指定的跳转网址,并且带上授权码,跳转回来的 URL 就是下面的样子。

后端收到这个请求以后,就拿到了授权码(​<code>​code​</code>​参数)。

示例的​​后端​​​采用 Koa 框架编写,具体语法请看​​教程​​。

这里的关键是针对​<code>​/oauth/redirect​</code>​​的请求,编写一个​​路由​​,完成 OAuth 认证。

上面代码中,​<code>​oauth​</code>​函数就是路由的处理函数。下面的代码都写在这个函数里面。

路由函数的第一件事,是从 URL 取出授权码。

后端使用这个授权码,向 GitHub 请求令牌。

上面代码中,GitHub 的令牌接口​<code>​https://github.com/login/oauth/access_token​</code>​需要提供三个参数。

​<code>​client_id​</code>​:客户端的 ID ​<code>​client_secret​</code>​:客户端的密钥 ​<code>​code​</code>​:授权码

作为回应,GitHub 会返回一段 JSON 数据,里面包含了令牌​<code>​accessToken​</code>​。

有了令牌以后,就可以向 API 请求数据了。

上面代码中,GitHub API 的地址是​<code>​https://api.github.com/user​</code>​​,请求的时候必须在 HTTP 头信息里面带上令牌​<code>​Authorization: token 361507da​</code>​。

然后,就可以拿到用户数据,得到用户的身份。