🌟思维风暴
Author Image
༒过渡忙碌使你落后

© 2024 tkstorm.com

粤ICP备14088510号

Http Options Request

2016/07/21 共 3340 字 8 分钟阅读
HTTP cors
AI 摘要: 跨域资源共享（CORS）是一种用于解决跨域请求的浏览器技术规范，提供了跨域HTTP请求的方法，以绕过同源策略限制。与JSONP不同，CORS支持更多的HTTP请求方法，同时错误处理也更好。CORS机制需要客户端和服务器都支持，目前所有浏览器都支持该机制。CORS标准新增了一组HTTP首部字段，用于服务器声明哪些源站有权限访问哪些资源，并且对可能对服务器数据产生副作用的请求方法需要先进行预检请求。

跨来源资源共享（CORS），全称是"跨域资源共享"（Cross-origin resource sharing），亦译为跨域资源共享，是一份W3C浏览器技术的规范，提供了 Web 服务从不同网域传来沙盒脚本的方法，以避开浏览器的同源策略，是 JSONP 模式的现代版。

与 JSONP 不同，CORS 除了 GET 请求方法以外也支持其他的 HTTP 请求。用 CORS 可以让网页设计师用一般的 XMLHttpRequest，这种方式的错误处理比 JSONP 要来的好。另一方面，JSONP 可以在不支持 CORS 的老旧浏览器上运作。现代的浏览器都支持 CORS

1. HTTP访问控制（CORS）

1.1. 概述

当一个资源从与该资源本身所在的服务器请求一个其他资源时，以下资源会发起一个CORS(跨域资源请求访问服务）：

  • 不同的域(a.com -> b.com/xx.js)
  • 端口不同的域(a.com -> b.com:8080/xx.js)
  • 不同的端口(a.com -> a.com:8080)

出于安全考虑，浏览器会限制从脚本内发起的跨域HTTP请求，比如XMLHttpRequest 和 Fetch 遵循同源策略。 CORS 需要客户端和服务器同时支持。目前，所有浏览器都支持该机制。 浏览器不允许从 HTTPS 的域跨域访问 HTTP，比如 Chrome 和 Firefox，这些浏览器在请求还未发出的时候就会拦截请求，这是一个特例。

跨域资源共享标准（ cross-origin sharing standard ）允许在下列场景中使用跨域 HTTP 请求：

  • Web 字体,允许已授权网站进行跨站调用。
  • 样式表
  • Scripts
  • 由 XMLHttpRequest 或 Fetch 发起的跨域 HTTP 请求。

1.2. CORS机制所涉及到的HTTP首部字段

跨域资源共享标准新增了一组 HTTP 首部字段，允许服务器声明哪些源站有权限访问哪些资源。另外，规范要求，对那些可能对服务器数据产生副作用的 HTTP 请求方法（特别是 GET 以外的 HTTP 请求，或者搭配某些 MIME 类型的 POST 请求），浏览器必须首先使用 OPTIONS 方法发起一个预检请求（preflight request），从而获知服务端是否允许该跨域请求。服务器确认允许之后，才发起实际的 HTTP 请求。在预检请求的返回中，服务器端也可以通知客户端，是否需要携带身份凭证（包括 Cookies 和 HTTP 认证相关数据）。

跨域三个场景来解释跨域资源共享机制的工作原理

1.2.1. 简单跨域请求

若请求满足所有下述条件，则该请求可视为“简单请求”，简单请求下不会触发CORS预检请求：

  • GET
  • HEAD
  • POST（仅当POST方法的Content-Type值等于下列之一才算作简单请求），Content-Type ：
    • text/plain
    • multipart/form-data
    • application/x-www-form-urlencoded

1.2.1.1. 简单跨域请求 - DEMO

假如站点 http://foo.example 的网页应用想要访问 http://bar.other 的资源。http://foo.example 的网页中可能包含类似于下面的 JavaScript 代码：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

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();
  }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

[请求头]
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

服务端返回的 Access-Control-Allow-Origin: * 表明，该资源可以被任意外域访问。如果服务端仅允许来自 http://foo.example 的访问，该首部字段的内容如下：Access-Control-Allow-Origin: http://foo.example，Access-Control-Allow-Origin 应当为 * 或者包含由 Origin 首部字段所指明的域名。

1.2.2. 跨域预检请求

与前述简单请求不同，“需预检的请求”要求必须首先使用OPTIONS方法发起一个预检请求到服务器，以获知服务器是否允许该实际请求。“预检请求“的使用，可以避免跨域请求对服务器的用户数据产生未预期的影响。

当请求满足下述任一条件时，即应首先发送预检请求：

  • 使用了下面任一 HTTP 方法：
    • PUT
    • DELETE
    • CONNECT
    • OPTIONS
    • TRACE
    • PATCH
  • 人为设置了对 CORS 安全的首部字段集合之外的其他首部字段
  • Content-Type 的值不属于下列之一:
    • application/x-www-form-urlencoded
    • multipart/form-data
    • text/plain

如下是一个需要执行预检请求的 HTTP 请求，以下的代码使用 POST 请求发送一个 XML 文档，该请求包含了一个自定义的请求首部字段（X-PINGOTHER: pingpong）。另外，该请求的 Content-Type 为 application/xml。因此，该请求需要首先发起“预检请求”。

OPTIONS 是 HTTP/1.1 协议中定义的方法，用以从服务器获取更多信息。该方法不会对服务器资源产生影响。 预检请求中同时携带了下面两个首部字段：Access-Control-Request-Method、Access-Control-Request-Headers；首部字段 Access-Control-Request-Method 告知服务器，实际请求将使用 POST 方法。首部字段 Access-Control-Request-Headers 告知服务器，实际请求将携带两个自定义请求首部字段：X-PINGOTHER 与 Content-Type。服务器据此决定，该实际请求是否被允许。

首部字段 Access-Control-Allow-Methods 表明服务器允许客户端使用 POST, GET 和 OPTIONS 方法发起请求。 首部字段 Access-Control-Allow-Headers 表明服务器允许请求中携带字段 X-PINGOTHER 与 Content-Type。与 Access-Control-Allow-Methods 一样，Access-Control-Allow-Headers 的值为逗号分割的列表。 首部字段 Access-Control-Max-Age 表明该响应的有效时间为 86400 秒，也就是 24 小时。在有效时间内，浏览器无须为同一请求再次发起预检请求。请注意，浏览器自身维护了一个最大有效时间，如果该首部字段的值超过了最大有效时间，将不会生效。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

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);
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

[预检请求 - OPTIONS]
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							-------------------客户端申请访问控制请求HTTP方法
Access-Control-Request-Headers: X-PINGOTHER, Content-Type	-------------------客户端申请访问控制请求HTTP头信息

[预检请求 - OPTIONS 响应]
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				-------------------服务端允许HTTP的请求方法
Access-Control-Allow-Headers: X-PINGOTHER, Content-Type		-------------------服务端允许HTTP的请求头信息
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

# 2. 预检请求完成之后，发送实际请求
[实际请求 - 请求头]
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]

2.2.1. 预检请求与重定向

大多数浏览器不支持针对于预检请求的重定向。如果一个预检请求发生了重定向，浏览器将报告错误：

1
2
3

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

在浏览器的实现跟上规范之前，有两种方式规避上述报错行为：

  • 在服务端去掉对预检请求的重定向；
  • 将实际请求变成一个简单请求。

如果上面两种方式难以做到，我们仍有其他办法：

  • 使用简单请求模拟预检请求，用以探查预检请求是否重定向到其他 URL（使用 Response.url 或 XHR.responseURL）；
  • 向上一步中获得的 URL 发起请求。

2.3. 附带身份凭证的请求与通配符

Fetch 与 CORS 的一个有趣的特性是，可以基于 HTTP cookies 和 HTTP 认证信息发送身份凭证。

一般而言，对于跨域 XMLHttpRequest 或 Fetch 请求，浏览器不会发送身份凭证信息。如果要发送凭证信息，需要设置 XMLHttpRequest 的某个特殊标志位。

对于附带身份凭证的请求，服务器不能够将 Access-Control-Allow-Origin 的值设置为“*”，而必须设置成 Access-Control-Allow-Origin: http://foo.example

2.3.1. 附带身份凭证的请求 - DEMO

http://foo.example 的某脚本向 http://bar.other 发起一个GET 请求，并设置 Cookies；

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

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();
  }
}

[请求头]
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

2.3.2. HTTP 请求首部字段

本节列出了可用于发起跨域请求的首部字段。请注意，这些首部字段无须手动设置。 当开发者使用 XMLHttpRequest 对象发起跨域请求时，它们已经被设置就绪。

  • Origin:
    • Origin 首部字段表明预检请求或实际请求的源站，origin 参数的值为源站 URI。
    • 注意，不管是否为跨域请求，ORIGIN 字段总是被发送。
    • 有时候将该字段的值设置为空字符串是有用的，例如，当源站是一个 data URL 时。
  • Access-Control-Request-Method:
    • Access-Control-Request-Method 首部字段用于预检请求。其作用是，将实际请求所使用的 HTTP 方法告诉服务器。
  • Access-Control-Request-Headers: [, ]*
    • 字段用于预检请求。其作用是，将实际请求所携带的首部字段告诉服务器。

2.3.3. HTTP 响应首部字段

  • Access-Control-Allow-Origin : | *
    • 指定了允许访问该资源的外域 URI；
  • Access-Control-Expose-Headers : X-My-Custom-Header, X-Another-Custom-Header
    • 在跨域访问时，XMLHttpRequest对象的getResponseHeader()方法只能拿到一些最基本的响应头，Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma，如果要访问其他头，则需要服务器设置本响应头。
  • Access-Control-Max-Age ：
    • 指定了preflight请求的结果能够被缓存多久，delta-seconds 参数表示preflight请求的结果在多少秒内有效
  • Access-Control-Allow-Credentials ： true
    • 指定了当浏览器的credentials设置为true时是否允许浏览器读取response的内容。当用在对preflight预检测请求的相应中时，它指定了实际的请求是否可以使用credentials。请注意：简单 GET 请求不会被预检；如果对此类请求的响应中不包含该字段，这个响应将被忽略掉，并且浏览器也不会将相应内容返回给网页
  • Access-Control-Allow-Methods: [, ]*
    • 字段用于预检请求的响应。其指明了实际请求所允许使用的 HTTP 方法。
  • Access-Control-Allow-Headers: [, ]*
    • 首部字段用于预检请求的响应。其指明了实际请求中允许携带的首部字段。

2.1. 参考资料

  1. MOZILLA ACCESS_CONTROLL CORS
  2. 为什么XMLHttpRequest的POST请求会变OPTIONS请求
Mac Tips - 使用Mac的一些小技巧 (持续更新） PHP处理相关细节 - FastCGI协议、FastCGI请求处理、ZendEngine、Opcode字节码