跨域概念
「**同源策略**」是一个重要的安全策略,它用于限制一个origin的文档或者它加载的脚本如何能与另一个源的资源进行交互。它能帮助阻隔恶意文档,减少可能被攻击的媒介。
—来源 MDN
同源策略是一种浏览器安全策略,页面和资源的信任关系,信任则可以访问,不信任则不可以访问。
同源是指两个url之间的关系,如果两个url的协议、域名、端口都相同,则为同源,否则是不同源,也就是跨域。
url1 | url2 | 是否跨域 | 原因 |
---|---|---|---|
http://www.test.com/ | http://www.test.com/index.html | 否 | 协议、域名、端口相同 |
http://www.test.com/ | https://www.test.com/ | 是 | 协议不同 |
http://www.test.com/ | http://www.baidu.com/ | 是 | 主域名不同 |
http://www.test.com/ | http://blog.test.com/ | 是 | 二级域名不同 |
http://www.test.com:8080/ | http://www.test.com:7001/ | 是 | 端口不同 |
也就是说,同源是可以信任的,非同源的默认不可信。
跨域限制
跨域的限制有几种
缓存访问限制
JavaScript无法访问非同源网页的cookie、localStroage、sessionStorage、indexedDB
比如http://www.lingtiku.com/index.html页面的脚步,就无法访问http://fe.lingtiku.com/index.html域名下的缓存资源。
DOM访问限制
无法访问非同源网页的DOM
比如http://www.lingtiku.com/index.html页面加载了一个iframe:http://fe.lingtiku.com/index.html,前者无法获取和操作后者的DOM。
<!-- http://www.lingtiku.com/index.html -->
<html>
<body>
<iframe id="blog_page" src="http://www.lingtiku.com/blog.html" />
<script>
function test() {
// 清空blog页面内容
document.querySelector('#blog_page').contentWindow.document.body.innerHTML = '';
}
</script>
</body>
</html>
接口访问限制
无法向非同源地址发送http请求
实际上如果跨域访问接口,浏览器并不会直接block,而是会向后端发送请求,但后端接口并不会无条件响应。浏览器和后端接口会进行一个基于W3C标准的协商,决定是否能得到正常响应。
如果是同源就可以正常访问。
就像一家人就可以随便进屋,外人需要敲门,主人同意才能进。
接口cookie携带限制
默认跨域访问接口,不携带cookie
默认情况下在跨域请求,浏览器是不带 cookie 的(这是CORS标准规定的,现代差不多版本的浏览器都支持CORS),不过可以通过某些方法设置携带cookie。
后面会说明CORS和携带cookie的方法。
跨域访问资源
有了上面的约束,会让网站资源更安全,但有些场景需要跨域访问资源,下面介绍跨域访问资源的方法。
跨域访问cookie
跨域无法直接访问localStorage,不过可以通过一些方法访问cookie,当然仅限一级域名相同,二级域名不同的两个网页。
例如http://www.lingtiku.com和http://fe.lingtiku.com想要共享cookie,只需要在两个页面都作如下设置即可
document.domain = 'lingtiku.com';
⚠️注意:document.domain
已经被chrome禁用,可以使用其他替代方法来跨域通信:postMessage
和设置Origin-Agent-Cluster
标头。参考下面文章:
https://developer.chrome.com/blog/immutable-document-domain?hl=zh-cn
https://web.dev/articles/origin-agent-cluster?hl=zh-cn
跨域页面通信
如果一个页面(主页面)加载了另一个iframe(子页面),并且主页面和子页面是跨域的,主页面想要访问子页面的dom,方法和上面的跨域访问cookieL类似,可以设置document.domain
或者设置Origin-Agent-Cluster
标头。
postMessage
是跨域主页面和子iframe通信的方法,参考下面示例
<!-- http://www.lingtiku.com -->
<html>
<body>
<iframe id="blog_page" src="http://blog.lingtiku.com" />
<script>
// 给子页面发送数据
function send() {
/**
* otherWindow.postMessage(message, targetOrigin, [transfer])
* message,一个对象,需要传给子iframe的信息
* targetOrigin,目标origin,如果传具体的origin,当子iframe的origin和targetOrigin不同时候,浏览器不会发送数据,防止攻击者恶意修改iframe地址,把数据传递给攻击者。targetOrigin也可以传"*",浏览器传递数据时候就不会校验。
*/
document.querySelector('#blog_page').contentWindow.postMessage(
{code: 0, msg: 'Hello, I am your father'},
'http://blog.lingtiku.com'
);
}
// 监听子页面数据
window.addEventListener('message', function (event) {
// 通过origin属性判断消息来源
if (event.origin === 'http://blog.lingtiku.com') {
console.log('子页面发来的消息: ', event.data.msg);
}
}, false);
</script>
</body>
</html>
<!-- http://blog.lingtiku.com -->
<html>
<body>
<script>
// 给父页面发送数据
function send() {
if (!window.parent) {
return;
}
window.parent.postMessage(
{code: 0, msg: 'Hello, I am son'},
// 也可以设置为"*",不校验
'http://www.lingtiku.com'
);
}
// 监听父页面数据
window.addEventListener('message', function (event) {
// 通过origin属性判断消息来源
if (event.origin === 'http://www.lingtiku.com') {
console.log(event.source === window.parent); // true
console.log('子页面发来的消息: ', event.data.msg);
}
}, false);
</script>
</body>
</html>
跨域访问接口
如果前端页面和后端接口跨域,例如前端页面是https://www.lingtiku.com,后端接口是https://api.lingtiku.com,前端想要访问后端接口,需要特殊处理。下面是几种跨域访问接口的方法
JSONP
JSONP利用script标签没有跨域访问限制的特性实现跨域接口访问。
JSONP原理是,前端通过script标签发起GET请求,后端接收到请求后返回一个JavaScript回调函数的执行,这个回调函数是前端定义的,且传入需要的数据作为参数,这样就实现了跨域接口访问,可以看下面示例
const Koa = require("koa");
const fs = require("fs");
const app = new Koa();
app.use(async (ctx, next) => {
if (ctx.path === "/api/jsonp") {
const { cb, msg } = ctx.query;
ctx.body = `${cb}(${JSON.stringify({ msg })})`;
return;
}
});
app.listen(8080);
<script type="text/javascript">
window.jsonpCallback = function(res) {
console.log(res);
};
</script>
<script src="http://localhost:8080/api/jsonp?msg=hello&cb=jsonpCallback" type="text/javascript">
</script>
拿到后端返回的结果后,前端代码等同于
<script type="text/javascript">
window.jsonpCallback = function(res) {
console.log(res);
};
</script>
<script type="text/javascript">
jsonpCallback('{"msg":"hello"}');
</script>
关键步骤是
- 前端定义回调函数(示例中是
jsonpCallback
) - 后端注册GET接口,根据前端传递的回调函数响应请求,其实是返回了一个执行了回调函数的脚步
代理
开发中的代理方式
在本地开发时候,前端访问地址通常是http://localhost:8080,或者http://47.120.98.33:8080这种格式,这时候可能会出现后端接口访问跨域(因为接口可能配置了限定访问的域名),为了让本地开发时候可以正常访问后端接口,主要有2种实践:
NodeJS代理
思路是本地前端代码请求到本地的NodeJS服务,然后NodeJS服务再请求后端接口,拿到响应后返回给前端。
PS:本地NodeJS服务除了可以用作代理服务,也可以mock数据。
本地代理工具
核心思路是用代理工具将线上前端域名重定向到本地开发的地址,而后端接口域名则被代理转发。
实现步骤是
- 安装浏览器插件,用来把请求打到本地代理工具。
- 安装代理工具,配置重定向规则:前端页面线上域名=>本地开发地址,如果前后端域名一致,需要根据路径配置忽略后端接口,把接口请求转发到后端。
- 在浏览器打开前端页面线上地址,OK!
生产中的代理:nginx反向代理
CORS
CORS是一个W3C标准,全称是”跨域资源共享”(Cross-origin resource sharing)。
它允许浏览器向跨源服务器,发出
XMLHttpRequest
请求,从而克服了AJAX只能同源使用的限制。
简介
CORS需要浏览器和服务器同时支持。目前,所有浏览器都支持该功能,IE浏览器不能低于IE10。
整个CORS通信过程,都是浏览器自动完成,不需要用户参与。对于开发者来说,CORS通信与同源的AJAX通信没有差别,代码完全一样。浏览器一旦发现AJAX请求跨源,就会自动添加一些附加的头信息,有时还会多出一次附加的请求,但用户不会有感觉。
因此,实现CORS通信的关键是服务器。只要服务器实现了CORS接口,就可以跨源通信。
两种请求
浏览器将CORS请求分成两类:简单请求(simple request)和非简单请求(not-so-simple request)。
只要同时满足以下两大条件,就属于简单请求。
(1) 请求方法是以下三种方法之一:
- HEAD
- GET
- POST
(2)HTTP的头信息不超出以下几种字段:
- Accept
- Accept-Language
- Content-Language
- Last-Event-ID
- Content-Type:只限于三个值application/x-www-form-urlencoded、multipart/form-data、text/plain
这是为了兼容表单(form),因为历史上表单一直可以发出跨域请求。AJAX 的跨域设计就是,只要表单可以发,AJAX 就可以直接发。
凡是不同时满足上面两个条件,就属于非简单请求。
浏览器对这两种请求的处理,是不一样的。
简单请求
基本流程
对于简单请求,浏览器直接发出CORS请求。具体来说,就是在头信息之中,增加一个Origin字段。
下面是一个例子,浏览器发现这次跨源AJAX请求是简单请求,就自动在头信息之中,添加一个Origin字段。
GET /cors HTTP/1.1
Origin: http://api.bob.com
Host: api.alice.com
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...
上面的头信息中,Origin字段用来说明,本次请求来自哪个源(协议 + 域名 + 端口)。服务器根据这个值,决定是否同意这次请求。
如果Origin指定的源,不在许可范围内,服务器会返回一个正常的HTTP回应。浏览器发现,这个回应的头信息没有包含Access-Control-Allow-Origin字段(详见下文),就知道出错了,从而抛出一个错误,被XMLHttpRequest
的onerror
回调函数捕获。注意,这种错误无法通过状态码识别,因为HTTP回应的状态码有可能是200。
如果Origin指定的域名在许可范围内,服务器返回的响应,会多出几个头信息字段。
Access-Control-Allow-Origin: http://api.bob.com
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: FooBar
Content-Type: text/html; charset=utf-8
上面的头信息之中,有三个与CORS请求相关的字段,都以Access-Control-开头。
(1)Access-Control-Allow-Origin
该字段是必须的。它的值要么是请求时Origin字段的值,要么是一个*,表示接受任意域名的请求。
(2)Access-Control-Allow-Credentials
该字段可选。它的值是一个布尔值,表示是否允许发送Cookie。默认情况下,Cookie不包括在CORS请求之中。设为true,即表示服务器明确许可,Cookie可以包含在请求中,一起发给服务器。这个值也只能设为true,如果服务器不要浏览器发送Cookie,删除该字段即可。
(3)Access-Control-Expose-Headers
该字段可选。CORS请求时,XMLHttpRequest对象的getResponseHeader()方法只能拿到6个基本字段:Cache-Control、Content-Language、Content-Type、Expires、Last-Modified、Pragma。如果想拿到其他字段,就必须在Access-Control-Expose-Headers里面指定。上面的例子指定,getResponseHeader(‘FooBar’)可以返回FooBar字段的值。
withCredentials 属性
上面说到,CORS请求默认不发送Cookie和HTTP认证信息。如果要把Cookie发到服务器,一方面要服务器同意,指定Access-Control-Allow-Credentials字段。
Access-Control-Allow-Credentials: true
另一方面,开发者必须在AJAX请求中打开withCredentials属性。
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;
否则,即使服务器同意发送Cookie,浏览器也不会发送。或者,服务器要求设置Cookie,浏览器也不会处理。
但是,如果省略withCredentials设置,有的浏览器还是会一起发送Cookie。这时,可以显式关闭withCredentials。
xhr.withCredentials = false;
需要注意的是,如果要发送Cookie,Access-Control-Allow-Origin就不能设为星号,必须指定明确的、与请求网页一致的域名。同时,Cookie依然遵循同源政策,只有用服务器域名设置的Cookie才会上传,其他域名的Cookie并不会上传,且(跨源)原网页代码中的document.cookie也无法读取服务器域名下的Cookie。
非简单请求
预检请求
非简单请求是那种对服务器有特殊要求的请求,比如请求方法是PUT或DELETE,或者Content-Type字段的类型是application/json。
非简单请求的CORS请求,会在正式通信之前,增加一次HTTP查询请求,称为”预检”请求(preflight)。
浏览器先询问服务器,当前网页所在的域名是否在服务器的许可名单之中,以及可以使用哪些HTTP动词和头信息字段。只有得到肯定答复,浏览器才会发出正式的XMLHttpRequest请求,否则就报错。
下面是一段浏览器的JavaScript脚本。
var url = 'http://api.alice.com/cors';
var xhr = new XMLHttpRequest();
xhr.open('PUT', url, true);
xhr.setRequestHeader('X-Custom-Header', 'value');
xhr.send();
上面代码中,HTTP请求的方法是PUT,并且发送一个自定义头信息X-Custom-Header。
浏览器发现,这是一个非简单请求,就自动发出一个”预检”请求,要求服务器确认可以这样请求。下面是这个”预检”请求的HTTP头信息。
OPTIONS /cors HTTP/1.1
Origin: http://api.bob.com
Access-Control-Request-Method: PUT
Access-Control-Request-Headers: X-Custom-Header
Host: api.alice.com
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...
“预检”请求用的请求方法是OPTIONS,表示这个请求是用来询问的。头信息里面,关键字段是Origin,表示请求来自哪个源。
除了Origin字段,”预检”请求的头信息包括两个特殊字段。
(1)Access-Control-Request-Method
该字段是必须的,用来列出浏览器的CORS请求会用到哪些HTTP方法,上例是PUT。
(2)Access-Control-Request-Headers
该字段是一个逗号分隔的字符串,指定浏览器CORS请求会额外发送的头信息字段,上例是X-Custom-Header。
预检请求的回应
服务器收到”预检”请求以后,检查了Origin、Access-Control-Request-Method和Access-Control-Request-Headers字段以后,确认允许跨源请求,就可以做出回应。
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://api.bob.com
Access-Control-Allow-Methods: GET, POST, PUT
Access-Control-Allow-Headers: X-Custom-Header
Content-Type: text/html; charset=utf-8
Content-Encoding: gzip
Content-Length: 0
Keep-Alive: timeout=2, max=100
Connection: Keep-Alive
Content-Type: text/plain
上面的HTTP回应中,关键的是Access-Control-Allow-Origin字段,表示http://api.bob.com可以请求数据。该字段也可以设为星号,表示同意任意跨源请求。
Access-Control-Allow-Origin: *
如果服务器否定了”预检”请求,会返回一个正常的HTTP回应,但是没有任何CORS相关的头信息字段。这时,浏览器就会认定,服务器不同意预检请求,因此触发一个错误,被XMLHttpRequest对象的onerror回调函数捕获。控制台会打印出如下的报错信息。
XMLHttpRequest cannot load http://api.alice.com.
Origin http://api.bob.com is not allowed by Access-Control-Allow-Origin.
服务器回应的其他CORS相关字段如下。
Access-Control-Allow-Methods: GET, POST, PUT
Access-Control-Allow-Headers: X-Custom-Header
Access-Control-Allow-Credentials: true
Access-Control-Max-Age: 1728000
(1)Access-Control-Allow-Methods
该字段必需,它的值是逗号分隔的一个字符串,表明服务器支持的所有跨域请求的方法。注意,返回的是所有支持的方法,而不单是浏览器请求的那个方法。这是为了避免多次”预检”请求。
(2)Access-Control-Allow-Headers
如果浏览器请求包括Access-Control-Request-Headers字段,则Access-Control-Allow-Headers字段是必需的。它也是一个逗号分隔的字符串,表明服务器支持的所有头信息字段,不限于浏览器在”预检”中请求的字段。
(3)Access-Control-Allow-Credentials
该字段与简单请求时的含义相同。
(4)Access-Control-Max-Age
该字段可选,用来指定本次预检请求的有效期,单位为秒。上面结果中,有效期是20天(1728000秒),即允许缓存该条回应1728000秒(即20天),在此期间,不用发出另一条预检请求。
浏览器的正常请求和回应
一旦服务器通过了”预检”请求,以后每次浏览器正常的CORS请求,就都跟简单请求一样,会有一个Origin头信息字段。服务器的回应,也都会有一个Access-Control-Allow-Origin头信息字段。
下面是”预检”请求之后,浏览器的正常CORS请求。
PUT /cors HTTP/1.1
Origin: http://api.bob.com
Host: api.alice.com
X-Custom-Header: value
Accept-Language: en-US
Connection: keep-alive
User-Agent: Mozilla/5.0...
上面头信息的Origin字段是浏览器自动添加的。
下面是服务器正常的回应。
Access-Control-Allow-Origin: http://api.bob.com
Content-Type: text/html; charset=utf-8
上面头信息中,Access-Control-Allow-Origin字段是每次回应都必定包含的。
与JSONP比较
CORS与JSONP的使用目的相同,但是比JSONP更强大。
JSONP只支持GET请求,CORS支持所有类型的HTTP请求。JSONP的优势在于支持老式浏览器,以及可以向不支持CORS的网站请求数据。
总结
上面内容来自参考文章《跨域资源共享 CORS 详解》。
下面总结下关键内容。
CORS是W3C标准,用来实现跨域访问资源。
在CORS中主要需要服务器配置响应头,浏览器行为大部分是默认的。
在CORS标准中,分为简单请求和非简单请求(简单请求的定义见上面3.2),对于这两种请求,浏览器处理和请求过程是不一样的。
简单请求
浏览器会加Origin
请求头,标识请求方的源.
服务器需要加响应头:
Access-Control-Allow-Origin
(必须,值为指定的某个Origin或者 *(表示接受任意域名的访问))Access-Control-Allow-Credentials
(可选,表示是否允许发送Cookie)Access-Control-Expose-Headers
(可选,表示浏览器可读的header字段)。
如果服务器没有配置Access-Control-Allow-Origin
,或者配置的Access-Control-Allow-Origin
没有包含请求头中的Origin,就无法成功访问资源。
通过这种协商,就可以让服务器在一定限定下允许跨域访问资源。
非简单请求
非简单请求需要浏览器先发送一次预检请求(OPTIONS),预检成功才正式发送请求。预检请求中,浏览器询问服务器2个方面
- 当前网页所在的域名是否在服务器的许可名单之中
- 可以使用哪些HTTP动词和头信息字段。
只有得到肯定答复,浏览器才会发出正式的XMLHttpRequest请求,否则就报错。
开发者发送请求时候,如果浏览器发现,这是一个非简单请求,就自动发出一个”预检”请求,要求服务器确认可以这样请求。浏览器自动添加的请求头包含3个主要字段:
Origin
(和简单请求功能一样)Access-Control-Request-Method
(询问服务器将要发送的请求Method是否被允许)Access-Control-Request-Headers
(询问将要发送的请求的额外Header是否被允许)。
服务器需要配置的响应头包括
Access-Control-Allow-Origin
(必需,和简单请求时候一样)Access-Control-Allow-Methods
(必需,允许的请求Methods,如果预检请求中Access-Control-Request-Method
不在允许的范围内,预检失败)Access-Control-Allow-Headers
(如果浏览器请求包括Access-Control-Request-Headers
字段,则Access-Control-Allow-Headers
字段是必需的,若请求头中的header不在被允许的范围内,预检失败)Access-Control-Allow-Credentials
(和简单请求一样,用来控制是否允许携带cookie)Access-Control-Max-Age
(可选,有效期内不用再发送预检,直接请求即可)
预检成功后,正式请求和简单请求类似。
Cookie的SameSite属性
如果跨域禁止携带cookie,则有些需求不满足,如果允许跨域携带cookie,又不安全。Cookie的SameSite属性可以用来解决这个问题,让网站可以更安全地访问接口,并携带Cookie。
CSP
除了接口跨域访问限制,还可以设置资源跨域访问限制,这就是CSP。
跨域常见报错汇总
- https页面中发送http请求,会被浏览器block,因为跨域访问,不安全。
- 如果后端未配access-control-allow-origin,跨域访问会报错。
- 如果未配 access-control-allow-method,在非简单请求时候,会报错。
- 一个请求可能经过网关和服务,可能多添加access-control-allow-origin头,在浏览器检测network时候会发现有多个access-control-allow-origin,浏览器也会相应报错。解决方法是可以让一个nginx不返回access-control-allow-origin(用proxy_hide_header指令)
- 前端的request的content-type不对时候,浏览器会把简单请求当做非简单请求处理,可能会报跨域的错误。
- 如果请求有自定义header,后端又没有配Access-Control-Allow-Headers,会报错。
- 请求的withCredentials为true时候,后端要返回access-allow-origin为相应的origin,不能是*,而且access-allow-control-credentials也要配为true
- chrome的samesite默认lax,需要后台设置samesite为,同时要求secure为true,即只能用https访问。
为什么服务端和客户端没有跨域?
因为服务端和客户端没有域名,也就没有跨域。跨域本质是服务器的信任问题,因为数据都存在服务器,所以服务器的安全性需要保障,如何保障安全性,就在于有个机制让服务器判断是否应该信任请求方,那首先就是标识请求方,前端页面可以用域名标识(除非域名劫持,否则同域是安全的,因为都是自己人),后端和客户端没有域名,可以有其他的方式解决信任问题,比如或者鉴权,例如access_token等,其实就是对暗号,双方都有一个暗号表(事先颁发给信任的人的),其他人没有,我说上联你能对出来下联就说明是我发给你的,就是可信任的。