Hi,我是阿昌
,今天学习记录的是关于各大开放平台是如何使用OAuth 2.0
的内容。
“开放平台”,不难理解,它的作用就是企业把自己的业务能力主要以开放 API 的形式,赋能给外部开发者
。而作为第三方开发者或者 ISV(独立软件供应商)在接入这些开放平台的时候,最应该关心的就是它们的官方文档
,关注接入的流程是怎样的、对应的 API 是什么、每个 API 都传递哪些参数,也就差不多够了。到这里,会发现“开放平台的官方文档”会是一个关键点。不过呢,当去各大开放平台上面看这些文档的时候,就会发现这些文档非常分散。其中的原因也很简单,那就是开放平台为了让已经具备 OAuth 2.0 知识的研发人员去快速地对接平台上面的业务,把各类对接流程做了分类归档。比如,会发现微信开放平台上有使用授权码获取授权信息的文档,也有获取令牌的文档,但并没有一份整体的、能够串起来的文档说明。从一个角度来看,这其实也就间接提高使用门槛
,因为如果你不懂 OAuth 2.0,基本是没办法理解那些分类的。下面以京东、微信、支付宝、美团为代表的各大开放平台是如何使用 OAuth 2.0 的。
先来看看大厂的开放平台全局体系,各个开放平台基本的系统结构和授权系统在中间的交互流程,大同小异,都是通过授权服务来授权,通过网关来鉴权。
所以接下来,以京东商家开放平台
为例,来说说开放平台的体系。
先来看一下京东商家开放平台全局体系的结构,如下图所示。
可以把这个架构体系分为三部分来看:
从图中还可以看到这个体系整体的调用关系是:第三方软件通过 HTTP 协议请求到开放平台,更具体地说是开放平台的 API 网关服务,然后由 API 网关通过内部的 RPC 调用到各个微服务。
接下来,再以用户小明使用打单软件为例,来看看这些系统角色之间具体又是怎样交互的?
可以发现,在开放平台体系中各个系统角色间的交互可以归结为:
验证访问令牌或者第三方软件应用信息的时候,都是在受保护资源服务中去做的。当有了 API 网关这一层的时候,这些校验工作就会都落到了 API 网关的身上,因为我们不能让很多个受保护资源服务做同样的事情。理解了京东商家开放平台的体系结构后,可以小结下了。
依靠开放平台提供的能力,可以说开放平台、用户和开发者实现了三赢:
但同时呢,开放也是一把双刃剑。理想状态下,平台、开发者、用户可以实现三赢,安全的问题绝不容忽视,而用户的信息安全又是重中之重。
开放平台体系是如何解决访问令牌安全问题的案例。
用户给第三方软件授权之后,授权服务就会生成一个访问令牌
,而且这个访问令牌是跟用户关联的。比如,小明给小兔打单软件进行了授权,那么此时访问令牌的粒度就是:小兔打单软件 + 小明。
小兔打单软件可以拿着这个访问令牌去代表小明访问小明的数据;如果访问令牌过期了,小兔打单软件还可以继续使用刷新令牌
来访问,直到刷新令牌也过期了。
现在问题来了,如果小明注销了账号,或者修改了自己的密码,那他之前为其它第三方软件进行授权的访问令牌就应该立即失效。否则,在刷新令牌过期之前,第三方软件可以一直拿着之前的访问令牌去请求数据。这显然不合理。
所以在这种情况下,授权服务就要通过 MQ(消息队列)接收用户的注销和修改密码这两类消息,然后对访问令牌进行清理。(这里也会出现消息发出和执行的中间差问题
)
其实,这个案例中解决访问令牌安全问题的方式,不仅仅适用于开放平台,还可以为在企业内构建自己的 OAuth 2.0 授权体系结构时提供借鉴。以上就是开放平台整体的结构,以及其中需要重点关注的用户访问令牌的安全性问题了。
作为第三方软件开发者,在对接到这些开放平台或者浏览它们的网站时,几乎都能看到类似这样的一句话:“所有接口都需要接入 OAuth 授权,经过用户确认授权后才可以调用”,这正是 OAuth 2.0 的根本性作用。
以微信、支付宝、美团为例,看看它们在开放授权上是如何使用 OAuth 2.0 的。
首先看一下官方的授权流程图:
引自微信官方文档
引自支付宝开放平台文档
引自美团外卖开放平台
可以在这三张授权流程图中看到,都有和授权码 code 相关的文字。这就说明,它们都建议开发者首选授权码流程。作为开发者在对接开放平台的时候,最关心的就是它们提供的官方对接文档了。这些文档里面,最让人头疼就是那些通信过程中需要传递的参数了。
以京东商家开放平台为例,给串下这些参数背后的含义,以及关键点。这样在做具体接入操作的时候,就可以举重若轻了。
授权码流程中的参数说明概括来讲,在京东商家开放平台的授权服务这一侧,提供服务的就是两个端点:
小明在使用小兔打单软件的时候,首先被小兔通过重定向的方式引导到京东商家开放平台的授权服务上,其实就是引导到了授权服务的授权端点上。这个重定向的过程中用到的参数如下:
这里需要强调的是,对于 state 参数
,现在官方都是“推荐”使用。OAuth 2.0 官方建议的避免 CSRF 攻击的方式
,就是使用 state 参数。所以安全起见,还是应该使用。
接着,京东商家开放平台授权服务的授权端点,会向小兔软件做出响应。这个响应的过程用到的基本参数,如下:
对于授权码 code 的值,一般建议的最长生命周期是 10 分钟。另外,小兔打单软件只能被允许使用一次该授权码的值,如果使用一次之后还用同样的授权码值来请求,授权服务必须拒绝。
对于这次的 state 值,授权服务每次都是必须要返回给小兔打单软件的。无论小兔打单软件在起初的时候有没有发送该值,都必须返回回去,如果没有就返回空。
这样当小兔打单软件日后升级增加该值的时候,京东商家开放平台就不需要改动任何代码逻辑了。
在拿到授权码 code 的值之后,接下来就是小兔打单软件向京东商家开放平台的授权服务的令牌端点发起请求,申请访问令牌。
这个过程中需要传递的基本参数,如下:
在授权服务接收到小兔打单软件申请访问令牌的请求后,像授权端点一样,令牌端点也需要向小兔打单软件做出响应。
这个过程涉及到的基本参数,如下:
对于这里返回的 scope 值,要强调下,其实就是小兔软件被允许的实际的权限范围,因为小明有可能给小兔软件授予了小于它在开放平台注册时申请的权限范围。
比如,小兔打单软件申请了查询历史订单、查询当天订单两个 API 的权限,但小明可能只给小兔授权了查询当天订单 API 的权限。
开放平台体系的整体结构和授权流程,以及第三方软件开发者关心的对接开放平台的通信流程中需要传递的参数。以下三点内容。