mehmetik/cors

The `CorsSupport` class is a library for managing cross-origin resource sharing (CORS) and a middleware that operates on HTTP requests and responses in a stack application.

1.0 2022-12-27 13:58 UTC

Requires

• php: ^7.2|^8.0
• symfony/http-foundation: ^4|^5|^6
• symfony/http-kernel: ^4|^5|^6

Requires (Dev)

• phpunit/phpunit: ^7|^9
• squizlabs/php_codesniffer: ^3.5

MIT

• Mehmet Karabulut

• cors
• stack

README

This package provides a library and stack middleware for handling Cross-Origin Resource Sharing (CORS) in a Stack application.

Installation

To install the package, require it through Composer.

composer require mehmetik/cors

Usage

This package can be used as a library or as stack middleware.

Options

Option	Description	Type	Default value
allowedMethods	Matches the request method.	string[]	[]
allowedOrigins	Matches the request origin.	string[]	[]
allowedOriginsPatterns	Matches the request origin with preg_match.	string[]	[]
allowedHeaders	Sets the Access-Control-Allow-Headers response header.	string[]	[]
exposedHeaders	Sets the Access-Control-Expose-Headers response header.	string[]	[]
maxAge	Sets the Access-Control-Max-Age response header.	int	false
supportsCredentials	Sets the Access-Control-Allow-Credentials header.	bool	false

The allowedMethods and allowedHeaders options are case-insensitive.

You don't need to provide both allowedOrigins and allowedOriginsPatterns. If one of the strings passed matches, it is considered a valid origin.

If ['*'] is provided to allowedMethods, allowedOrigins or allowedHeaders all methods / origins / headers are allowed.

Example: using the library

<?php
use mehmetik\Cors\CorsSupport;

$cors = new CorsSupport([
    'allowedHeaders'         => ['x-allowed-header', 'x-other-allowed-header'],
    'allowedMethods'         => ['DELETE', 'GET', 'POST', 'PUT'],
    'allowedOrigins'         => ['http://localhost'],
    'allowedOriginsPatterns' => ['/localhost:\d/'],
    'exposedHeaders'         => false,
    'maxAge'                 => false,
    'supportsCredentials'    => false,
]);

$cors->addActualRequestHeaders(Response $response, $origin);
$cors->handlePreflightRequest(Request $request);
$cors->isActualRequestAllowed(Request $request);
$cors->isCorsRequest(Request $request);
$cors->isPreflightRequest(Request $request);

Example: using the stack middleware

<?php
use mehmetik\Cors\Cors;

$app = new Stack\Builder();
$app->push(new Cors($app, [
    'allowedHeaders'         => ['x-allowed-header', 'x-other-allowed-header'],
    'allowedMethods'         => ['DELETE', 'GET', 'POST', 'PUT'],
    'allowedOrigins'         => ['http://localhost'],
    'allowedOriginsPatterns' => ['/localhost:\d/'],
    'exposedHeaders'         => false,
    'maxAge'                 => false,
    'supportsCredentials'    => false,
]));

License

This package is licensed under the MIT License. See the LICENSE file for details.