luminouslabs / ll-laravel-cors
Adds CORS (Cross-Origin Resource Sharing) headers support in your Laravel application
Installs: 777
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Language:JavaScript
Requires
- php: >=7.2
- asm89/stack-cors: ^2.0.1
- illuminate/contracts: ^6|^7|^8|^9|^10
- illuminate/support: ^6|^7|^8|^9|^10
- symfony/http-foundation: ^4|^5|^6
- symfony/http-kernel: ^4.3.4|^5|^6
Requires (Dev)
- laravel/framework: ^6|^7.24|^8|^9|^10
- orchestra/testbench-dusk: ^4|^5|^6|^7|^8
- phpunit/phpunit: ^6|^7|^8|^9
- squizlabs/php_codesniffer: ^3.5
This package is auto-updated.
Last update: 2024-10-16 12:51:08 UTC
README
This package is deprecated because all supported Laravel versions now include the CORS middleware in the core.
Since Laravel 9.2, this Middleware is included in laravel/framework. You can use the provided middleware, which should be compatible with the Middleware and config provided in this package. See https://github.com/laravel/laravel/pull/5825/files for the changes.
Features
- Handles CORS pre-flight OPTIONS requests
- Adds CORS headers to your responses
- Match routes to only add CORS to certain Requests
Installation
Require the luminouslabs/ll-laravel-cors
package in your composer.json
and update your dependencies:
composer require luminouslabs/ll-laravel-cors
If you get a conflict, this could be because an older version of luminouslabs/ll-laravel-cors is installed. Remove the conflicting package first, then try install again:
composer remove barryvdh/laravel-cors fruitcake/laravel-cors composer require luminouslabs/ll-laravel-cors
Global usage
To allow CORS for all your routes, add the HandleCors
middleware at the top of the $middleware
property of app/Http/Kernel.php
class:
protected $middleware = [ \Fruitcake\Cors\HandleCors::class, // ... ];
Now update the config to define the paths you want to run the CORS service on, (see Configuration below):
'paths' => ['api/*'],
Configuration
The defaults are set in config/cors.php
. Publish the config to copy the file to your own config:
php artisan vendor:publish --tag="cors"
Note: When using custom headers, like
X-Auth-Token
orX-Requested-With
, you must set theallowed_headers
to include those headers. You can also set it to['*']
to allow all custom headers.
Note: If you are explicitly whitelisting headers, you must include
Origin
or requests will fail to be recognized as CORS.
Options
allowed_origins
, allowed_headers
and allowed_methods
can be set to ['*']
to accept any value.
Note: For
allowed_origins
you must include the scheme when not using a wildcard, eg.['http://example.com', 'https://example.com']
. You must also take into account that the scheme will be present when usingallowed_origins_patterns
.
Note: Try to be as specific as possible. You can start developing with loose constraints, but it's better to be as strict as possible!
Note: Because of http method overriding in Laravel, allowing POST methods will also enable the API users to perform PUT and DELETE requests as well.
Note: Sometimes it's necessary to specify the port (when you're coding your app in a local environment for example). You can specify the port or using a wildcard here too, eg.
localhost:3000
,localhost:*
or even using a FQDNapp.mydomain.com:8080
Lumen
On Lumen, just register the ServiceProvider manually in your bootstrap/app.php
file:
$app->register(Fruitcake\Cors\CorsServiceProvider::class);
$app->configure('cors');
Global usage for Lumen
To allow CORS for all your routes, add the HandleCors
middleware to the global middleware and set the paths
property in the config.
$app->middleware([ // ... Fruitcake\Cors\HandleCors::class, ]);
Common problems
Wrong config
Make sure the path
option in the config is correct and actually matches the route you are using. Remember to clear the config cache as well.
Error handling, Middleware order
Sometimes errors/middleware that return own responses can prevent the CORS Middleware from being run. Try changing the order of the Middleware and make sure it's the first entry in the global middleware, not a route group. Also check your logs for actual errors, because without CORS, the errors will be swallowed by the browser, only showing CORS errors. Also try running it without CORS to make sure it actually works.
Authorization headers / Credentials
If your Request includes an Authorization header or uses Credentials mode, set the supports_credentials
value in the config to true. This will set the Access-Control-Allow-Credentials Header to true
.
Echo/die
If you use echo()
, dd()
, die()
, exit()
, dump()
etc in your code, you will break the Middleware flow. When output is sent before headers, CORS cannot be added. When the script exits before the CORS middleware finishes, CORS headers will not be added. Always return a proper response or throw an Exception.
Disabling CSRF protection for your API
If possible, use a route group with CSRF protection disabled.
Otherwise you can disable CSRF for certain requests in App\Http\Middleware\VerifyCsrfToken
:
protected $except = [ 'api/*', 'sub.domain.zone' => [ 'prefix/*' ], ];
Duplicate headers
The CORS Middleware should be the only place you add these headers. If you also add headers in .htaccess, nginx or your index.php file, you will get duplicate headers and unexpected results.
No Cross-Site requests
If you are not doing Cross-Site requests, meaning if you are not requesting site-a.com/api from site-b.com, your browser will not send the Origin: https://site-b.com
request header, CORS will be "disabled" as the Access-Control-Allow-Origin
header will be also missing. This happens because requests are being dispatched from the same and no protection is needed in this case.