https://github.com/davidepastore/slim-restrict-route
A Slim middleware to restrict ip addresses that will access to your routes
https://github.com/davidepastore/slim-restrict-route
ip middleware php restricted slim-framework
Last synced: 5 months ago
JSON representation
A Slim middleware to restrict ip addresses that will access to your routes
- Host: GitHub
- URL: https://github.com/davidepastore/slim-restrict-route
- Owner: DavidePastore
- Created: 2016-04-25T19:44:51.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-05-25T22:42:31.000Z (about 6 years ago)
- Last Synced: 2024-10-19T21:43:52.611Z (over 1 year ago)
- Topics: ip, middleware, php, restricted, slim-framework
- Language: PHP
- Size: 25.4 KB
- Stars: 22
- Watchers: 4
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Slim Framework Restrict Route
[![Latest version][ico-version]][link-packagist]
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]
[![PSR2 Conformance][ico-styleci]][link-styleci]
A slim middleware to restrict ip addresses that will access to your routes. It internally uses `Ip` Validator of [Respect/Validation][respect-validation] and [rka-ip-address-middleware][rka-ip-address-middleware].
## Install
Via Composer
``` bash
$ composer require davidepastore/slim-restrict-route
```
Requires Slim 3.0.0 or newer.
## Usage
You have to register also the [`RKA\Middleware\IpAddress`][rka-ip-address-middleware] middleware to correctly read the ip address.
In most cases you want to register `DavidePastore\Slim\RestrictRoute` for a single route, however,
as it is middleware, you can also register it for all routes.
### Register per route
```php
$app = new \Slim\App();
$app->add(new RKA\Middleware\IpAddress());
$options = array(
'ip' => '192.*.*.*'
);
$app->get('/api/myEndPoint',function ($req, $res, $args) {
//Your amazing route code
})->add(new \DavidePastore\Slim\RestrictRoute\RestrictRoute($options));
$app->run();
```
### Register for all routes
```php
$app = new \Slim\App();
$app->add(new RKA\Middleware\IpAddress());
$options = array(
'ip' => '192.*.*.*'
);
// Register middleware for all routes
// If you are implementing per-route checks you must not add this
$app->add(new \DavidePastore\Slim\RestrictRoute\RestrictRoute($options));
$app->get('/foo', function ($req, $res, $args) {
//Your amazing route code
});
$app->post('/bar', function ($req, $res, $args) {
//Your amazing route code
});
$app->run();
```
## Ip address
You can restrict route using a different value of `ip` in the `options` given to `\RestrictRoute`:
* any of the filters provided by PHP regarding `FILTER_VALIDATE_IP` (e.g.: `FILTER_FLAG_NO_PRIV_RANGE`);
* asterisk (`*`) to filter ip that are in the given subnet (e.g.: `192.*`);
* ranges (`-`) to filter ip that are in the given range (e.g.: `192.168.0.0-192.168.255.255`);
* single ip (e.g.: `192.168.0.1-192.168.0.1`);
* array of ranges to filter ip (e.g.: `array('192.0.0.0-192.255.255.255', '178.0.0.*')`).
You can find more syntax information on the `Ip` validator [documentation](https://github.com/Respect/Validation/blob/master/docs/Ip.md) and in its [Unit Test class](https://github.com/Respect/Validation/blob/master/tests/unit/Rules/IpTest.php).
## Testing
``` bash
$ phpunit
```
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
## Credits
- [Davide Pastore](https://github.com/davidepastore)
[respect-validation]: https://github.com/Respect/Validation/
[rka-ip-address-middleware]: https://github.com/akrabat/rka-ip-address-middleware
[ico-version]: https://img.shields.io/packagist/v/DavidePastore/Slim-Restrict-Route.svg?style=flat-square
[ico-travis]: https://travis-ci.org/DavidePastore/Slim-Restrict-Route.svg?branch=master
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/DavidePastore/Slim-Restrict-Route.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/davidepastore/Slim-Restrict-Route.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/davidepastore/slim-restrict-route.svg?style=flat-square
[ico-styleci]: https://styleci.io/repos/57071167/shield
[link-packagist]: https://packagist.org/packages/davidepastore/slim-restrict-route
[link-travis]: https://travis-ci.org/DavidePastore/Slim-Restrict-Route
[link-scrutinizer]: https://scrutinizer-ci.com/g/DavidePastore/Slim-Restrict-Route/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/DavidePastore/Slim-Restrict-Route
[link-downloads]: https://packagist.org/packages/davidepastore/slim-restrict-route
[link-styleci]: https://styleci.io/repos/57071167/