README

ZfrCors 是一个简单的 ZF2 模块，帮助您处理跨源资源共享（CORS）。

什么是 ZfrCors ?

ZfrCors 是一个 Zend Framework 2 模块，允许您轻松配置 ZF 2 应用程序，以便它自动构建符合 CORS 文档的 HTTP 响应。

安装

通过输入以下命令安装模块（或将其添加到您的 composer.json 文件）

$ php composer.phar require zfr/zfr-cors

然后，通过在 application.config.php 文件中添加 "ZfrCors" 来启用它。

默认情况下，ZfrCors 配置为拒绝所有 CORS 请求。要更改此设置，您需要将 config/zfr_cors.global.php.dist 文件复制到您的 autoload 文件夹（删除 .dist 扩展名），并根据您的需求进行修改。

文档

什么是 CORS ?

CORS 是一种机制，允许浏览器执行跨源请求。

例如，假设您的网站托管在 http://example.com 域名下。默认情况下，由于安全原因（例如 http://funny-domain.com），用户代理将不允许执行对另一个域的 AJAX 请求。

通过 CORS，您可以允许您的服务器响应对此类请求。

您可以在网络上找到更多关于 CORS 的工作原理的文档

事件注册

ZfrCors 在 MvcEvent::EVENT_ROUTE 事件上注册了 ZfrCors\Mvc\CorsRequestListener，优先级为 -1。这意味着该监听器在路由匹配之后执行。

配置模块

默认情况下，所有选项都是全局设置，适用于所有路由

allowed_origins: （数组）允许的源列表。要允许任何源，您可以使用通配符（*）字符。如果指定了多个源，ZfrCors 将自动检查 "Origin" 头的值，并在 "Allow-Access-Control-Origin" 响应头中返回允许的域（如果有的话）。要允许任何子域，可以在域名前缀通配符字符（例如 *.example.com）。请注意，您不需要添加您的宿主 URI（因此，如果您的网站托管为 "example.com"，则 "example.com" 自动允许）。
allowed_methods: （数组）允许的 HTTP 方法列表。这些方法将在预检请求中返回，以指示哪些方法允许用户代理。您甚至可以指定自定义 HTTP 动词。
allowed_headers: （数组）允许的标头列表，将在预检请求中返回。这表示用户代理在执行实际请求时允许发送哪些头。
max_age: （整数）预检请求应在用户代理中缓存的（秒）最大年龄。这可以防止用户代理为每个请求发送预检请求。
exposed_headers: （数组）允许在用户代理中读取的响应头列表。请注意，一些浏览器可能没有正确实现此功能。
allowed_credentials: （布尔值）如果为 true，则允许浏览器在请求中发送 cookies。

如果您想配置特定路由，可以将 ZfrCors\Options\CorsOptions::ROUTE_PARAM 添加到您的路由配置中

<?php

return [
    'zfr_cors' => [
        'allowed_origins' => ['*'],
        'allowed_methods' => ['GET', 'POST', 'DELETE'],
    ],
    'router' => [
        'routes' => [
            'readOnlyRoute' => [
                'type' => 'literal',
                'options' => [
                    'route' => '/foo/bar',
                    'defaults' => [
                        // This will replace allowed_methods configuration to only allow GET requests
                        // and only allow a specific origin instead of the wildcard origin
                        ZfrCors\Options\CorsOptions::ROUTE_PARAM => [
                            'allowed_origins' => ['http://example.org'],
                            'allowed_methods' => ['GET'],
                        ],
                    ],
                ],
            ],
            'someAjaxCalls' => [
                'type' => 'literal',
                'options' => [
                    'route' => '/ajax',
                    'defaults' => [
                        // This overrides the wildcard origin
                        ZfrCors\Options\CorsOptions::ROUTE_PARAM => [
                            'allowed_origins' => ['http://example.org'],
                        ],
                    ],
                ],
                'may_terminate' => false,
                'child_routes' => [
                    'blog' => [
                        'type' => 'literal',
                        'options' => [
                            'route' => '/blogpost',
                            'defaults' => [
                                // This would only allow `http://example.org` to GET this route
                                \ZfrCors\Options\CorsOptions::ROUTE_PARAM => [
                                    'allowed_methods' => ['GET'],
                                ],
                            ],
                        ],
                        'may_terminate' => true,
                        'child_routes' => [
                            'delete' => [
                                'type' => 'segment',
                                'options' => [
                                    'route' => ':id',
                                    // This would only allow origin `http://example.org` to apply DELETE on this route
                                    'defaults' => [
                                        \ZfrCors\Options\CorsOptions::ROUTE_PARAM => [
                                            'allowed_methods' => ['DELETE'],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
    ],
];

预检请求

如果ZfrCors检测到预检CORS请求，将创建一个新的HTTP响应，并根据您的配置发送适当的头部信息。响应将以200状态码（OK）发送。

请注意，这也会阻止进一步的MVC步骤执行，因为所有后续的MVC步骤都会被跳过，直到Zend\Mvc\MvcEvent::EVENT_FINISH，该事件负责实际发送响应。

实际请求

当发起实际请求时，ZfrCors首先检查源是否允许。如果不允许，则创建一个新的带有403状态码（禁止）的响应并发送。

请注意，这也会阻止进一步的MVC步骤执行，因为所有后续的MVC步骤都会被跳过，直到Zend\Mvc\MvcEvent::EVENT_FINISH，该事件负责实际发送响应。

如果源允许，ZfrCors将只向由Zend\Mvc产生的请求添加适当的头部信息。

安全问题

请不要使用此模块来保护您的应用程序！您必须使用适当的授权模块，例如BjyAuthorize、ZfcRbac或SpiffyAuthorize。

ZfrCors仅允许接受或拒绝跨源请求。

自定义方案

内部，ZfrCors使用Zend\Uri\UriFactory类。如果您正在使用自定义方案（例如，如果您正在使用某些Google Chrome扩展测试您的API），则需要通过将它们添加到UriFactory配置中（请参考文档）来添加对这些方案的支持。

示例

要将chrome-extension自定义方案注册到您的API中，只需将以下内容添加到module/Application/Module.php中的onBootstrap()方法中。

UriFactory::registerScheme('chrome-extension', 'Zend\Uri\Uri');

请注意，如果您的IDE无法自动解析此内容，您应该在同一文件中添加以下use定义

use Zend\Uri\UriFactory;

以这种方式注册chrome-extension自定义方案允许您使用Google Chrome扩展来测试您的API。

alejandro-fiore / zfr-cors

维护者

详细信息