https://github.com/secondtruth/gatekeeper

🛡️ Protect websites from spam and other attacks
https://github.com/secondtruth/gatekeeper

access-control composer firewall php protect-websites protection spam-prevention web

Last synced: about 6 hours ago
JSON representation

🛡️ Protect websites from spam and other attacks

• Host: GitHub
• URL: https://github.com/secondtruth/gatekeeper
• Owner: secondtruth
• License: mit
• Created: 2015-04-12T15:48:29.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-05-18T00:46:02.000Z (9 months ago)
• Last Synced: 2025-01-26T12:35:54.566Z (5 days ago)
• Topics: access-control, composer, firewall, php, protect-websites, protection, spam-prevention, web
• Language: PHP
• Homepage:
• Size: 271 KB
• Stars: 19
• Watchers: 9
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Gatekeeper

[![Build Status](https://img.shields.io/github/actions/workflow/status/secondtruth/gatekeeper/tests.yml.svg)](https://github.com/secondtruth/gatekeeper/actions/workflows/tests.yml)

[![Quality](https://img.shields.io/codeclimate/maintainability/secondtruth/gatekeeper.svg)](https://codeclimate.com/github/secondtruth/gatekeeper)

[![Coverage](https://img.shields.io/codecov/c/gh/secondtruth/gatekeeper.svg?token=pmX6z4UHDJ)](https://codecov.io/gh/secondtruth/gatekeeper)

[![License](https://img.shields.io/github/license/secondtruth/gatekeeper.svg?color=blue)](https://packagist.org/packages/secondtruth/gatekeeper)

The Gatekeeper library protects websites from spam and other attacks. It prevents bad bots from delivering their junk, and in many cases,

from ever reading your site in the first place.

## Description

Welcome to a whole new way of keeping your service, forum, wiki or content management system free of spam and other attacks.

Gatekeeper is a PHP-based solution for blocking spam and the robots which deliver it. This keeps your site's load down,

makes your site logs cleaner, and can help prevent denial of service conditions caused by spammers.

Gatekeeper also transcends other anti-spam solutions by working in a completely different, unique way. Instead of merely

looking at the content of potential spam, Gatekeeper analyzes the delivery method as well as the software the spammer

is using. In this way, Gatekeeper can stop spam attacks even when nobody has ever seen the particular spam before.

Gatekeeper is designed to work alongside existing spam prevention services to increase their effectiveness and efficiency.

Whenever possible, you should run it in combination with a more traditional spam prevention service.

The library is inspired by the **Bad Behavior** anti-spam system by **Michael Hampton**.

## Usage

Include the vendor autoloader and use the classes:

```php

namespace Acme\MyApplication;

use Secondtruth\Gatekeeper\Screener;

use Secondtruth\Gatekeeper\Gatekeeper;

use Secondtruth\Gatekeeper\ACL\IPAddressACL;

use Secondtruth\Gatekeeper\Check\UrlCheck;

use Secondtruth\Gatekeeper\Listing\IPList;

use Laminas\Diactoros\ServerRequestFactory; // or any other PSR-7 ServerRequest factory

require 'vendor/autoload.php';

```

Create a `Screener` object and add the `Check` object(s) you want to use:

```php

$screener = new Screener();

$check = new UrlCheck();

$screener->addCheck($check);

```

Create a `Gatekeeper` object and run it using the screener:

```php

$request = ServerRequestFactory::fromGlobals(); // or a PSR-7 ServerRequest object you already have

$gatekeeper = new Gatekeeper();

$allowed = new IPList('127.0.0.1');

$denied = new IPList(['127.0.0.2', '127.0.0.3/32']);

$gatekeeper->addACL(new IPAddressACL($allowed, $denied));

$gatekeeper->run($request, $screener);

```

## Installation

### Install via Composer

[Install Composer](https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx) if you don't already have it present on your system.

To install the library, run the following command and you will get the latest development version:

```bash

composer require secondtruth/gatekeeper:dev-master

```

## Requirements

- You must have at least PHP version 8.1 installed on your system.

## Author, Credits and License

This project was created by [Christian Neff](https://www.secondtruth.de) ([@secondtruth](https://github.com/secondtruth))

and is licensed under the [MIT License](LICENSE.md).

Based on the work of:

* Michael Hampton

Thanks to [all other contributors](https://github.com/secondtruth/wumbo/graphs/contributors)!