出于安全考虑,浏览器会限制从脚本内发起的跨域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 |