1. 什么是OAuth?
OAuth 是一个行业的标准授权协议,主要用来授权第三方应用获取有限的权限。而 OAuth 2.0 是对 OAuth 1.0 的完全重新设计,OAuth 2.0 更快,更容易实现,OAuth 1.0 已经被废弃。详情请见:rfc6749
实际上它就是一种授权机制,它的最终目的是为第三方应用颁发一个有时效性的令牌 Token,使得第三方应用能够通过该令牌获取相关的资源。
OAuth 2.0 比较常用的场景就是第三方登录,当你的网站接入了第三方登录的时候一般就是使用的 OAuth 2.0 协议。另外,现在 OAuth 2.0 也常见于支付场景(微信支付、支付宝支付)和开发平台(微信开放平台、阿里开放平台等等)。
下图是 Slack OAuth 2.0 第三方登录open in new window的示意图:
2. OAuth2.0的授权方式
首先要知道 OAuth的核心就是向第三方应用颁发令牌。 同时,OAuth2.0规定了四种获得令牌的流程,你可以选择最适合自己的一种,向第三方应用颁发令牌,具体授权方法如下:
授权码(Authorization Code Grant)隐藏式(implicit)密码式(password)客户端凭证(client credentials)
2.1 授权码(Authorization Code Grant)
这种方式是最常用的流程,安全性也最高,它适用于那些有后端的 Web 应用。授权码通过前端传送,令牌则是储存在后端,而且所有与资源服务器的通信都在后端完成。这样的前后端分离,可以避免令牌泄漏。
- 客户端请求授权: A 网站提供一个链接,用户点击后就会跳转到 B 网站,授权用户数据给 A 网站使用。下面就是 A 网站跳转 B 网站的一个示意链接。 下面是一个示例链接:
https://b.com/oauth/authorize?
response_type=code&
client_id=CLIENT_ID&
redirect_uri=CALLBACK_URL&
scope=read
上面 URL 中,response_type参数表示要求返回授权码(code),client_id参数让 B 知道是谁在请求,redirect_uri参数是 B 接受或拒绝请求后的跳转网址,scope参数表示要求的授权范围(这里是只读)。
- 用户授权及授权码回传: 用户跳转后,B 网站会要求用户登录,然后询问是否同意给予 A 网站授权。用户表示同意,这时 B 网站就会跳回redirect_uri参数指定的网址。跳转时,会传回一个授权码,就像下面这样。
https://a.com/callback?code=AUTHORIZATION_CODE
上面 URL 中,code参数就是授权码。
- 客户端请求访问令牌: A 网站拿到授权码以后,就可以在后端,向 B 网站请求令牌。
https://b.com/oauth/token?
client_id=CLIENT_ID&
client_secret=CLIENT_SECRET&
grant_type=authorization_code&
code=AUTHORIZATION_CODE&
redirect_uri=CALLBACK_URL
上面 URL 中,client_id参数和client_secret参数用来让 B 确认 A 的身份(client_secret参数是保密的,因此只能在后端发请求),grant_type参数的值是AUTHORIZATION_CODE,表示采用的授权方式是授权码,code参数是上一步拿到的授权码,redirect_uri参数是令牌颁发后的回调网址。
- 授权服务器验证授权码,颁发访问令牌:
B网站接收A网站请求,验证授权码的合法性,确保授权码有效且未过期,如果授权码有效,网站B颁发访问令牌给A网站,具体做法就是向
redirect_uri指定的网址,发送一段JSON数据,大致如下:
{
"access_token":"ACCESS_TOKEN",
"token_type":"bearer",
"expires_in":2592000,
"refresh_token":"REFRESH_TOKEN",
"scope":"read",
"uid":100101,
"info":{...}
}
上面 JSON 数据中,access_token字段就是令牌,A 网站在后端拿到了。
2.2 隐藏式(implicit)
有些 Web 应用是纯前端应用,没有后端。这时就不能用上面的方式了,必须将令牌储存在前端。rfc6749 就规定了第二种方式,允许直接向前端颁发令牌。这种方式没有授权码这个中间步骤,所以称为(授权码)"隐藏式"(implicit)。
第一步,A 网站提供一个链接,要求用户跳转到 B 网站,授权用户数据给 A 网站使用。
https://b.com/oauth/authorize?
response_type=token&
client_id=CLIENT_ID&
redirect_uri=CALLBACK_URL&
scope=read
上面 URL 中,response_type参数为token,表示要求直接返回令牌。
第二步,用户跳转到 B 网站,登录后同意给予 A 网站授权。这时,B 网站就会跳回redirect_uri参数指定的跳转网址,并且把令牌作为 URL 参数,传给 A 网站。
https://a.com/callback#token=ACCESS_TOKEN
上面 URL 中,token参数就是令牌,A 网站因此直接在前端拿到令牌。
注意,令牌的位置是 URL 锚点(fragment),而不是查询字符串(querystring),这是因为 OAuth 2.0 允许跳转网址是 HTTP 协议,因此存在"中间人攻击"的风险,而浏览器跳转时,锚点不会发到服务器,就减少了泄漏令牌的风险。
这种方式把令牌直接传给前端,是很不安全的。因此,只能用于一些安全要求不高的场景,并且令牌的有效期必须非常短,通常就是会话期间(session)有效,浏览器关掉,令牌就失效了。
2.3 密码式(password)
如果你高度信任某个应用,rfc6749 也允许用户把用户名和密码,直接告诉该应用。该应用就使用你的密码,申请令牌,这种方式称为"密码式"(password)。
第一步,A 网站要求用户提供 B 网站的用户名和密码。拿到以后,A 就直接向 B 请求令牌。
https://oauth.b.com/token?
grant_type=password&
username=USERNAME&
password=PASSWORD&
client_id=CLIENT_ID
上面 URL 中,grant_type参数是授权方式,这里的password表示"密码式",username和password是 B 的用户名和密码。
第二步,B 网站验证身份通过后,直接给出令牌。注意,这时不需要跳转,而是把令牌放在 JSON 数据里面,作为 HTTP 回应,A 因此拿到令牌。
这种方式需要用户给出自己的用户名/密码,显然风险很大,因此只适用于其他授权方式都无法采用的情况,而且必须是用户高度信任的应用。
2.4 客户端凭证(client credentials)
凭证式(client credentials),适用于没有前端的命令行应用,即在命令行下请求令牌。 第一步,A 应用在命令行向 B 发出请求。
https://oauth.b.com/token?
grant_type=client_credentials&
client_id=CLIENT_ID&
client_secret=CLIENT_SECRET
上面 URL 中,grant_type参数等于client_credentials表示采用凭证式,client_id和client_secret用来让 B 确认 A 的身份。
第二步,B 网站验证通过以后,直接返回令牌。
这种方式给出的令牌,是针对第三方应用的,而不是针对用户的,即有可能多个用户共享同一个令牌。
令牌的使用
A 网站拿到令牌以后,就可以向 B 网站的 API 请求数据了。
此时,每个发到 API 的请求,都必须带有令牌。具体做法是在请求的头信息,加上一个Authorization字段,令牌就放在这个字段里面。
curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.b.com"
令牌的更新
令牌的有效期到了,如果让用户重新走一遍上面的流程,再申请一个新的令牌,很可能体验不好,而且也没有必要。OAuth 2.0 允许用户自动更新令牌。
具体方法是,B 网站颁发令牌的时候,一次性颁发两个令牌,一个用于获取数据,另一个用于获取新的令牌(refresh token 字段)。令牌到期前,用户使用 refresh token 发一个请求,去更新令牌。
https://b.com/oauth/token?
grant_type=refresh_token&
client_id=CLIENT_ID&
client_secret=CLIENT_SECRET&
refresh_token=REFRESH_TOKEN
上面 URL 中,grant_type参数为refresh_token表示要求更新令牌,client_id参数和client_secret参数用于确认身份,refresh_token参数就是用于更新令牌的令牌。
B 网站验证通过以后,就会颁发新的令牌。
3. 微信OAuth第三方登录示例
具体流程如下:
- 用户点击第三方登录按钮,跳转到第三方网站上的登录页面。
- 用户在第三方网站上点击使用微信登录。
- 第三方网站将用户重定向到微信的授权页面,要求用户授权登录。
- 用户同意授权后,微信将用户重定向回第三方网站,并提供一个授权码。
- 第三方网站使用授权码向微信服务器请求访问令牌(Access Token)和用户唯一标识(OpenID)。
- 微信服务器返回访问令牌和用户唯一标识给第三方网站。
- 第三方网站使用用户唯一标识进行用户认证,如果用户不存在,则创建新用户,并将用户信息保存到数据库中。
- 第三方网站将用户登录状态保存在会话中,用户登录成功。
代码示例(SpringBoot):
- 配置微信授权回调地址:
在
application.properties或application.yml中配置微信授权回调地址。
wechat.oauth.callbackUrl=https://your-domain.com/wechat/callback
- 编写Controller处理用户点击登录按钮的请求,并重定向到微信授权页面:
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
@Controller
public class LoginController {
// 处理用户点击登录按钮的请求
@GetMapping("/login")
public String login() {
// 重定向到微信授权页面
return "redirect:https://open.weixin.qq.com/connect/oauth2/authorize?appid=YOUR_APP_ID&redirect_uri=https://your-domain.com/wechat/callback&response_type=code&scope=snsapi_base&state=STATE#wechat_redirect";
}
}
- 编写Controller处理微信授权回调:
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
@Controller
public class WechatController {
// 微信授权回调处理
@GetMapping("/wechat/callback")
public String wechatCallback(@RequestParam("code") String code) {
// 根据授权码获取访问令牌和用户唯一标识
String accessToken = getAccessTokenByCode(code);
String openid = getOpenIdByCode(code);
// 根据openid进行用户认证和登录逻辑
User user = authenticateUserByOpenId(openid);
if (user != null) {
// 登录成功,将用户信息保存在会话中
// ...
// 重定向到登录成功页面
return "redirect:/loginSuccess";
} else {
// 登录失败,跳转到登录失败页面
return "redirect:/loginFailed";
}
}
// 根据授权码获取访问令牌
private String getAccessTokenByCode(String code) {
// 发送HTTP请求到微信服务器,获取访问令牌
// ...
return accessToken;
}
// 根据授权码获取用户唯一标识
private String getOpenIdByCode(String code) {
// 发送HTTP请求到微信服务器,获取用户唯一标识
// ...
return openid;
}
// 根据openid进行用户认证和登录逻辑
private User authenticateUserByOpenId(String openid) {
// 查询数据库,根据openid获取用户信息
// ...
// 返回用户信息或null
return user;
}
}
请注意,示例中的 YOUR_APP_ID 和 https://your-domain.com 都是占位符,实际使用时需要替换为你的微信应用的AppID和授权回调地址。同时,授权码、访问令牌和用户唯一标识的获取可以通过调用微信提供的API接口来实现。