This package has framework agnostic Cross-Origin Resource Sharing (CORS) implementation. It is complaint with PSR-7 HTTP message interfaces.
Why this package?
- Implements the latest CORS.
- Works with PSR-7 interfaces.
- Flexible, modular and extensible solution.
- High code quality. 100% test coverage.
- Free software license Apache 2.0.
The package is designed to be used as a middleware. Typical usage
use \Neomerx\Cors\Analyzer;
use \Psr\Http\Message\RequestInterface;
use \Neomerx\Cors\Contracts\AnalysisResultInterface;
class CorsMiddleware
{
/**
* Handle an incoming request.
*
* @param RequestInterface $request
* @param Closure $next
*
* @return mixed
*/
public function handle(RequestInterface $request, Closure $next)
{
$cors = Analyzer::instance($this->getCorsSettings())->analyze($request);
switch ($cors->getRequestType()) {
case AnalysisResultInterface::ERR_NO_HOST_HEADER:
case AnalysisResultInterface::ERR_ORIGIN_NOT_ALLOWED:
case AnalysisResultInterface::ERR_METHOD_NOT_SUPPORTED:
case AnalysisResultInterface::ERR_HEADERS_NOT_SUPPORTED:
// return 4XX HTTP error
return ...;
case AnalysisResultInterface::TYPE_PRE_FLIGHT_REQUEST:
$corsHeaders = $cors->getResponseHeaders();
// return 200 HTTP with $corsHeaders
return ...;
case AnalysisResultInterface::TYPE_REQUEST_OUT_OF_CORS_SCOPE:
// call next middleware handler
return $next($request);
default:
// actual CORS request
$response = $next($request);
$corsHeaders = $cors->getResponseHeaders();
// add CORS headers to Response $response
...
return $response;
}
}
}composer require neomerx/cors-psr7
There are many possible strategies for handling cross and same origin requests which might and might not depend on data from requests.
This package has built-in strategy called Settings which implements simple settings identical for all requests (same list of allowed origins, same allowed methods for all requests and etc).
However you can customize such behaviour. For example you can send different sets of allowed methods depending on request. This might be helpful when you have some kind of Access Control System and wish to differentiate response based on request (for example on its origin). You can either implement AnalysisStrategyInterface from scratch or override methods in Settings class if only a minor changes are needed to Settings. The new strategy could be sent to Analyzer constructor or Analyzer::instance method could be used for injection.
Example
class CustomMethodsSettings extends Settings
{
public function getRequestAllowedMethods(
RequestInterface $request,
$requestMethod
) {
// An external Access Control System could be used to determine
// which methods are allowed for this request.
return ...;
}
}
$cors = Analyzer::instance(new CustomMethodsSettings())->analyze($request);composer test
Do not hesitate to contact us on 
If you have spotted any compliance issues with the CORS Recommendation please post an issue. Pull requests for documentation and code improvements (PSR-2, tests) are welcome.
Current tasks are managed with Waffle.io.
This package is using Semantic Versioning.
Apache License (Version 2.0). Please see License File for more information.