https://github.com/audunru/dynamic-cors

Dynamic CORS settings in Laravel
https://github.com/audunru/dynamic-cors

Last synced: 2 months ago
JSON representation

Dynamic CORS settings in Laravel

• Host: GitHub
• URL: https://github.com/audunru/dynamic-cors
• Owner: audunru
• License: mit
• Created: 2024-05-20T16:49:35.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-08-25T08:17:20.000Z (4 months ago)
• Last Synced: 2024-09-26T16:16:05.204Z (3 months ago)
• Language: PHP
• Size: 104 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dynamic CORS options in Laravel

[![Build Status](https://github.com/audunru/dynamic-cors/actions/workflows/validate.yml/badge.svg)](https://github.com/audunru/dynamic-cors/actions/workflows/validate.yml)

[![Coverage Status](https://coveralls.io/repos/github/audunru/dynamic-cors/badge.svg?branch=main)](https://coveralls.io/github/audunru/dynamic-cors?branch=main)

[![StyleCI](https://github.styleci.io/repos/803402577/shield?branch=main)](https://github.styleci.io/repos/803402577)

Typically used to configure custom allowed origins per user/account, so that your users can access your HTTP API from different domains without getting CORS errors.

Under the hood, this middleware dynamically sets Laravel's default CORS configuration options. Basically, it's a wrapper for calls like...

```php

config("cors.allowed_origins", ["https://www.example.com"]);

```

... where the list of of allowed origins would dynamically change, for example come from the user's account settings.

# Installation

```bash

composer require audunru/dynamic-cors

```

You will have to replace Laravel's default `HandleCors` middleware with a version that extends `audunru\DynamicCors\Middleware\HandleCors`.

1. Ensure that you are [manually managing Laravel's default global middleware](https://laravel.com/docs/11.x/middleware#manually-managing-laravels-default-global-middleware).

2. Remove `\Illuminate\Http\Middleware\HandleCors::class` from the middleware stack.

3. Create a new file `app/Http/Middleware/UserCors.php`.

You can place this wherever you want, and of course name it according to what it does in your application.

This is an example where a user has a list of per-user allowed origins, perhaps controlled by themselves in the application UI.

```php

namespace App\Http\Middleware;

use Closure;

use audunru\DynamicCors\Middleware\HandleCors;

class UserCors extends HandleCors

{

    public function handle($request, Closure $next)

    {

        $user = Auth::user();

        $this->allowedOrigins = array_merge(

            [config('app.url')],

            $user->allowedOrigins // Note: allowedOrigins does not exist by default, it's something you would have to create. Or make something completely different

        );

        return parent::handle($request, $next);

    }

}

```

`audunru\DynamicCors\Middleware\HandleCors` has protected properties for `allowedOrigins` and all the other CORS service settings. Any properties that you set in your middleware will be used by the CORS service. Properties that you don't set will use the value set in `cors.php`.

4. Add `\App\Http\Middleware\HandleCors::class` to the middleware stack.

# Development

## Testing

Run tests:

```bash

composer test

```