manish-pareek/stack-cors

Cross-origin resource sharing library and stack middleware

dev-master / 2.0.x-dev 2022-08-15 12:58 UTC

Requires

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

Requires (Dev)

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

MIT

• Alexander

• cors
• stack

README

Library and middleware enabling cross-origin resource sharing for your http-{foundation,kernel} using application. It attempts to implement the W3C Recommendation for cross-origin resource sharing.

Build status:

Installation

Require asm89/stack-cors using composer.

Usage

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

Options

Option	Description	Default value
allowedMethods	Matches the request method.	[]
allowedOrigins	Matches the request origin.	[]
allowedOriginsPatterns	Matches the request origin with preg_match.	[]
allowedHeaders	Sets the Access-Control-Allow-Headers response header.	[]
exposedHeaders	Sets the Access-Control-Expose-Headers response header.	false
maxAge	Sets the Access-Control-Max-Age response header.	false
supportsCredentials	Sets the Access-Control-Allow-Credentials header.	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 Asm89\Stack\CorsService;

$cors = new CorsService([
    '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 Asm89\Stack\Cors;

$app = new Cors($app, [
    // you can use ['*'] to allow any headers
    'allowedHeaders'      => ['x-allowed-header', 'x-other-allowed-header'],
    // you can use ['*'] to allow any methods
    'allowedMethods'      => ['DELETE', 'GET', 'POST', 'PUT'],
    // you can use ['*'] to allow requests from any origin
    'allowedOrigins'      => ['localhost'],
    // you can enter regexes that are matched to the origin request header
    'allowedOriginsPatterns' => ['/localhost:\d/'],
    'exposedHeaders'      => false,
    'maxAge'              => false,
    'supportsCredentials' => false,
]);