README

ZfrCors is a simple ZF2 module that helps you to deal with Cross-Origin Resource Sharing (CORS).

What is ZfrCors ?

ZfrCors is a Zend Framework 2 module that allow to easily configure your ZF 2 application so that it automatically builds HTTP responses that follow the CORS documentation.

Installation

Install the module by typing (or add it to your composer.json file):

$ php composer.phar require monstrum/zfr-cors

Then, enable it by adding "ZfrCors" in your application.config.php file.

By default, ZfrCors is configured to deny every CORS requests. To change that, you need to copy the config/zfr_cors.global.php.dist file to your autoload folder (remove the .dist extension), and modify it to suit your needs.

Documentation

What is CORS ?

CORS is a mechanism that allows to perform cross-origin requests from your browser.

For instance, let's say that your website is hosted in the domain http://example.com. By default, user agents won't be allowed to perform AJAX requests to another domain for security reasons (for instance http://funny-domain.com).

With CORS, you can allow your server to reply to such requests.

You can find better documentation on how CORS works on the web:

• Mozilla documentation about CORS
• CORS server flowchart

Event registration

ZfrCors registers the ZfrCors\Mvc\CorsRequestListener with the MvcEvent::EVENT_ROUTE event, with a priority of -1. This means that this listener is executed AFTER the route has been matched.

Configuring the module

As by default, all the various options are set globally for all routes:

• allowed_origins: (array) List of allowed origins. To allow any origin, you can use the wildcard (*) character. If multiple origins are specified, ZfrCors will automatically check the "Origin" header's value, and only return the allowed domain (if any) in the "Allow-Access-Control-Origin" response header. To allow any sub-domain, you can prefix the domain with the wildcard character (i.e. *.example.com). Please note that you don't need to add your host URI (so if your website is hosted as "example.com", "example.com" is automatically allowed.
• allowed_methods: (array) List of allowed HTTP methods. Those methods will be returned for the preflight request to indicate which methods are allowed to the user agent. You can even specify custom HTTP verbs.
• allowed_headers: (array) List of allowed headers that will be returned for the preflight request. This indicates to the user agent which headers are permitted to be sent when doing the actual request.
• max_age: (int) Maximum age (seconds) the preflight request should be cached by the user agent. This prevents the user agent from sending a preflight request for each request.
• exposed_headers: (array) List of response headers that are allowed to be read in the user agent. Please note that some browsers do not implement this feature correctly.
• allowed_credentials: (boolean) If true, it allows the browser to send cookies along with the request.

If you want to configure specific routes, you can add ZfrCors\Options\CorsOptions::ROUTE_PARAM to your route configuration:

<?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'],
                                        ],
                                    ],
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ],
    ],
];

Preflight request

If ZfrCors detects a preflight CORS request, a new HTTP response will be created, and ZfrCors will send the appropriate headers according to your configuration. The response will be always sent with a 200 status code (OK).

Please note that this will also prevent further MVC steps from being executed, since all subsequent MVC steps are skipped till Zend\Mvc\MvcEvent::EVENT_FINISH, which is responsible for actually sending the response.

Actual request

When an actual request is made, ZfrCors first checks it the origin is allowed. If it is not, then a new response with a 403 status code (Forbidden) is created and sent.

Please note that this will also prevent further MVC steps from being executed, since all subsequent MVC steps are skipped till Zend\Mvc\MvcEvent::EVENT_FINISH, which is responsible for actually sending the response.

If the origin is allowed, ZfrCors will just add the appropriate headers to the request produced by Zend\Mvc.

Security concerns

Don't use this module to secure your application! You must use a proper authorization module, like BjyAuthorize, ZfcRbac or SpiffyAuthorize.

ZfrCors only allows to accept or refuse a cross-origin request.

Custom schemes

Internally, ZfrCors uses Zend\Uri\UriFactory class. If you are using custom schemes (for instance if you are testing your API with some Google Chrome extensions), you need to add support for those schemes by adding them to the UriFactory config (please refer to the doc).

Example

To register the chrome-extension custom scheme in your API, simply add:

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

to the onBootstrap() method in module/Application/Module.php. Do note that, if your IDE doesn't resolve this automatically, you should add the following use definition to the same file:

use Zend\Uri\UriFactory;

Registering the chrome-extension custom scheme like this allows you to use Google Chrome extensions for testing your API.