OAuth2授权协议
名词定义
Third-party application
:第三方应用程序,本文中又称"客户端"(client
);HTTP service
:HTTP服务提供商,本文中简称"服务提供商";Resource Owner
:资源所有者,本文中又称"用户"(user);User Agent
:用户代理,本文中就是指浏览器;Authorization server
:认证服务器,即服务提供商专门用来处理认证的服务器;Resource server
:资源服务器,即服务提供商存放用户生成的资源的服务器;
OAuth简介
思路
OAuth在"客户端"与"服务提供商"之间,设置了一个授权层(authorization layer)。“客户端"不能直接登录"服务提供商”,只能登录授权层,以此将用户与客户端区分开来。“客户端"登录授权层所用的令牌(token),与用户的密码不同。用户可以在登录的时候,指定授权层令牌的权限范围和有效期。
“客户端"登录授权层以后,“服务提供商"根据令牌的权限范围和有效期,向"客户端"开放用户储存的资料。
####### 基本流程
|
|
步骤如下:
- 客户端要求用户给予授权。
- 用户同意给予客户端授权。
- 客户端使用上一步获得的授权,向认证服务器申请令牌。
- 认证服务器对客户端进行认证以后,确认无误,同意发放令牌。
- 客户端使用令牌,向资源服务器申请获取资源。
- 资源服务器确认令牌无误,同意向客户端开放资源。
客户端的授权模式
OAuth 2.0定义了四种授权方式。
- 授权码模式(
authorization code
) - 简化模式(
implicit
) - 密码模式(
resource owner password credentials
) - 客户端模式(
client credentials
)
授权码模式
是功能最完整、流程最严密的授权模式。采用这种模式的有:豆瓣、Coding、钉钉、微信。
HTTP头信息中明确指定不得缓存 Cache-Control: no-store
。
####### 基本流程
|
|
步骤如下:
- 用户访问客户端,后者将前者导向认证服务器。
- 用户选择是否给予客户端授权。
- 假设用户给予授权,认证服务器将用户导向客户端事先指定的"重定向URI”(redirection URI),同时附上一个授权码。
- 客户端收到授权码,附上早先的"重定向URI”,向认证服务器申请令牌。这一步是在客户端的后台的服务器上完成的,对用户不可见。
- 认证服务器核对了授权码和重定向URI,确认无误后,向客户端发送访问令牌(access token)和更新令牌(refresh token)。
流程 A 参数(GET)
response_type
:表示授权类型,必选项,此处的值固定为"code”;client_id
:表示客户端的ID,必选项;redirect_uri
:表示重定向URI,可选项;scope
:表示申请的权限范围,可选项;state
:表示客户端的当前状态,可以指定任意值,认证服务器会原封不动地返回这个值;
流程 C 参数
认证服务器回应客户端,参数有:
code
:表示授权码,必选项。该码的有效期应该很短,通常设为10分钟,客户端只能使用该码一次,否则会被授权服务器拒绝。该码与客户端ID和重定向URI,是一一对应关系。state
:如果客户端的请求中包含这个参数,认证服务器的回应也必须一模一样包含这个参数。
流程 D 参数(POST)
grant_type
:表示使用的授权模式,必选项,此处的值固定为"authorization_code"。code
:表示上一步获得的授权码,必选项。redirect_uri
:表示重定向URI,必选项,且必须与A步骤中的该参数值保持一致。client_id
:表示客户端ID,必选项。
一般来说,这里还会有一个 client_secret
验证客户端的身份,因为 client_id
对用户是可见的。需要防止某些客户端伪装成其他客户端搞事情。
流程 E 参数
access_token
:表示访问令牌,必选项。token_type
:表示令牌类型,该值大小写不敏感,必选项,可以是bearer类型或mac类型。expires_in
:表示过期时间,单位为秒。如果省略该参数,必须其他方式设置过期时间。refresh_token
:表示更新令牌,用来获取下一次的访问令牌,可选项。scope
:表示权限范围,如果与客户端申请的范围一致,此项可省略。
简化模式
简化模式(implicit grant type)不通过第三方应用程序的服务器,直接在浏览器中向认证服务器申请令牌,跳过了"授权码"这个步骤,因此得名。所有步骤在浏览器中完成,令牌对访问者是可见的,且客户端不需要认证。
简化模式中,授权服务器不能签发 refresh_token
。
####### 基本流程
|
|
步骤如下:
- 客户端将用户导向认证服务器。
- 用户决定是否给于客户端授权。
- 假设用户给予授权,认证服务器将用户导向客户端指定的"重定向URI",并在URI的Hash部分包含了访问令牌。
- 浏览器向资源服务器发出请求,其中不包括上一步收到的Hash值。
- 资源服务器返回一个网页,其中包含的代码可以获取Hash值中的令牌。
- 浏览器执行上一步获得的脚本,提取出令牌。
- 浏览器将令牌发给客户.
流程 A 参数(GET)
response_type
:表示授权类型,此处的值固定为"token",必选项。client_id
:表示客户端的ID,必选项。redirect_uri
:表示重定向的URI,可选项。scope
:表示权限范围,可选项。state
:表示客户端的当前状态,可以指定任意值,认证服务器会原封不动地返回这个值。
流程 C 参数
认证服务器回应客户端的URI,包含以下参数:
access_token
:表示访问令牌,必选项。token_type
:表示令牌类型,该值大小写不敏感,必选项。expires_in
:表示过期时间,单位为秒。如果省略该参数,必须其他方式设置过期时间。scope
:表示权限范围,如果与客户端申请的范围一致,此项可省略。state
:如果客户端的请求中包含这个参数,认证服务器的回应也必须一模一样包含这个参数。
密码模式
密码模式(Resource Owner Password Credentials Grant)中,用户向客户端提供自己的用户名和密码。客户端使用这些信息,向"服务商提供商"索要授权。
通常用在用户对客户端高度信任的情况下。
####### 基本流程
|
|
步骤如下:
- 用户向客户端提供用户名和密码。
- 客户端将用户名和密码发给认证服务器,向后者请求令牌。
- 认证服务器确认无误后,向客户端提供访问令牌。
流程 B 参数(POST)
grant_type
:表示授权类型,此处的值固定为"password",必选项。username
:表示用户名,必选项。password
:表示用户的密码,必选项。scope
:表示权限范围,可选项。
流程 C 参数
参考授权码模式-流程E。
客户端模式
客户端模式(Client Credentials Grant)指客户端以自己的名义,而不是以用户的名义,向"服务提供商"进行认证。
严格地说,客户端模式并不属于 OAuth 框架所要解决的问题。在这种模式中,用户直接向客户端注册,客户端以自己的名义要求"服务提供商"提供服务,其实不存在授权问题。
####### 基本流程
|
|
步骤如下:
- 客户端向认证服务器进行身份认证,并要求一个访问令牌。
- 认证服务器确认无误后,向客户端提供访问令牌。
流程 A 参数(POST)
grant_type
:表示授权类型,此处的值固定为"client_credentials",必选项。scope
:表示权限范围,可选项。
流程 B 参数
参考授权码模式-流程E。
更新令牌(POST)
如果用户访问的时候,客户端的"访问令牌"已经过期,则需要使用"更新令牌"申请一个新的访问令牌。
grant_type
:表示使用的授权模式,此处的值固定为"refresh_token",必选项。refresh_token
:表示早前收到的更新令牌,必选项。scope
:表示申请的授权范围,不可以超出上一次申请的范围,如果省略该参数,则表示与上一次一致。
一般也会带上 client_id
。