Cross-Origin Resource Sharing协议介绍及服务端跨域设置

转载

jack2022 2022-12-28 18:27:38 博主文章分类：asp.net

Cross-Origin Resource Sharing协议介绍及服务端跨域设置

传统的Ajax请求只能获取在同一个域名下面的资源，但是HTML5打破了这个限制，允许Ajax发起跨域的请求。浏览器是可以发起跨域请求的，比如你可以外链一个外域的图片或者脚本。但是Javascript脚本是不能获取这些资源的内容的，它只能被浏览器执行或渲染。

在Flash和Silverlight中，服务器需要创建一个crossdomain.xml的文件来允许跨域请求。如果这个文件声明“http://your.site”允许来自“http://my.site”的请求，则来自“http://my.site”的请求可以访问所有“http://your.site”的文件。这是一种整个站点层面上的控制模式，要么你允许一个外域的站点访问，要么拒绝。

COR不一样，它是页面层次的控制模式。每一个页面需要返回一个名为‘Access-Control-Allow-Origin’的HTTP头来允许外域的站点访问。你可以仅仅暴露有限的资源和有限的外域站点访问。在COR模式中，访问控制的职责可以放到页面开发者的手中，而不是服务器管理员。当然页面开发者需要写专门的处理代码来允许被外域访问。

另外一个主要的区别是，某个站点的crossdomain.xml文件是最早被浏览器获取并分析的。如果一个外域的站点不允许被访问，浏览器压根就不会发出跨域请求。

COR则相反，Javascript先发出跨域请求，然后检查回复的‘Access-Control-Allow-Origin’头。如果这个头允许该外域访问，则Javascript可以读取这个回复，否则就被禁止访问。如果请求不是一个简单的COR，则向外域服务器发送预检验请求，如果回复的头部允许访问，则发送跨域请求，否则禁止。

COR的实现标准就是CORS协议。

对于浏览器来说，COR请求都是Javascript发起的，COR请求有两种：

1、简单的COR请求，它可以直接向外域资源发起请求。它必须仅仅包含简单的方法和头，具体定义看[2] 6.1。

2、如果COR包含复杂的方法和头，它需要发出预检验（Preflight）请求，它先向资源服务器发出一个OPTIONS方法、包含“Origin”头的请求。该回复可以控制COR请求的方法，HTTP头以及验证等信息。只有该请求获得允许以后，才会发起真实的外域请求。

下面是一个简单的COR请求：

var client = new XMLHttpRequest();

client.open("GET", "http://bar.org/b")

client.onreadystatechange = function() { /* do something */ }

client.send()

</script>

假设这个请求所在页面的域是“http://foo.org”。如果来自“http://bar.org/b”的回复包含这样的头：

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

则表明，它允许来自“http://foo.org”的跨域请求。

下面的Javascript会发出预检验请求和真实请求：

var client = new XMLHttpRequest();

client.open("GET", "http://bar.org/b")

client.setRequestHeader('Content-Type','text/html')

client.onreadystatechange = function() { /* do something */ }

client.send()

</script>

由于“Content-type: text/html”不是一个简单的头，它会先向"http://bar.org/b"发出一个OPTIONS的HTTP请求。回复可能包含这样的头：

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

Access-Control-Max-Age: 3628800

Access-Control-Allow-Methods: GET，PUT, DELETE

Access-Control-Allow-Headers: content-type

"Access-Control-Allow-Origin"表明它允许"http://foo.org"发起跨域请求

"Access-Control-Max-Age"表明在3628800秒内，不需要再发送预检验请求，可以缓存该结果

"Access-Control-Allow-Methods"表明它允许GET、PUT、DELETE的外域请求

"Access-Control-Allow-Headers"表明它允许跨域请求包含content-type头

如果预检验请求获得通过，接下来Javascript就会发起真实的COR请求，过程跟简单的COR请求类似。

CORS协议的实现

现在HTML5的标准如火如荼的在制定和发展中,CORS作为HTML5的一部分，在大部分现代浏览器中有所支持，支持(部分支持)CORS协议的浏览器有IE8+, Firefox5+, Chrome12+, Safari4+

服务端实现

Thinktecture.IdentityModel 这个库已经为我们的WebAPI,MVC的项目做好了支持，具体参看[6]。

如果是webapi,可以用这样的方法实现如下：

先添加一个处理类

/// <summary>
    /// Cors全局配置
    /// </summary>
    internal static class CorsConfig
    {
        /// <summary>
        /// 注册过滤器
        /// </summary>
        /// <param name="config"></param>
        public static void Register(HttpConfiguration config)
        {
            //定制cors跨域访问
            var cors = new EnableCorsAttribute("*", "*", "*")
            {
                SupportsCredentials = false, //disable cookie
                PreflightMaxAge = 3600 * 2 //cache 时间（seconds)
            };
            config.EnableCors(cors);
        }
    }

然后在application中注册这个类

/// <summary>
        /// 配置应用前初始化
        /// </summary>
        /// <returns></returns>
        protected override void ApplicationInitBeforeConfig(HttpConfiguration config)
        {
            base.ApplicationInitBeforeConfig(config);
            //JsonConfig.Register(config);
            CorsConfig.Register(config);
            
        }

webform的可以在web.config中直接配置即可：

把这段

<system.webServer>
    <httpProtocol>
      <customHeaders>
        <add name="Access-Control-Allow-Origin" value="*" />
        <add name="Access-Control-Allow-Methods" value="GET, POST, PUT, DELETE" />
      </customHeaders>
    </httpProtocol>
  </system.webServer>

添加到 configuration节点中，该服务端即可支持跨域访问了

参考资料：

[1] http://code.google.com/p/html5security/wiki/CrossOriginRequestSecurity

[2] http://www.w3.org/TR/cors/

[3]Cross-origin_resource_sharing

[4]跨域资源共享(Cross-Origin Resource Sharing)实现Ajax跨域请求

[5]http://restfulobjects.codeplex.com/wikipage?title=Cross%20Origin%20Resource%20Sharing&referringTitle=Documentation

[6]CORS support in WebAPI, MVC and IIS with Thinktecture.IdentityModel