https://github.com/gabrieljmj/httprefererfilter

Filter to allow or block HTTP referers
https://github.com/gabrieljmj/httprefererfilter

Last synced: about 2 months ago
JSON representation

Filter to allow or block HTTP referers

• Host: GitHub
• URL: https://github.com/gabrieljmj/httprefererfilter
• Owner: gabrieljmj
• Created: 2014-11-06T17:55:48.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-11-07T22:40:35.000Z (about 10 years ago)
• Last Synced: 2024-05-07T06:02:16.397Z (8 months ago)
• Language: PHP
• Size: 156 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Gabrieljmj\HttpRefererFilter

============================

[![Total Downloads](https://poser.pugx.org/gabrieljmj/httprefererfilter/downloads.png)](https://packagist.org/packages/gabrieljmj/httprefererfilter) [![Latest Unstable Version](https://poser.pugx.org/gabrieljmj/httprefererfilter/v/unstable.png)](https://packagist.org/packages/gabrieljmj/httprefererfilter) [![License](https://poser.pugx.org/gabrieljmj/httprefererfilter/license.png)](https://packagist.org/packages/gabrieljmj/httprefererfilter) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/GabrielJMJ/HttpRefererFilter/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/GabrielJMJ/HttpRefererFilter/?branch=master)

Filter to allow or block HTTP referers.

##Download

Via [Composer](http://getcomposer.org):

```json

{

    "require": {

        "gabrieljmj/httprefererfilter": "dev-master"

    }

}

```

##Blocker actions

Blocker actions are actions to be executed when a referer not allowed try a request.

* ```\Gabrieljmj\HttpRefererFilter\BlockerAction\RedirectWithHttpLocationHeader```: Redirects to some address. Pass on constructor an instance of ```\Symfony\Component\HttpFoundation\RedirectResponse```.

* ```\Gabrieljmj\HttpRefererFilter\BlockerAction\PageContent```: Add on the page a content. Pass on constructor the content (string) and an instance of ```\Symfony\Component\HttpFoundation\Response```.

##Blocking

You can block specifc HTTP referers.

####Example

```php

use Gabrieljmj\HttpRefererFilter\HttpRefererBlocker;

use Gabrieljmj\HttpRefererFilter\BlockerAction\RedirectWithHttpLocationHeader;

use Symfony\Component\HttpFoundation\RedirectResponse;

use Symfony\Component\HttpFoundation\Request;

$action = new RedirectWithHttpLocationHeader(new RedirectResponse('http://mydomain.com/invalid-referer');

$blocker = new HttpRefererBlocker();

$blocker->add('http://example.com', $action)

        ->add('http://example2.com', $action);

$request = new Request($_GET, $_POST, [], $_COOKIE, $_FILES, ['HTTP_REFERER' => 'http://example_valid.com']);

var_dump($blocker->validate($request)); //bool(true)

```

If the domain (referer) **is** in the list, redirects to ```http://mydomain.com/invalid-referer```.

##Allowing

With it, allow the request just for specifc domains.

####Example

```php

use Gabrieljmj\HttpRefererFilter\HttpRefererAllower;

use Gabrieljmj\HttpRefererFilter\BlockerAction\RedirectWithHttpLocationHeader;

use Symfony\Component\HttpFoundation\RedirectResponse;

use Symfony\Component\HttpFoundation\Request;

$action = new RedirectWithHttpLocationHeader(new RedirectResponse('http://mydomain.com/invalid-referer');

$blocker = new HttpRefererAllower($action);

$blocker->add('http://example.com')

        ->add('http://example2.com');

$request = new Request($_GET, $_POST, [], $_COOKIE, $_FILES, ['HTTP_REFERER' => 'http://example1.com']);

var_dump($blocker->validate($request)); //bool(true)

```

If the domain (referer) **is not** in the list, redirects to ```http://mydomain.com/invalid-referer```.