出於安全考慮,瀏覽器會限制從腳本內發起的跨域HTTP請求。例如,XMLHttpRequest
和 Fetch 遵循同源策略。所以,使用 XMLHttpRequest
或 Fetch 的Web應用程序只能將HTTP請求發送到其本身的域。爲了改進Web應用程序,開發人員要求瀏覽器廠商容許跨域請求。php
(譯者注:這段描述跨域不許確,跨域並非不必定是瀏覽器限制了發起跨站請求,而也多是跨站請求能夠正常發起,可是返回結果被瀏覽器攔截了。最好的例子是 CSRF 跨站攻擊原理,請求是發送到了後端服務器不管是否跨域!注意:有些瀏覽器不容許從 HTTPS 的域跨域訪問 HTTP,好比 Chrome 和 Firefox,這些瀏覽器在請求還未發出的時候就會攔截請求,這是一個特例。)html
跨域資源共享( CORS )機制容許 Web 應用服務器進行跨域訪問控制,從而使跨域數據傳輸得以安全進行。瀏覽器支持在 API 容器中(例如 XMLHttpRequest
或 Fetch )使用 CORS,以下降跨域 HTTP 請求所帶來的風險。前端
這篇文章適用於網站管理員、後端和前端開發者。CORS 須要客戶端和服務器同時支持。目前,全部瀏覽器都支持該機制。 對於服務端的支持,開發者能夠閱讀補充材料 cross-origin sharing from a server perspective (with PHP code snippets) 。html5
跨域資源共享標準( cross-origin sharing standard )容許在下列場景中使用跨域 HTTP 請求:git
XMLHttpRequest
或 Fetch 發起的跨域 HTTP 請求。 @font-face
使用跨域字體資源), 所以,網站就能夠發佈 TrueType 字體資源,並只容許已受權網站進行跨站調用。drawImage
將 Images/video 畫面繪製到 canvas本文概述了跨域資源共享機制及其所涉及的 HTTP 首部字段。github
跨域資源共享標準新增了一組 HTTP 首部字段,容許服務器聲明哪些源站有權限訪問哪些資源。另外,規範要求,對那些可能對服務器數據產生反作用的 HTTP 請求方法(特別是 GET
之外的 HTTP 請求,或者搭配某些 MIME 類型的 POST
請求),瀏覽器必須首先使用 OPTIONS
方法發起一個預檢請求(preflight request),從而獲知服務端是否容許該跨域請求。服務器確認容許以後,才發起實際的 HTTP 請求。在預檢請求的返回中,服務器端也能夠通知客戶端,是否須要攜帶身份憑證(包括 Cookies 和 HTTP 認證相關數據)。web
接下來的內容將討論相關場景,並剖析該機制所涉及的 HTTP 首部字段。shell
這裏,咱們使用三個場景來解釋跨域資源共享機制的工做原理。這些例子都使用 XMLHttpRequest
對象。canvas
本文中的 JavaScript 代碼片斷均可以從 http://arunranga.com/examples/access-control/ 得到。另外,使用支持跨域 XMLHttpRequest
的瀏覽器訪問該地址,能夠看到代碼的實際運行結果。後端
關於服務端對跨域資源共享的支持的討論,請參見這篇文章: Server-Side_Access_Control (CORS)。
某些請求不會觸發 CORS 預檢請求。本文稱這樣的請求爲「簡單請求」,請注意,該術語並不屬於 Fetch (其中定義了 CORS)規範。若請求知足全部下述條件,則該請求可視爲「簡單請求」:
Content-Type
的值僅限於下列三者之一:
text/plain
multipart/form-data
application/x-www-form-urlencoded
Accept
,
Accept-Language
, 和
Content-Language
首部字段的值添加了額外的限制。若是這些首部字段的值是「非標準」的,WebKit/Safari 就不會將這些請求視爲「簡單請求」。WebKit/Safari 並無在文檔中列出哪些值是「非標準」的,不過咱們能夠在這裏找到相關討論:
Require preflight for non-standard CORS-safelisted request headers Accept, Accept-Language, and Content-Language,
Allow commas in Accept, Accept-Language, and Content-Language request headers for simple CORS, and
Switch to a blacklist model for restricted Accept headers in simple CORS requests。其它瀏覽器並不支持這些額外的限制,由於它們不屬於規範的一部分。
好比說,假如站點 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 首部字段所指明的域名。
與前述簡單請求不一樣,「需預檢的請求」要求必須首先使用 OPTIONS
方法發起一個預檢請求到服務器,以獲知服務器是否容許該實際請求。"預檢請求「的使用,能夠避免跨域請求對服務器的用戶數據產生未預期的影響。
當請求知足下述任一條件時,即應首先發送預檢請求:
Accept
Accept-Language
Content-Language
Content-Type
(but note the additional requirements below)DPR
Downlink
Save-Data
Viewport-Width
Width
Content-Type
的值不屬於下列之一:
application/x-www-form-urlencoded
multipart/form-data
text/plain
注意: WebKit Nightly 和 Safari Technology Preview 爲Accept
, Accept-Language
, 和 Content-Language
首部字段的值添加了額外的限制。若是這些首部字段的值是「非標準」的,WebKit/Safari 就不會將這些請求視爲「簡單請求」。WebKit/Safari 並無在文檔中列出哪些值是「非標準」的,不過咱們能夠在這裏找到相關討論:Require preflight for non-standard CORS-safelisted request headers Accept, Accept-Language, and Content-Language, Allow commas in Accept, Accept-Language, and Content-Language request headers for simple CORS, and Switch to a blacklist model for restricted Accept headers in simple CORS requests。其它瀏覽器並不支持這些額外的限制,由於它們不屬於規範的一部分。
以下是一個須要執行預檢請求的 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。所以,該請求須要首先發起「預檢請求」。
OPTIONS /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 Origin: http://foo.example Access-Control-Request-Method: POST Access-Control-Request-Headers: X-PINGOTHER, Content-Type HTTP/1.1 200 OK Date: Mon, 01 Dec 2008 01:15:39 GMT Server: Apache/2.0.61 (Unix) 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 Vary: Accept-Encoding, Origin Content-Encoding: gzip Content-Length: 0 Keep-Alive: timeout=2, max=100 Connection: Keep-Alive 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
首部字段 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 小時。在有效時間內,瀏覽器無須爲同一請求再次發起預檢請求。請注意,瀏覽器自身維護了一個最大有效時間,若是該首部字段的值超過了最大有效時間,將不會生效。
大多數瀏覽器不支持針對於預檢請求的重定向。若是一個預檢請求發生了重定向,瀏覽器將報告錯誤:
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 最初要求該行爲,不過在後續的修訂中廢棄了這一要求。
在瀏覽器的實現跟上規範以前,有兩種方式規避上述報錯行爲:
若是上面兩種方式難以作到,咱們仍有其餘辦法:
不過,若是請求因爲缺失 Authorization 字段而引發一個預檢請求,則這一方法將沒法使用。這種狀況只能由服務端進行更改。
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; 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 行),則響應內容不會返回給請求的發起者。
對於附帶身份憑證的請求,服務器不得設置 Access-Control-Allow-Origin 的值爲「*」。
這是由於請求的首部中攜帶了 Cookie 信息,若是 Access-Control-Allow-Origin 的值爲「*」,請求將會失敗。而將 Access-Control-Allow-Origin 的值設置爲
http://foo.example,則請求將成功執行。
另外,響應首部中也攜帶了 Set-Cookie 字段,嘗試對 Cookie 進行修改。若是操做失敗,將會拋出異常。
本節列出了規範所定義的響應首部字段。上一小節中,咱們已經看到了這些首部字段在實際場景中是如何工做的。
響應首部中能夠攜帶一個 Access-Control-Allow-Origin
字段,其語法以下:
Access-Control-Allow-Origin: <origin> | *
其中,origin 參數的值指定了容許訪問該資源的外域 URI。對於不須要攜帶身份憑證的請求,服務器能夠指定該字段的值爲通配符,表示容許來自全部域的請求。
例如,下面的字段值將容許來自 http://mozilla.com 的請求:
Access-Control-Allow-Origin: http://mozilla.com
若是服務端指定了具體的域名而非「*」,那麼響應首部中的 Vary 字段的值必須包含 Origin。這將告訴客戶端:服務器對不一樣的源站返回不一樣的內容。
譯者注:在跨域訪問時,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
頭指定了preflight請求的結果可以被緩存多久,請參考本文在前面提到的preflight例子。
Access-Control-Max-Age: <delta-seconds>
delta-seconds
參數表示preflight請求的結果在多少秒內有效。
Access-Control-Allow-Credentials
頭指定了當瀏覽器的credentials
設置爲true時是否容許瀏覽器讀取response的內容。當用在對preflight預檢測請求的響應中時,它指定了實際的請求是否可使用credentials
。請注意:簡單 GET 請求不會被預檢;若是對此類請求的響應中不包含該字段,這個響應將被忽略掉,而且瀏覽器也不會將相應內容返回給網頁。
Access-Control-Allow-Credentials: true
上文已經討論了附帶身份憑證的請求。
Access-Control-Allow-Methods
首部字段用於預檢請求的響應。其指明瞭實際請求所容許使用的 HTTP 方法。
Access-Control-Allow-Methods: <method>[, <method>]*
相關示例見這裏。
Access-Control-Allow-Headers
首部字段用於預檢請求的響應。其指明瞭實際請求中容許攜帶的首部字段。
Access-Control-Allow-Headers: <field-name>[, <field-name>]*
本節列出了可用於發起跨域請求的首部字段。請注意,這些首部字段無須手動設置。 當開發者使用 XMLHttpRequest 對象發起跨域請求時,它們已經被設置就緒。
Origin
首部字段代表預檢請求或實際請求的源站。
Origin: <origin>
origin 參數的值爲源站 URI。它不包含任何路徑信息,只是服務器名稱。
注意,不論是否爲跨域請求,ORIGIN 字段老是被髮送。
Access-Control-Request-Method
首部字段用於預檢請求。其做用是,將實際請求所使用的 HTTP 方法告訴服務器。
Access-Control-Request-Method: <method>
相關示例見這裏。
Access-Control-Request-Headers
首部字段用於預檢請求。其做用是,將實際請求所攜帶的首部字段告訴服務器。
Access-Control-Request-Headers: <field-name>[, <field-name>]*
相關示例見這裏。
Specification | Status | Comment |
---|---|---|
Fetch CORS |
Living Standard | New definition; supplants CORS specification. |
Unknown | Unknown | Initial definition. |
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari |
---|---|---|---|---|---|
Basic support | 4 | 3.5 | 8 (via XDomainRequest) 10 |
12 | 4 |