前言
舉個簡單的例子。新浪微博是你的家,有時候你會想讓一些人(第三方應用)去你的家裡幫你辦點事情,或者取點東西。你可以直接複製一把鑰匙(使用者名稱和密碼)給他們,但這裡存在幾個問題:
- 別人拿了鑰匙後可以去你家裡的所有房間。
- 別人拿到你的鑰匙後也許會不小心丟到,甚至故意送到它人手裡。這樣你都不知到誰有你家鑰匙。
- 過一段時間你也許會想要回自己的鑰匙,但別人不還怎麼辦?
總結起來就是兩個問題:其一,拿到鑰匙的人許可權太大,可以進入任一房間;其二,拿到鑰匙的人可能對鑰匙進行復制和更改。
OAuth是高階鑰匙,可以理解為指紋識別,它主要解決了以上的缺陷:
- 你可以配置不同許可權的鑰匙。有些只能進大廳(讀取你的微博流)。有些鑰匙可以進儲藏櫃(讀取你的相片)。
- 鑰匙上帶著指紋驗證程式(指紋 = appkey),只有收到鑰匙的人自己能使用鑰匙。
- 鑰匙有一定的時效性,同時你也可以遠端廢除鑰匙。
正文
OAuth
是一個關於授權(authorization
)的開放網路標準,在全世界得到廣泛應用,目前的版本是2.0
版。
本文對OAuth 2.0
的設計思路和執行流程,做一個簡明通俗的解釋。
應用場景
為了理解OAuth
的適用場景,舉一個通俗易懂的例子。
有一個"雲沖印"的網站,可以將使用者儲存在Google的照片,沖印出來。使用者為了使用該服務,必須讓"雲沖印"讀取自己儲存在Google上的照片。
問題是隻有得到使用者的授權,Google才會同意"雲沖印"讀取這些照片。那麼,"雲沖印"怎樣獲得使用者的授權呢? 傳統方法是,使用者將自己的Google使用者名稱和密碼,告訴"雲沖印",後者就可以讀取使用者的照片了。這樣的做法有以下幾個嚴重的缺點。
1. "雲沖印"為了後續的服務,會儲存使用者的密碼,這樣很不安全。
2. Google不得不部署密碼登入,而我們知道,單純的密碼登入並不安全。
3. "雲沖印"擁有了獲取使用者儲存在Google所有資料的權利,使用者沒法限制"雲沖印"獲得授權的範圍和有效期。
4. 使用者只有修改密碼,才能收回賦予"雲沖印"的權力。但是這樣做,會使得其他所有獲得使用者授權的第三方應用程式全部失效。
5. 只要有一個第三方應用程式被破解,就會導致使用者密碼洩漏,以及所有被密碼保護的資料洩漏。
複製程式碼
OAuth就是為了解決上面這些問題而誕生的。
專業術語
在詳細講解OAuth 2.0
之前,需要了解幾個專用名詞。它們對讀懂後面的講解,尤其是幾張圖,至關重要。
專業術語 | 中文含義 | 具體解釋說明 |
---|---|---|
Third-party application | 第三方應用程式 | 本文中又稱"客戶端"(client),即上一節例子中的"雲沖印" |
Resource Owner | 資源所有者 | 本文中又稱"使用者"(user)。 |
HTTP service | HTTP服務提供商 | 本文中簡稱"服務提供商",即上一節例子中的Google。 |
User Agent | 使用者代理 | 本文中就是指瀏覽器。 |
Authorization server | 認證伺服器 | 即服務提供商專門用來處理認證的伺服器。 |
Resource server | 資源伺服器 | 即服務提供商存放使用者生成的資源的伺服器。它與認證伺服器,可以是同一臺伺服器,也可以是不同的伺服器。 |
OAuth的思路
OAuth
在"客戶端"與"服務提供商"之間,設定了一個授權層(authorization layer
)。"客戶端"不能直接登入"服務提供商",只能登入授權層,以此將使用者與客戶端區分開來。"客戶端"登入授權層所用的令牌(token
),與使用者的密碼不同。使用者可以在登入的時候,指定授權層令牌的許可權範圍和有效期。
"客戶端"登入授權層以後,"服務提供商"根據令牌的許可權範圍和有效期,向"客戶端"開放使用者儲存的資料。
具體流程
(A). 使用者開啟客戶端以後,客戶端要求使用者給予授權。
(B). 使用者同意給予客戶端授權。
(C). 客戶端拿到上一步獲取到的授權,向認證伺服器申請令牌。
(D). 認證伺服器對客戶端進行認證以後,確認無誤,統一發放令牌。
(E). 客戶端使用令牌,向資源伺服器申請獲取使用者的資源。
(F). 資源伺服器確認令牌無誤,同意向客戶端開放資源。
複製程式碼
不難看出來,上面六個步驟之中,步驟(B)
是關鍵,即使用者怎樣才能給於客戶端授權。有了這個授權以後,客戶端就可以獲取令牌,進而憑令牌獲取資源。
幾種授權模式
客戶端必須得到了使用者的授權。(authorization grant
),才能獲取令牌(access token
)。OAuth 2.0
定義了四種授權方式。
- 授權碼模式(authorization code)
- 簡化模式(implicit)
- 密碼模式(resource owner password credentials)
- 客戶端模式(client credentials)
下面一一講解客戶端獲取授權的四種模式。
(一). 授權碼模式
授權碼模式(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 | 客戶端的當前狀態,認證伺服器會原封不動地返回這個值 | 可選項,可以指定任意值 |
下面是一個例子:
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步驟中,伺服器迴應客戶端的URI,包含以下引數:
引數 | 具體含義 | 是否必填 |
---|---|---|
code | 授權碼。該碼的有效期應該很短,通常設為10分鐘,客戶端只能使用該碼一次,否則會被授權伺服器拒絕。該碼與客戶端ID和重定向URI,是一一對應關係 | 必選項 |
state | 如果客戶端的請求中包含這個引數,認證伺服器的迴應也必須一模一樣包含這個引數。 | 可選項 |
下面是一個例子:
HTTP/1.1 302 Found
Location: https://client.example.com/cb?code=SplxlOBeZQQYbYS6WxSbIA&state=xyz
複製程式碼
D步驟中,客戶端向認證伺服器申請令牌的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步驟中,認證伺服器傳送的HTTP回覆,包含以下引數:
引數 | 具體含義 | 是否必填 |
---|---|---|
access_token | 訪問令牌 | 必選項 |
token_type | 牌型別,該值大小寫不敏感 | 必選項,可以是bearer型別或mac型別 |
expires_in | 過期時間,單位為秒。如果省略該引數,必須其他方式設定過期時間 | 可選項 |
refresh_token | 更新令牌,用來獲取下一次的訪問令牌 | 可選項 |
scope | 申請的許可權範圍 | 可選項 |
下面是一個例子:
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache
{
"access_token":"2YotnFZFEjr1zCsicMWpAA",
"token_type":"bearer",
"expires_in":3600,
"refresh_token":"tGzv3JOkF0XG5Qx2TlKWIA",
"example_parameter":"example_value"
}
複製程式碼
從上面程式碼可以看到,相關引數使用JSON
格式傳送(Content-Type: application/json
)。此外,HTTP
頭資訊中明確指定不得快取。
(二). 簡化模式
簡化模式(implicit grant type
)不通過第三方應用程式的伺服器,直接在瀏覽器中向認證伺服器申請令牌,跳過了"授權碼"這個步驟,因此得名。所有步驟在瀏覽器中完成,令牌對訪問者是可見的,且客戶端不需要認證。
它的步驟如下:
(A). 客戶端將使用者導向認證伺服器。
(B). 使用者決定是否給於客戶端授權。
(C). 假設使用者給予授權,認證伺服器將使用者導向客戶端指定的"重定向URI",並在URI的Hash部分包含了訪問令牌。
(D). 瀏覽器向資源伺服器發出請求,其中不包括上一步收到的Hash值。
(E). 資源伺服器返回一個網頁,其中包含的程式碼可以獲取Hash值中的令牌。
(F). 瀏覽器執行上一步獲得的指令碼,提取出令牌。
(G). 瀏覽器將令牌發給客戶端。
複製程式碼
下面是上面這些步驟所需要的引數:
A步驟中,客戶端發出的HTTP請求,包含以下引數:
引數 | 具體含義 | 是否必填 |
---|---|---|
response_type | 授權型別 | 必選項,此處的值固定為"token" |
client_id | 客戶端的ID | 必選項 |
redirect_uri | 重定向URI | 可選項 |
scope | 申請的許可權範圍 | 可選項 |
state | 客戶端的當前狀態,認證伺服器會原封不動地返回這個值 | 可選項,可以指定任意值 |
下面是一個例子:
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步驟中,認證伺服器迴應客戶端的URI,包含以下引數:
引數 | 具體含義 | 是否必填 |
---|---|---|
access_token | 訪問令牌 | 必選項 |
token_type | 牌型別,該值大小寫不敏感 | 必選項 |
expires_in | 過期時間,單位為秒。如果省略該引數,必須其他方式設定過期時間 | 可選項 |
scope | 許可權範圍 | 如果與客戶端申請的範圍一致,此項可省略 |
state | 如果客戶端的請求中包含這個引數,認證伺服器的迴應也必須一模一樣包含這個引數 | 可選項 |
下面是一個例子:
HTTP/1.1 302 Found
Location: http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA
&state=xyz&token_type=example&expires_in=3600
複製程式碼
下面是一個例子:
HTTP/1.1 302 Found
Location: http://example.com/cb#access_token=2YotnFZFEjr1zCsicMWpAA
&state=xyz&token_type=bearer&expires_in=3600
複製程式碼
在上面的例子中,認證伺服器用HTTP
頭資訊的Location
欄,指定瀏覽器重定向的網址。注意,在這個網址的Hash
部分包含了令牌。
根據上面的D
步驟,下一步瀏覽器會訪問Location
指定的網址,但是Hash
部分不會傳送。
接下來的E
步驟,服務提供商的資源伺服器傳送過來的指令碼程式碼,會提取出Hash
中的令牌。
(三). 密碼模式
密碼模式(Resource Owner Password Credentials Grant
)中,使用者向客戶端提供自己的使用者名稱和密碼。客戶端使用這些資訊,向"服務商提供商"索要授權。
在這種模式中,使用者必須把自己的密碼給客戶端,但是客戶端不得儲存密碼。這通常用在使用者對客戶端高度信任的情況下,比如客戶端是作業系統的一部分,或者由一個著名公司出品。而認證伺服器只有在其他授權模式無法執行的情況下,才能考慮使用這種模式。
它的步驟如下:
(A). 使用者向客戶端提供使用者名稱和密碼。
(B). 客戶端將使用者名稱和密碼發給認證伺服器,向後者請求令牌。
(C). 認證伺服器確認無誤後,向客戶端提供訪問令牌。
複製程式碼
B步驟中,客戶端發出的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步驟中,認證伺服器向客戶端傳送訪問令牌:
引數 | 具體含義 | 是否必填 |
---|---|---|
access_token | 訪問令牌 | 必選項 |
token_type | 牌型別,該值大小寫不敏感 | 必選項 |
expires_in | 過期時間,單位為秒。如果省略該引數,必須其他方式設定過期時間 | 可選項 |
scope | 許可權範圍 | 如果與客戶端申請的範圍一致,此項可省略 |
example_parameter | 如果客戶端的請求中包含這個引數,認證伺服器的迴應也必須一模一樣包含這個引數 | 可選項 |
下面是一個例子:
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 Credentials Grant
)指客戶端以自己的名義,而不是以使用者的名義,向"服務提供商"進行認證。嚴格地說,客戶端模式並不屬於OAuth框架所要解決的問題。
在這種模式中,使用者直接向客戶端註冊,客戶端以自己的名義要求"服務提供商"提供服務,其實不存在授權問題。
它的步驟如下:
(A). 客戶端向認證伺服器進行身份認證,並要求一個訪問令牌。
(B). 認證伺服器確認無誤後,向客戶端提供訪問令牌。
複製程式碼
A步驟中,客戶端發出的HTTP請求,包含以下引數:
引數 | 具體含義 | 是否必填 |
---|---|---|
grant_type | 授權型別 | 必選項,此處的值固定為"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
複製程式碼
認證伺服器必須以某種方式,驗證客戶端身份。
B步驟中,認證伺服器向客戶端傳送訪問令牌,下面是一個例子:
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"
}
複製程式碼
總結
本文介紹了OAuth 2.0
的一些基本概念,以及四種授權模式:授權碼模式、簡單模式、密碼模式和客戶端模式。o
歡迎關注技術公眾號: 零壹技術棧
本帳號將持續分享後端技術乾貨,包括虛擬機器基礎,多執行緒程式設計,高效能框架,非同步、快取和訊息中介軟體,分散式和微服務,架構學習和進階等學習資料和文章。## ##