OAuth2.0基本原理及应用
一.OAuth是一个关于授权(authorization)的开放网络标准,在全世界得到广泛应用,目前的版本是2.0版。
在详细讲解OAuth 2.0之前,需要了解几个专用名词,理解它们对理解OAuth2.0的基本原理很重要。
(1) Third-party application:第三方应用程序,本文中又称"客户端"(client)。
(2)HTTPservice:HTTP服务提供商,本文中简称"服务提供商"。
(3)ResourceOwner:资源所有者,本文中又称"用户"(user),简称RO。
(4)UserAgent:用户代理,本文中就是指浏览器,简称UA。
(5)Authorizationserver:认证服务器,即服务提供商专门用来处理认证的服务器,简称AS。
(6)Resourceserver:资源服务器,即服务提供商存放用户生成的资源的服务器。它与认证服务器,可以是同一台服务器,也可以是不同的服务器,简称RS。
二.OAuth2.0实现方法
1.OAuth2.0在"客户端"与"服务提供商"之间,设置了一个授权层(authorization layer)。"客户端"不能直接登录"服务提供商",只能登录授权层,以此将用户与客户端区分开来。"客户端"登录授权层所用的令牌(token),与用户的密码不同,用户可以在登录的时候,指定授权层令牌的权限范围和有效期。
"客户端"登录授权层以后,"服务提供商"根据令牌的权限范围和有效期,向"客户端"开放用户储存的资料。
三.OAuth2.0运行流程
(A)用户打开客户端以后,客户端要求用户给予授权。
(B)用户同意给予客户端授权。
(C)客户端使用上一步获得的授权,向认证服务器申请令牌。
(D)认证服务器对客户端进行认证以后,确认无误,同意发放令牌。
(E)客户端使用令牌,向资源服务器申请获取资源。
(F)资源服务器确认令牌无误,同意向客户端开放资源。
上面六个步骤之中,B是关键,即用户怎样才能给客户端授权,有了这个授权以后,客户端就可以获取令牌,进而凭令牌获取资源。
四.客户端授权4中模型
客户端必须得到用户的授权(authorization grant),才能获得令牌(access token),OAuth 2.0定义了四种授权方式。
- 授权码模式(authorization code)
- 简化模式(implicit)
- 密码模式(resource owner password credentials)
- 客户端模式(client credentials)
1. 授权码模式(authorization code):
授权码模式(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:表示客户端的当前状态,可以指定任意值,认证服务器会原封不动地返回这个值
举个例子:
C步骤中,服务器回应客户端的URI,包含以下参数:
code:表示授权码,必选项。该码的有效期应该很短,通常设为10分钟,客户端只能使用该码一次,否则会被授权服务器拒绝。该码与客户端ID和重定向URI,是一一对应关系。
state:如果客户端的请求中包含这个参数,认证服务器的回应也必须一模一样包含这个参数。
下面是一个例子:
D步骤中,客户端向认证服务器申请令牌的HTTP请求,包含以下参数:
grant_type:表示使用的授权模式,必选项,此处的值固定为"authorization_code"。
code:表示上一步获得的授权码,必选项。
redirect_uri:表示重定向URI,必选项,且必须与A步骤中的该参数值保持一致。
client_id:表示客户端ID,必选项。
下面是一个例子。
E步骤中,认证服务器发送的HTTP回复,包含以下参数:
access_token:表示访问令牌,必选项。
token_type:表示令牌类型,该值大小写不敏感,必选项,可以是bearer类型或mac类型。
expires_in:表示过期时间,单位为秒。如果省略该参数,必须其他方式设置过期时间。
refresh_token:表示更新令牌,用来获取下一次的访问令牌,可选项。
scope:表示权限范围,如果与客户端申请的范围一致,此项可省略。
下面是一个例子。
2. 简化模式(implicit)
简化模式(implicit grant type)不通过第三方应用程序的服务器,直接在浏览器中向认证服务器申请令牌,跳过了"授权码"这个步骤,因此得名。所有步骤在浏览器中完成,令牌对访问者是可见的,且客户端不需要认证。
它的具体步骤如下:
(A)客户端将用户导向认证服务器。
(B)用户决定是否给于客户端授权。
(C)假设用户给予授权,认证服务器将用户导向客户端指定的"重定向URI",并在URI的Hash部分包含了访问令牌。
(D)浏览器向资源服务器发出请求,其中不包括上一步收到的Hash值。
(E)资源服务器返回一个网页,其中包含的代码可以获取Hash值中的令牌。
(F)浏览器执行上一步获得的脚本,提取出令牌。
(G)浏览器将令牌发给客户端。
3.密码模式(resource owner password credentials)
密码模式(Resource Owner Password CredentialsGrant)中,用户向客户端提供自己的用户名和密码。客户端使用这些信息,向"服务商提供商"索要授权。
在这种模式中,用户必须把自己的密码给客户端,但是客户端不得储存密码。这通常用在用户对客户端高度信任的情况下,比如客户端是操作系统的一部分,或者由一个著名公司出品。而认证服务器只有在其他授权模式无法执行的情况下,才能考虑使用这种模式
它的具体步骤如下:
(A)用户向客户端提供用户名和密码。
(B)客户端将用户名和密码发给认证服务器,向后者请求令牌。
(C)认证服务器确认无误后,向客户端提供访问令牌。
4.客户端模式(client credentials):
客户端模式(Client Credentials Grant)指客户端以自己的名义,而不是以用户的名义,向"服务提供商"进行认证。严格地说,客户端模式并不属于OAuth框架所要解决的问题。在这种 模式中,用户直接向客户端注册,客户端以自己的名义要求"服务提供商"提供服务,其实不存在授权问题。
它的步骤如下:
(A)客户端向认证服务器进行身份认证,并要求一个访问令牌。
(B)认证服务器确认无误后,向客户端提供访问令牌。
五.令牌更新
如果用户访问的时候,客户端的"访问令牌"已经过期,则需要使用"更新令牌"申请一个新的访问令牌。
客户端发出更新令牌的HTTP请求,包含以下参数:
granttype:表示使用的授权模式,此处的值固定为"refreshtoken",必选项。
refresh_token:表示早前收到的更新令牌,必选项。
scope:表示申请的授权范围,不可以超出上一次申请的范围,如果省略该参数,则表示与上一次一致。
下面是一个例子。
六.OAuth2.0应用举例
现就将移动应用微信登录具体流程讲解如下:
1.移动应用微信登录
在进行微信OAuth2.0授权登录接入之前,在微信开放平台注册开发者帐号,并拥有一个已审核通过的移动应用,并获得相应的AppID和AppSecret。
授权流程说明:
1)第三方发起微信授权登录请求,微信用户允许授权第三方应用后,微信会拉起应用或重定向到第三方网站,并且带上授权临时票据code参数;
2)通过code参数加上AppID和AppSecret等,通过API换取access_token;
3)通过access_token进行接口调用,获取用户基本数据资源或帮助用户实现基本操作;
获取access_token时序图
第一步:请求CODE
开发者需要配合使用微信开放平台提供的SDK进行授权登录请求接入,正确接入SDK后并拥有相关授权域(scope)权限后,开发者移动应用会在终端本地拉起微信应用进行授权登录,微信用户确认后微信将拉起开发者移动应用,并带上授权临时票据(code)
Android平台应用授权登录接入代码示例:
参数说明
参数 |
是否必须 |
说明 |
appid |
是 |
应用唯一标识,在微信开放平台提交应用审核通过后获得 |
scope |
是 |
应用授权作用域,如获取用户个人信息则填写snsapi_userinfo |
state |
否 |
用于保持请求和回调的状态,授权请求后原样带回给第三方,该参数可用于防止csrf攻击 |
拉起微信打开授权登录页返回值说明:
用户点击授权后,微信客户端会被拉起,跳转至授权界面,用户在该界面点击允许或取消,SDK通过SendAuth的Resp返回数据给调用方
返回值 |
说明 |
ErrCode |
ERR_OK = 0(用户同意) |
code |
用户换取access_token的code,仅在ErrCode为0时有效 |
state |
第三方程序发送时用来标识其请求的唯一性的标志,由第三方程序调用sendReq时传入,由微信终端回传,state字符串长度不能超过1K |
lang |
微信客户端当前语言 |
country |
微信用户当前国家信息 |
第二步:通过code获取access_token
获取第一步的code后,请求以下链接获取access_token
参数说明
参数 |
是否必须 |
说明 |
Appid |
是 |
应用唯一标识,在微信开放平台提交应用审核通过后获得 |
Secret |
是 |
应用密钥AppSecret,在微信开放平台提交应用审核通过后获得 |
Code |
是 |
填写第一步获取的code参数 |
grant_type |
是 |
填authorization_code |
正确返回参数说明:
特别的Unionid:当且仅当该移动应用已获得该用户的userinfo授权时,才会出现该字段;;
1.刷新access_token有效期
access_token是调用授权关系接口的调用凭证,由于access_token有效期(目前为2个小时)较短,当access_token超时后,可以使用refresh_token进行刷新,access_token刷新结果有两种;
1)若access_token已超时,那么进行refresh_token会获取一个新的access_token,新的超时时间;
2)若access_token未超时,那么进行refresh_token不会改变access_token,但超时时间会刷新,相当于续期access_token;
refresh_token拥有较长的有效期(30天),当refresh_token失效的后,需要用户重新授权
请求方法:
获取第一步的code后,请求以下链接进行refresh_token:
参数说明:
参数 |
是否必须 |
说明 |
Appid |
是 |
应用唯一标识 |
grant_type |
是 |
填refresh_token |
refresh_token |
是 |
填写通过access_token获取到的refresh_token参数 |
正确返回的参数:
注意:
1)Appsecret是应用接口使用密钥,泄漏后将可能导致应用数据泄漏、应用的用户数据泄漏等高风险后果;存储在客户端,极有可能被恶意窃取(如反编译获取Appsecret);
2)access_token 为用户授权第三方应用发起接口调用的凭证(相当于用户登录态),存储在客户端,可能出现恶意获取access_token 后导致的用户数据泄漏、用户微信相关接口功能被恶意发起等行为;
3)refresh_token 为用户授权第三方应用的长效凭证,仅用于刷新access_token,但泄漏后相当于access_token 泄漏。
第三步:通过access_token调用接口
1. access_token有效且未超时;
2. 微信用户已授权给第三方应用帐号相应接口作用域(scope)
对于接口作用域(scope),能调用的接口有以下:
授权作用域(scope) |
接口 |
接口说明 |
snsapi_base |
/sns/oauth2/access_token /sns/oauth2/refresh_token |
通过code换取access_token、refresh_token和已授权scope 刷新或续期access_token使用 |
snsapi_userinfo |
/sns/auth /sns/userinfo |
检查access_token有效性 获取用户个人信息 |
其中snsapi_base属于基础接口,若应用已拥有其它scope权限,则默认拥有snsapi_base的权限,使用snsapi_base可以让移动端网页授权绕过跳转授权登录页请求用户授权的动作,直接跳转第三方网页带上授权临时票据(code),但会使得用户已授权作用域(scope)仅为 snsapi_base,从而导致无法获取到需要用户授权才允许获得的数据和基础功能。