soumairi/domain-checker

domain-checker is a package to check domains for an extra security layer

v1.0.4 2022-04-14 16:33 UTC

This package is auto-updated.

Last update: 2024-04-24 16:06:50 UTC


README

A LARAVEL package to authorize allowed domains

Latest Version on Packagist Software License Total Downloads Build Status Scrutinizer Code Quality Code Intelligence Status

ABOUT

This package aims to add a security level to the application for checking the allowed domains of all the incoming HTTP requests of the application. This package makes it easy to add a level between the incoming HTTP requests and your application by using middleware.

Install

You can install the package via composer:

$ composer require soumairi/domain-checker

Next, the \Soumairi\DomainChecker\Http\Middleware\DomainCheckerMiddleware::class-middleware must be registered in the kernel:

//app/Http/Kernel.php

protected $middleware = [
  ...
  \Soumairi\DomainChecker\Http\Middleware\DomainCheckerMiddleware::class,
];

You can publish the config-file with:

php artisan vendor:publish --provider="Soumairi\DomainChecker\DomainCheckerServiceProvider"

This is the contents of the published config file:

return [
    /**
     * Allowed domains of all the incoming HTTP requests to the application to make a call to our application.
     */
    'allowed_domains' => [
        'localhost',
        '127.0.0.1',
    ],

    /**
     * Custom Error Message
     */
    'error_message' => 'This host is not allowed'
];

Usage

To authorize a domain, it must be added in the allowed_domains array :

//config/domain-checker.php
'allowed_domains' => [
        'localhost',
        '127.0.0.1',
        '...'
    ],

by default localhost and 127.0.0.1 are allowed.

you can customize error message on the error_message.

Credits

License

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