byteflick/laravel-strict-domain

Domain Checker Package for Laravel that ensures seamless redirection to a specified domain, optimizing security and user experience within Laravel applications.

v3.0.1 2024-03-18 18:36 UTC

Requires

• php: ^8.1
• illuminate/contracts: ^10.0
• spatie/laravel-package-tools: ^1.16

Requires (Dev)

• larastan/larastan: ^2.9
• laravel/pint: ^1.14
• nunomaduro/collision: ^7.8
• orchestra/testbench: ^8.22
• phpstan/extension-installer: ^1.3
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3

MIT

• ByteFlick

• laravel
• ByteFlick
• laravel-strict-domain

README

Strict Domain Checking for Laravel

Strict Domain Checking for Laravel is a lightweight package designed to seamlessly integrate with Laravel applications, providing a simple solution for domain-based redirection. With this package, you can ensure that incoming traffic to your Laravel application is redirected to a specified domain if the requesting domain doesn't match the configured domain. By implementing a customizable middleware, developers can easily enforce domain consistency, enhancing security and user experience. Whether managing multiple domains or enforcing branding standards, this package offers a flexible and efficient solution for domain redirection within Laravel applications.

Installation

You can install the package via composer:

composer require byteflick/laravel-strict-domain

You can publish the config file with (Optional):

php artisan vendor:publish --provider="ByteFlick\LaravelStrictDomain\LaravelStrictDomainServiceProvider"

This is the contents of the published config file:

return [
    'include_sub_domains' => true,
    'domain' => env('APP_DOMAIN', 'localhost.com'),
];

Usage

Step 1: Configure the Environment

You need to add an environment variable called APP_DOMAIN to your .env file. The value of this variable is used for validating the incoming traffic.

APP_DOMAIN=localhost.com

Step 2: Apply the Middleware

2.1 Redirecting External Traffic

If you want to redirect incoming traffic to your application from other domain/hosts to your own then you can use RedirectExternalTraffic middleware. This is useful when you want to redirect all the traffic from johndoe.com ( referrer domain) and other domains/hosts to janedoe.com (your designated domain).

On Specific Routes Only

You can add the middleware to individual routes or apply it via a route group.

Globally For Laravel 11

Append the middleware to your default middlewares into your bootstrap/app.php via the code below to redirect all external traffic outside your designated host to your designated host.

->withMiddleware(function (Middleware $middleware) {
     $middleware->append(\ByteFlick\LaravelStrictDomain\Middlewares\RedirectExternalTraffic::class);
})

Globally For Laravel 10

Add the middleware to your default middlewares into your App\Http\Kernel.php via the code below to redirect all external traffic outside your designated host to your designated host.

protected $middleware = [
    \ByteFlick\LaravelStrictDomain\Middlewares\RedirectExternalTraffic::class,
];

2.2 Blocking External Traffic

If you want to block incoming traffic to your application from other domain/hosts to your own then you can use BlockExternalTraffic middleware. This is useful when you want to allow traffic from janedoe.com but block johndoe.com and others to your application.

On Specific Routes Only

You can add the middleware to individual routes or apply it via a route group.

Globally For Laravel 11

Append the middleware to your default middlewares into your bootstrap/app.php via the code below to block all external traffic outside your designated host.

->withMiddleware(function (Middleware $middleware) {
     $middleware->append(\ByteFlick\LaravelStrictDomain\Middlewares\BlockExternalTraffic::class);
})

Globally For Laravel 10

Add the middleware to your default middlewares into your App\Http\Kernel.php via the code below to block all external traffic outside your designated host.

protected $middleware = [
    \ByteFlick\LaravelStrictDomain\Middlewares\BlockExternalTraffic::class,
];

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• ByteFlick
• ORPtech
• All Contributors

License

The MIT License (MIT). Please see License File for more information.