The laravel-route-blocker's intro from bogvsdev

laravel-route-blocker's Introduction

#Laravel Route Blocker

Block routes by IP

Requirements

Laravel 5.1. 5.2, 5.3, 5.4, 5.5

Installation

Require this package in your composer.json and run composer update.

    "skydiver/laravel-route-blocker": "dev-master"

After updating composer, add ServiceProvider to the providers array in config/app.php

    Skydiver\LaravelRouteBlocker\LaravelRouteBlockerServiceProvider::class,

Then publish the config file:

    $ php artisan vendor:publish --tag=LaravelRouteBlocker

Usage

Add middleware to app/Http/Kernel.php on $routeMiddleware array:

    'whitelist' => \Skydiver\LaravelRouteBlocker\Middleware\WhitelistMiddleware::class,

Create a config group on config/laravel-route-blocker.php and insert your allowed IPs:

'whitelist' => [
    'my_group' => [
        '127.0.0.1',
        '192.168.17.0',
        '10.0.1.*'
    ],
    'another_group' => [
        '8.8.8.*'
    ],
],

You can configure to throw an HTTP status code or redirect to a custom URL:

'redirect_to'      => '',   # URL TO REDIRECT IF BLOCKED (LEAVE BLANK TO THROW STATUS)
'response_status'  => 403,  # STATUS CODE (403, 404 ...)
'response_message' => ''    # MESSAGE (COMBINED WITH STATUS CODE)

Put your protected routes inside a group and specify the whitelist parameter:

    Route::group(['middleware' => 'whitelist:my_group'], function() {

        Route::get('/demo', function () {
            return "DEMO";
        });

    });

Artisan Commands

To get a list of current IPs groups run:

    $ php artisan route:blocks:groups

    +---------+--------------+
    | Group   | IP           |
    +---------+--------------+
    | group1  | 127.0.0.1    |
    | group1  | 127.0.0.2    |
    | group1  | 192.168.17.0 |
    | group1  | 10.0.0.*     |
    | group2  | 8.8.8.8      |
    | group2  | 8.8.8.*      |
    | group2  | 8.8.4.4      |
    +---------+--------------+