首页 > 代码库 > OAuth 2.0

OAuth 2.0

      OAuth是一个关于授权(authorization)的开放网络标准,在全世界得到广泛应用,眼下的版本号是2.0版。

技术分享

一、应用场景

为了理解OAuth的适用场合,让我举一个如果的样例。

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

技术分享

问题是仅仅有得到用户的授权,Google才会允许"云冲印"读取这些照片。那么,"云冲印"如何获得用户的授权呢?

传统方法是,用户将自己的Googleusername和password,告诉"云冲印",后者就能够读取用户的照片了。

这种做法有下面几个严重的缺点。

(1)"云冲印"为了兴许的服务。会保存用户的password。这样非常不安全。

(2)Google不得不部署password登录,而我们知道。单纯的password登录并不安全。

(3)"云冲印"拥有了获取用户储存在Google全部资料的权力,用户没法限制"云冲印"获得授权的范围和有效期。

(4)用户仅仅有改动password,才干收回赋予"云冲印"的权力。

可是这样做,会使得其它所有获得用户授权的第三方应用程序所有失效。

(5)仅仅要有一个第三方应用程序被破解,就会导致用户password泄漏,以及全部被password保护的数据泄漏。

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

二、名词定义

在具体解说OAuth 2.0之前,须要了解几个专用名词。它们对读懂后面的解说,尤其是几张图,至关重要。

(1) Third-party application:第三方应用程序,本文中又称"客户端"(client)。即上一节样例中的"云冲印"。

(2)HTTP service:HTTP服务提供商,本文中简称"服务提供商",即上一节样例中的Google。

(3)Resource Owner:资源全部者,本文中又称"用户"(user)。

(4)User Agent:用户代理,本文中就是指浏览器。

(5)Authorization server:认证server。即服务提供商专门用来处理认证的server。

(6)Resource server:资源server,即服务提供商存放用户生成的资源的server。

它与认证server,能够是同一台server,也能够是不同的server。

知道了上面这些名词,就不难理解,OAuth的作用就是让"client"安全可控地获取"用户"的授权,与"服务商提供商"进行互动。

三、OAuth的思路

OAuth在"client"与"服务提供商"之间。设置了一个授权层(authorization layer)。"client"不能直接登录"服务提供商",仅仅能登录授权层。以此将用户与client区分开来。

"client"登录授权层所用的令牌(token),与用户的password不同。用户能够在登录的时候,指定授权层令牌的权限范围和有效期。

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

四、执行流程

OAuth 2.0的执行流程例如以下图,摘自RFC 6749。

技术分享

(A)用户打开client以后,client要求用户给予授权。

(B)用户允许给予client授权。

(C)client使用上一步获得的授权,向认证server申请令牌。

(D)认证server对client进行认证以后,确认无误,允许发放令牌。

(E)client使用令牌,向资源server申请获取资源。

(F)资源server确认令牌无误。允许向client开放资源。

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

以下一一解说client获取授权的四种模式。

五、client的授权模式

client必须得到用户的授权(authorization grant)。才干获得令牌(access token)。OAuth 2.0定义了四种授权方式。

  • 授权码模式(authorization code)
  • 简化模式(implicit)
  • 密码模式(resource owner password credentials)
  • 客户端模式(client credentials)

六、授权码模式

授权码模式(authorization code)是功能最完整、流程最严密的授权模式。它的特点就是通过client的后台server。与"服务提供商"的认证server进行互动。

技术分享

它的过程例如以下:

(A)用户訪问client,后者将前者导向认证server。

(B)用户选择是否给予client授权。

(C)如果用户给予授权。认证server将用户导向client事先指定的"重定向URI"(redirection URI)。同一时候附上一个授权码。

(D)client收到授权码。附上早先的"重定向URI",向认证server申请令牌。这一步是在client的后台的server上完毕的。对用户不可见。

(E)认证server核对了授权码和重定向URI,确认无误后,向client发送訪问令牌(access token)和更新令牌(refresh token)。

以下是上面这些步骤所须要的參数。

A步骤中。client申请认证的URI,包括下面參数:

  • response_type:表示授权类型,必选项,此处的值固定为"code"
  • client_id:表示客户端的ID,必选项
  • redirect_uri:表示重定向URI,可选项
  • scope:表示申请的权限范围,可选项
  • state:表示client的当前状态,能够指定随意值,认证server会原封不动地返回这个值。

以下是一个样例。


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步骤中,server回应client的URI,包括下面參数:

  • code:表示授权码,必选项。该码的有效期应该非常短,通常设为10分钟,client仅仅能使用该码一次。否则会被授权server拒绝。该码与clientID和重定向URI,是一一相应关系。
  • state:假设client的请求中包括这个參数。认证server的回应也必须一模一样包括这个參数。

以下是一个样例。


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

D步骤中,client向认证server申请令牌的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步骤中,认证server发送的HTTP回复。包括下面參数:

  • access_token:表示訪问令牌,必选项。

  • token_type:表示令牌类型。该值大写和小写不敏感,必选项,能够是bearer类型或mac类型。
  • expires_in:表示过期时间,单位为秒。

    假设省略该參数。必须其它方式设置过期时间。

  • refresh_token:表示更新令牌。用来获取下一次的訪问令牌。可选项。
  • scope:表示权限范围,假设与client申请的范围一致,此项可省略。

以下是一个样例。


     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)不通过第三方应用程序的server。直接在浏览器中向认证server申请令牌,跳过了"授权码"这个步骤,因此得名。

全部步骤在浏览器中完毕,令牌对訪问者是可见的,且client不须要认证。

技术分享

它的过程例如以下:

(A)client将用户导向认证server。

(B)用户决定是否给于client授权。

(C)如果用户给予授权。认证server将用户导向client指定的"重定向URI",并在URI的Hash部分包括了訪问令牌。

(D)浏览器向资源server发出请求,当中不包含上一步收到的Hash值。

(E)资源server返回一个网页,当中包括的代码能够获取Hash值中的令牌。

(F)浏览器运行上一步获得的脚本。提取出令牌。

(G)浏览器将令牌发给client。

以下是上面这些步骤所须要的參数。

A步骤中,client发出的HTTP请求,包括下面參数:

  • response_type:表示授权类型。此处的值固定为"token",必选项。
  • client_id:表示客户端的ID。必选项。

  • redirect_uri:表示重定向的URI,可选项。

  • scope:表示权限范围。可选项。
  • state:表示client的当前状态,能够指定随意值,认证server会原封不动地返回这个值。

以下是一个样例。


    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步骤中。认证server回应client的URI,包括下面參数:

  • access_token:表示訪问令牌,必选项。
  • token_type:表示令牌类型,该值大写和小写不敏感,必选项。
  • expires_in:表示过期时间。单位为秒。假设省略该參数,必须其它方式设置过期时间。
  • scope:表示权限范围。假设与client申请的范围一致,此项可省略。
  • state:假设client的请求中包括这个參数。认证server的回应也必须一模一样包括这个參数。

以下是一个样例。


     HTTP/1.1 302 Found
     Location: http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA
               &state=xyz&token_type=example&expires_in=3600

在上面的样例中。认证server用HTTP头信息的Location栏。指定浏览器重定向的网址。注意。在这个网址的Hash部分包括了令牌。

依据上面的D步骤。下一步浏览器会訪问Location指定的网址,可是Hash部分不会发送。接下来的E步骤,服务提供商的资源server发送过来的代码,会提取出Hash中的令牌。

八、password模式

password模式(Resource Owner Password Credentials Grant)中。用户向client提供自己的username和password。

client使用这些信息,向"服务商提供商"索要授权。

在这样的模式中。用户必须把自己的password给client,可是client不得储存password。

这通经常使用在用户对client高度信任的情况下。比方client是操作系统的一部分,或者由一个著名公司出品。而认证server仅仅有在其它授权模式无法运行的情况下。才干考虑使用这样的模式。

技术分享

它的过程例如以下:

(A)用户向client提供username和password。

(B)client将username和password发给认证server,向后者请求令牌。

(C)认证server确认无误后。向client提供訪问令牌。

B步骤中,client发出的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步骤中,认证server向client发送訪问令牌,以下是一个样例。


     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不得保存用户的password。

九、client模式

client模式(Client Credentials Grant)指client以自己的名义,而不是以用户的名义,向"服务提供商"进行认证。严格地说,client模式并不属于OAuth框架所要解决的问题。在这样的模式中。用户直接向client注冊,client以自己的名义要求"服务提供商"提供服务,事实上不存在授权问题。

技术分享

它的过程例如以下:

(A)client向认证server进行身份认证。并要求一个訪问令牌。

(B)认证server确认无误后,向client提供訪问令牌。

A步骤中,client发出的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

认证server必须以某种方式,验证client身份。

B步骤中。认证server向client发送訪问令牌,以下是一个样例。


     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"
     }

上面代码中,各个參数的含义參见《授权码模式》一节。

十、更新令牌

假设用户訪问的时候,client的"訪问令牌"已经过期。则须要使用"更新令牌"申请一个新的訪问令牌。

client发出更新令牌的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

OAuth 2.0