HTTP訪問控制（CORS）

一 前言

今天在開發的時候查看網絡請求注意到一個頗有意思的問題：
跨域發送post請求時，老是發送兩次，第一次是OPTIONS請求，狀態碼204；第二次纔是POST請求，狀態碼200.

這裏有和我同樣的問題描述：
https://segmentfault.com/q/10...

深刻的研究發現，這裏面的內容不簡單，因此有了下面的文章。

二 正文

有一篇權威又詳細的講解，移步這裏：HTTP訪問控制（CORS）

好了，咱們正式開始。

1.問題描述

跨域發送post請求時，老是發送兩次，第一次是OPTIONS請求，狀態碼204；第二次纔是POST請求，狀態碼200

2.OPTIONS的做用

OPTIONS請求方法的主要用途有兩個：

（1）獲取服務器支持的HTTP請求方法；也是黑客常用的方法。

（2）用來檢查服務器的性能。例如：AJAX進行跨域請求時的預檢，須要向另一個域名的資源發送一個HTTP OPTIONS請求頭，用以判斷實際發送的請求是否安全。

3.爲何會這樣？

當一個資源從與該資源自己所在的服務器不一樣的域或端口請求一個資源時，資源會發起一個跨域 HTTP 請求。

好比，站點http://domain-a.com的某 HTML 頁面經過<img>的src請求 http://domain-b.com/image.jpg。網絡上的許多頁面都會加載來自不一樣域的CSS樣式表，圖像和腳本等資源。

出於安全緣由，瀏覽器限制從腳本內發起的跨源HTTP請求。 例如，XMLHttpRequest和Fetch API遵循同源策略。 這意味着使用這些API的Web應用程序只能從加載應用程序的同一個域請求HTTP資源，除非使用CORS頭文件。
（譯者注：這段描述跨域不許確，跨域不必定是瀏覽器限制了發起跨站請求，而也多是跨站請求能夠正常發起，可是返回結果被瀏覽器攔截了。最好的例子是 CSRF 跨站攻擊原理，請求是發送到了後端服務器不管是否跨域！注意：有些瀏覽器不容許從 HTTPS 的域跨域訪問 HTTP，好比 Chrome 和 Firefox，這些瀏覽器在請求還未發出的時候就會攔截請求，這是一個特例。）

跨域資源共享（ CORS ）機制容許 Web 應用服務器進行跨域訪問控制，從而使跨域數據傳輸得以安全進行。瀏覽器支持在 API 容器中（例如 XMLHttpRequest 或 Fetch ）使用 CORS，以下降跨域 HTTP 請求所帶來的風險。

這篇文章適用於網站管理員、後端和前端開發者。CORS 須要客戶端和服務器同時支持。目前，全部瀏覽器都支持該機制。

3-1 概述
跨域資源共享標準新增了一組 HTTP 首部字段，容許服務器聲明哪些源站有權限訪問哪些資源。另外，規範要求，對那些可能對服務器數據產生反作用的 HTTP 請求方法（特別是 GET 之外的 HTTP 請求，或者搭配某些 MIME 類型的 POST 請求），瀏覽器必須首先使用 OPTIONS 方法發起一個預檢請求（preflight request），從而獲知服務端是否容許該跨域請求。服務器確認容許以後，才發起實際的 HTTP 請求。在預檢請求的返回中，服務器端也能夠通知客戶端，是否須要攜帶身份憑證（包括 Cookies 和 HTTP 認證相關數據）

3-2 簡單請求
某些請求不會觸發 CORS 預檢請求。本文稱這樣的請求爲「簡單請求」，請注意，該術語並不屬於 Fetch （其中定義了 CORS）規範。若請求知足全部下述條件，則該請求可視爲「簡單請求」：

1）使用下列方法之一：

GET
HEAD
POST

2）Fetch 規範定義了對 CORS 安全的首部字段集合，不得人爲設置該集合以外的其餘首部字段。該集合爲：

Accept
Accept-Language
Content-Language
Content-Type （須要注意額外的限制）
DPR
Downlink
Save-Data
Viewport-Width
Width

3）Content-Type 的值僅限於下列三者之一：

text/plain
multipart/form-data
application/x-www-form-urlencoded

4）請求中的任意XMLHttpRequestUpload 對象均沒有註冊任何事件監聽器；XMLHttpRequestUpload 對象可使用 XMLHttpRequest.upload 屬性訪問。
5）請求中沒有使用 ReadableStream 對象。

好比說，假如站點http://foo.example的網頁應用想要訪問http://bar.other的資源。http://foo.example的網頁中可能包含相似於下面的 JavaScript 代碼：

var invocation = new XMLHttpRequest();
var url = 'http://bar.other/resources/public-data/';
   
function callOtherDomain() {
  if(invocation) {    
    invocation.open('GET', url, true);
    invocation.onreadystatechange = handler;
    invocation.send(); 
  }
}

客戶端和服務器之間使用 CORS 首部字段來處理跨域權限：

分別檢視請求報文和響應報文：

GET /resources/public-data/ HTTP/1.1
Host: bar.other
User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-us,en;q=0.5
Accept-Encoding: gzip,deflate
Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
Connection: keep-alive
Referer: http://foo.example/examples/access-control/simpleXSInvocation.html
Origin: http://foo.example


HTTP/1.1 200 OK
Date: Mon, 01 Dec 2008 00:23:53 GMT
Server: Apache/2.0.61 
Access-Control-Allow-Origin: *
Keep-Alive: timeout=2, max=100
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: application/xml

[XML Data]

第 1~10 行是請求首部。第10行 的請求首部字段 Origin 代表該請求來源於 http://foo.exmaple。

第 13~22 行是來自於http://bar.other的服務端響應。響應中攜帶了響應首部字段 Access-Control-Allow-Origin（第 16 行）。使用 Origin 和 Access-Control-Allow-Origin 就能完成最簡單的訪問控制。本例中，服務端返回的 Access-Control-Allow-Origin: * 代表，該資源能夠被任意外域訪問。若是服務端僅容許來自 http://foo.example 的訪問，該首部字段的內容以下：

Access-Control-Allow-Origin: http://foo.example

如今，除了http://foo.example，其它外域均不能訪問該資源（該策略由請求首部中的 ORIGIN 字段定義，見第10行）。Access-Control-Allow-Origin 應當爲 * 或者包含由 Origin 首部字段所指明的域名。

3-3 預檢請求
與前述簡單請求不一樣，「需預檢的請求」要求必須首先使用 OPTIONS 方法發起一個預檢請求到服務器，以獲知服務器是否容許該實際請求。"預檢請求「的使用，能夠避免跨域請求對服務器的用戶數據產生未預期的影響。

當請求不是簡單請求時，即發送預檢請求。

以下是一個須要執行預檢請求的 HTTP 請求：

var invocation = new XMLHttpRequest();
var url = 'http://bar.other/resources/post-here/';
var body = '<?xml version="1.0"?><person><name>Arun</name></person>';
    
function callOtherDomain(){
  if(invocation)
    {
      invocation.open('POST', url, true);
      invocation.setRequestHeader('X-PINGOTHER', 'pingpong');
      invocation.setRequestHeader('Content-Type', 'application/xml');
      invocation.onreadystatechange = handler;
      invocation.send(body); 
    }
}

......

上面的代碼使用 POST 請求發送一個 XML 文檔，該請求包含了一個自定義的請求首部字段（X-PINGOTHER: pingpong）。另外，該請求的 Content-Type 爲 application/xml。所以，該請求須要首先發起「預檢請求」。

1.OPTIONS /resources/post-here/ HTTP/1.1
 2.Host: bar.other
 3.User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre
 4.Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
 5.Accept-Language: en-us,en;q=0.5
 6.Accept-Encoding: gzip,deflate
 7.Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
 8.Connection: keep-alive
 9.Origin: http://foo.example
10.Access-Control-Request-Method: POST
11.Access-Control-Request-Headers: X-PINGOTHER, Content-Type
12.
13.
14.HTTP/1.1 200 OK
15.Date: Mon, 01 Dec 2008 01:15:39 GMT
16.Server: Apache/2.0.61 (Unix)
17.Access-Control-Allow-Origin: http://foo.example
18.Access-Control-Allow-Methods: POST, GET, OPTIONS
19.Access-Control-Allow-Headers: X-PINGOTHER, Content-Type
20.Access-Control-Max-Age: 86400
21.Vary: Accept-Encoding, Origin
22.Content-Encoding: gzip
23.Content-Length: 0
24.Keep-Alive: timeout=2, max=100
25.Connection: Keep-Alive
26.Content-Type: text/plain

預檢請求完成以後，發送實際請求：

POST /resources/post-here/ HTTP/1.1
Host: bar.other
User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-us,en;q=0.5
Accept-Encoding: gzip,deflate
Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
Connection: keep-alive
X-PINGOTHER: pingpong
Content-Type: text/xml; charset=UTF-8
Referer: http://foo.example/examples/preflightInvocation.html
Content-Length: 55
Origin: http://foo.example
Pragma: no-cache
Cache-Control: no-cache

<?xml version="1.0"?><person><name>Arun</name></person>


HTTP/1.1 200 OK
Date: Mon, 01 Dec 2008 01:15:40 GMT
Server: Apache/2.0.61 (Unix)
Access-Control-Allow-Origin: http://foo.example
Vary: Accept-Encoding, Origin
Content-Encoding: gzip
Content-Length: 235
Keep-Alive: timeout=2, max=99
Connection: Keep-Alive
Content-Type: text/plain

[Some GZIP'd payload]

瀏覽器檢測到，從 JavaScript 中發起的請求須要被預檢。從上面的報文中，咱們看到，第 1~12 行發送了一個使用 OPTIONS 方法的「預檢請求」。 OPTIONS 是 HTTP/1.1 協議中定義的方法，用以從服務器獲取更多信息。該方法不會對服務器資源產生影響。 預檢請求中同時攜帶了下面兩個首部字段：

Access-Control-Request-Method: POST
Access-Control-Request-Headers: X-PINGOTHER, Content-Type

首部字段 Access-Control-Request-Method 告知服務器，實際請求將使用 POST 方法。
首部字段 Access-Control-Request-Headers 告知服務器，實際請求將攜帶兩個自定義請求首部字段：X-PINGOTHER 與 Content-Type。服務器據此決定，該實際請求是否被容許。

第14~26 行爲預檢請求的響應，代表服務器將接受後續的實際請求。重點看第 17~20 行：

Access-Control-Allow-Origin: http://foo.example
Access-Control-Allow-Methods: POST, GET, OPTIONS
Access-Control-Allow-Headers: X-PINGOTHER, Content-Type
Access-Control-Max-Age: 86400

首部字段 Access-Control-Allow-Methods 代表服務器容許客戶端使用 POST, GET 和 OPTIONS 方法發起請求。該字段與 HTTP/1.1 Allow: response header 相似，但僅限於在須要訪問控制的場景中使用。

首部字段 Access-Control-Allow-Headers 代表服務器容許請求中攜帶字段 X-PINGOTHER 與 Content-Type。與 Access-Control-Allow-Methods 同樣，Access-Control-Allow-Headers 的值爲逗號分割的列表。

最後，首部字段 Access-Control-Max-Age 代表該響應的有效時間爲 86400 秒，也就是 24 小時。在有效時間內，瀏覽器無須爲同一請求再次發起預檢請求。請注意，瀏覽器自身維護了一個最大有效時間，若是該首部字段的值超過了最大有效時間，將不會生效。

3-4 預檢請求與重定向
大多數瀏覽器不支持針對於預檢請求的重定向。若是一個預檢請求發生了重定向，瀏覽器將報告錯誤：

The request was redirected to 'https://example.com/foo', which is disallowed for cross-origin requests that require preflight

Request requires preflight, which is disallowed to follow cross-origin redirect

CORS 最初要求該行爲，不過在後續的修訂中廢棄了這一要求。

在瀏覽器的實現跟上規範以前，有兩種方式規避上述報錯行爲：

在服務端去掉對預檢請求的重定向；
將實際請求變成一個簡單請求。

若是上面兩種方式難以作到，咱們仍有其餘辦法：

發出一個簡單請求（使用  Response.url 或 XHR.responseURL）以判斷真正的預檢請求會返回什麼地址。
發出另外一個請求（真正的請求），使用在上一步經過Response.url 或 XMLHttpRequest.responseURL得到的URL。

不過，若是請求是因爲存在 Authorization 字段而引起了預檢請求，則這一方法將沒法使用。這種狀況只能由服務端進行更改。

3-5 附帶身份憑證的請求
Fetch 與 CORS 的一個有趣的特性是，能夠基於 HTTP cookies 和 HTTP 認證信息發送身份憑證。通常而言，對於跨域 XMLHttpRequest 或 Fetch 請求，瀏覽器不會發送身份憑證信息。若是要發送憑證信息，須要設置 XMLHttpRequest 的某個特殊標誌位。

本例中，http://foo.example 的某腳本向 http://bar.other 發起一個GET 請求，並設置 Cookies：

var invocation = new XMLHttpRequest();
var url = 'http://bar.other/resources/credentialed-content/';
    
function callOtherDomain(){
  if(invocation) {
    invocation.open('GET', url, true);
    invocation.withCredentials = true; // important
    invocation.onreadystatechange = handler;
    invocation.send(); 
  }
}

第 7 行將 XMLHttpRequest 的 withCredentials 標誌設置爲 true，從而向服務器發送 Cookies。由於這是一個簡單 GET 請求，因此瀏覽器不會對其發起「預檢請求」。可是，若是服務器端的響應中未攜帶 Access-Control-Allow-Credentials: true ，瀏覽器將不會把響應內容返回給請求的發送者。

客戶端與服務器端交互示例以下：

GET /resources/access-control-with-credentials/ HTTP/1.1
Host: bar.other
User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.5; en-US; rv:1.9.1b3pre) Gecko/20081130 Minefield/3.1b3pre
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Language: en-us,en;q=0.5
Accept-Encoding: gzip,deflate
Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7
Connection: keep-alive
Referer: http://foo.example/examples/credential.html
Origin: http://foo.example
Cookie: pageAccess=2


HTTP/1.1 200 OK
Date: Mon, 01 Dec 2008 01:34:52 GMT
Server: Apache/2.0.61 (Unix) PHP/4.4.7 mod_ssl/2.0.61 OpenSSL/0.9.7e mod_fastcgi/2.4.2 DAV/2 SVN/1.4.2
X-Powered-By: PHP/5.2.6
Access-Control-Allow-Origin: http://foo.example
Access-Control-Allow-Credentials: true
Cache-Control: no-cache
Pragma: no-cache
Set-Cookie: pageAccess=3; expires=Wed, 31-Dec-2008 01:34:53 GMT
Vary: Accept-Encoding, Origin
Content-Encoding: gzip
Content-Length: 106
Keep-Alive: timeout=2, max=100
Connection: Keep-Alive
Content-Type: text/plain


[text/plain payload]

即便第 11 行指定了 Cookie 的相關信息，可是，若是 bar.other 的響應中缺失 Access-Control-Allow-Credentials: true（第 19 行），則響應內容不會返回給請求的發起者。

3-6 附帶身份憑證的請求與通配符
對於附帶身份憑證的請求，服務器不得設置 Access-Control-Allow-Origin 的值爲「*」。

這是由於請求的首部中攜帶了 Cookie 信息，若是 Access-Control-Allow-Origin 的值爲「*」，請求將會失敗。而將 Access-Control-Allow-Origin 的值設置爲 http://foo.example，則請求將成功執行。

另外，響應首部中也攜帶了 Set-Cookie 字段，嘗試對 Cookie 進行修改。若是操做失敗，將會拋出異常。

4.HTTP 響應首部字段

Access-Control-Allow-Origin
響應首部中能夠攜帶一個 Access-Control-Allow-Origin 字段，其語法以下:

Access-Control-Allow-Origin: <origin> | *

其中，origin 參數的值指定了容許訪問該資源的外域 URI。對於不須要攜帶身份憑證的請求，服務器能夠指定該字段的值爲通配符，表示容許來自全部域的請求。

例如，下面的字段值將容許來自 http://mozilla.com 的請求：

Access-Control-Allow-Origin: http://mozilla.com

若是服務端指定了具體的域名而非「*」，那麼響應首部中的 Vary 字段的值必須包含 Origin。這將告訴客戶端：服務器對不一樣的源站返回不一樣的內容。

Access-Control-Expose-Headers
譯者注：在跨域訪問時，XMLHttpRequest對象的getResponseHeader()方法只能拿到一些最基本的響應頭，Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma，若是要訪問其餘頭，則須要服務器設置本響應頭。

Access-Control-Expose-Headers 頭讓服務器把容許瀏覽器訪問的頭放入白名單，例如：

Access-Control-Expose-Headers: X-My-Custom-Header, X-Another-Custom-Header

這樣瀏覽器就可以經過getResponseHeader訪問X-My-Custom-Header和 X-Another-Custom-Header 響應頭了。

Access-Control-Max-Age
Access-Control-Max-Age 頭指定了preflight請求的結果可以被緩存多久，請參考本文在前面提到的preflight例子。

Access-Control-Max-Age: <delta-seconds>

delta-seconds 參數表示preflight請求的結果在多少秒內有效。

Access-Control-Allow-Credentials
Access-Control-Allow-Credentials 頭指定了當瀏覽器的credentials設置爲true時是否容許瀏覽器讀取response的內容。當用在對preflight預檢測請求的響應中時，它指定了實際的請求是否可使用credentials。請注意：簡單 GET 請求不會被預檢；若是對此類請求的響應中不包含該字段，這個響應將被忽略掉，而且瀏覽器也不會將相應內容返回給網頁。

Access-Control-Allow-Credentials: true

上文已經討論了附帶身份憑證的請求。

Access-Control-Allow-Methods
Access-Control-Allow-Methods 首部字段用於預檢請求的響應。其指明瞭實際請求所容許使用的 HTTP 方法。

Access-Control-Allow-Methods: <method>[, <method>]*

相關示例見這裏。

Access-Control-Allow-Headers
Access-Control-Allow-Headers 首部字段用於預檢請求的響應。其指明瞭實際請求中容許攜帶的首部字段。

Access-Control-Allow-Headers: <field-name>[, <field-name>]*

5.HTTP 請求首部字段

本節列出了可用於發起跨域請求的首部字段。請注意，這些首部字段無須手動設置。 當開發者使用 XMLHttpRequest 對象發起跨域請求時，它們已經被設置就緒。

Origin
Origin 首部字段代表預檢請求或實際請求的源站。

Origin: <origin>

origin 參數的值爲源站 URI。它不包含任何路徑信息，只是服務器名稱。

Note: 有時候將該字段的值設置爲空字符串是有用的，例如，當源站是一個 data URL 時。
注意，不論是否爲跨域請求，ORIGIN 字段老是被髮送。

Access-Control-Request-Method
Access-Control-Request-Method 首部字段用於預檢請求。其做用是，將實際請求所使用的 HTTP 方法告訴服務器。

Access-Control-Request-Method: <method>

相關示例見這裏。

Access-Control-Request-Headers
Access-Control-Request-Headers 首部字段用於預檢請求。其做用是，將實際請求所攜帶的首部字段告訴服務器。

Access-Control-Request-Headers: <field-name>[, <field-name>]*

6.從axios庫再看預檢

defaults.js
axios/lib/defaults.js源碼裏面有這樣一段代碼：

var defaults = {
  adapter: getDefaultAdapter(),

  transformRequest: [function transformRequest(data, headers) {
    normalizeHeaderName(headers, 'Content-Type');
    if (utils.isFormData(data) ||  // FormData
      utils.isArrayBuffer(data) || // ArrayBuffer
      utils.isBuffer(data) ||    // Buffer
      utils.isStream(data) ||    // Stream
      utils.isFile(data) ||    // File
      utils.isBlob(data)        // Blob
    ) {
      return data;
    }
    if (utils.isArrayBufferView(data)) {
      return data.buffer;
    }
    if (utils.isURLSearchParams(data)) {
      setContentTypeIfUnset(headers, 'application/x-www-form-urlencoded;charset=utf-8');
      return data.toString();
    }
    if (utils.isObject(data)) {
      setContentTypeIfUnset(headers, 'application/json;charset=utf-8');
      return JSON.stringify(data);
    }
    return data;
  }],

這裏有三個重要的函數：
（1）utils.isURLSearchParams(data)：判斷data是不是window.URLSearchParams的實例
（2）utils.isObject(data)：判斷data是不是個object(不包含null)
（3）setContentTypeIfUnset：若是沒有手動定義過content-type值就執行一些操做

總結：

1.一般咱們不會將數據轉成二進制(ArrayBuffer、Buffer、Blob、Stream)以後再發送給服務器，若是也不是File、FormData類型這樣的話只存在utils.isURLSearchParams和utils.isObject兩種狀況；

2.咱們知道當content-type:application/json使用COSR跨域請求時會觸發預檢，因此若是咱們沒有本身手動設置過content-type值，而且data是個對象類型，那麼就會觸發預檢。

三 後記

在這篇文章中，咱們知道了：

1.什麼是簡單請求和複雜請求？
2.什麼是預檢，什麼狀況下會預檢？
3.怎樣預檢？
4.axios和預檢？

預檢會多發一次請求，如何權衡使用content-type避免複雜請求和方便的傳遞數據之間的利弊是一個值得咱們思考的問題。