Download the PHP package spatie/laravel-cors without Composer
On this page you can find all versions of the php package spatie/laravel-cors. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download spatie/laravel-cors
More information about spatie/laravel-cors
Files in spatie/laravel-cors
Package laravel-cors
Short Description Send CORS headers in a Laravel or Lumen application
License MIT
Homepage https://github.com/spatie/laravel-cors
Informations about the package laravel-cors
Notice
We have abandoned this package because Laravel 7 introduced native support for CORS. Only use this package if you're on Laravel 6 or below.
Send CORS headers in a Laravel application
This package will add CORS headers to the responses of your Laravel or Lumen app. For more infomation about CORS, see the Mozilla CORS documentation.
This package supports preflight requests and is easily configurable to fit your needs.
Installation
- Laravel
- Lumen
Laravel
You can install the package via Composer:
The package will automatically register its service provider.
The provided Spatie\Cors\Cors
middleware must be registered in the global middleware group.
This is the default content of the config file published at config/cors.php
:
Lumen
You can install the package via Composer:
Copy the config file from the vendor directory:
Register the config file, the middleware and the service provider in bootstrap/app.php
:
Usage
With the middleware installed your API routes should now get appropriate CORS headers. Preflight requests will be handled as well. If a request comes in that is not allowed, Laravel will return a 403
response.
The default configuration of this package allows all requests from any origin (denoted as '*'
). You probably want to at least specify some origins relevant to your project. If you want to allow requests to come in from https://spatie.be
and https://laravel.com
add those domains to the config file:
If you, for example, want to allow all subdomains from a specific domain, you can use the wildcard asterisk (*
) and specifiy that:
Creating your own CORS profile
Imagine you want to specify allowed origins based on the user that is currently logged in. In that case the DefaultProfile
which just reads the config file won't cut it. Fortunately it's very easy to write your own CORS profile, which is simply a class that extends Spatie\Cors\DefaultProfile
.
Here's a quick example where it is assumed that you've already added an allowed_domains
column on your user model:
You can override the default HTTP status code and message returned when a request is forbidden by editing the forbidden_response
array in your configuration file:
Don't forget to register your profile in the config file.
In the example above we've overwritten the allowOrigins
method, but of course you may choose to override any of the methods present in DefaultProfile
.
Testing
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Alternatives
- barryvdh/laravel-cors: a tried and tested package. Our package is a modern rewrite of the basic features of Barry's excellent one. We created our own solution because we needed our configuration to be very flexible.
Postcardware
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
We publish all received postcards on our company website.
Credits
- Freek Van der Herten
- All Contributors
Support us
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
License
The MIT License (MIT). Please see License File for more information.