README

CakePHP 4+ Plugin for Protection Against BruteForce Attacks

CakePHP rBruteForce Plugin

With rBruteForce you could protect your CakePHP applications from Brute Force attacks.

Requirements

CakePHP 4.8 or greater.
PHP 7.2 or greater.

Installation

1. Create the database tables.

The schema could be found in config/Schema/rBruteForce.sql.

CREATE TABLE IF NOT EXISTS `rbruteforcelogs` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `data` text,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB  DEFAULT CHARSET=utf8;

CREATE TABLE IF NOT EXISTS `rbruteforces` (
  `ip` varchar(255) NOT NULL,
  `url` varchar(255) NOT NULL,
  `expire` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
  PRIMARY KEY (`expire`),
  KEY `ip` (`ip`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

The migrations files could be found in config/Migrations.

//CreateRBruteForces Migration
public function change()
{
	$table = $this->table('rbruteforces', ['id' => false, 'primary_key' => ['expire']]);
	$table
		->addColumn('ip', 'string', ['length' => 255])
		->addColumn('url', 'string', ['length' => 255])
		->addColumn('expire', 'timestamp', ['default' => null])
		->addIndex('ip');
	$table->create();
}
  
//CreateRBruteForceLogs Migration
public function change()
{
	$table = $this->table('rbruteforcelogs');
	$table->addColumn('data', 'text', ['null' => true]);
	$table->create();
	$table->changeColumn('id', 'integer', ['signed' => false, 'identity' => true]);
	$table->update();
}

Install via composer.

Add the plugin to your project's composer.json - something like this:

{
  "require": {
    "egcservices/rbruteforce2": "3.0"
  }
}

Load the plugin

Plugin::load('RBruteForce', ['bootstrap' => false, 'routes' => true]);

.gitignore

Because this plugin has the type cakephp-plugin set in it's own composer.json, composer knows to install it inside your /Plugin directory, rather than in the usual vendors file. It is recommended that you add /Plugin/RBruteForce to your .gitignore file.

Reporting Issues

If you have a problem with rBruteForce please report here

Documentation

rBruteForce bans IP-s on unsuccessful login, or on any other method.

Usage

As this plugin is a component you should add it to your Controller's $components array.

class UsersController extends AppController {
	
	public $components = ['RBruteForce.RBruteForce'];

Let's see an example for the UsersController login method with rBruteForce

public $_options;
public $_ipsAllowed;

public function initialize()
{
	parent::initialize(); // TODO: Change the autogenerated stub
	$this->_options = [
		'maxAttempts'     => 4,                        //max failed attempts before banning
		'expire'          => "10 minutes",             //expiration time
		'dataLog'         => true,                     //log the user submitted data
		'urlToRedirect'   => '/users/reportBruteForce' //url to redirect if failed.
	];
	$this->_ipsAllowed = ['127.0.0.1', '172.68.26.185', '191.179.112.160'];
}

public function login() 
{	
	if ($this->request->is('post')) {
		$myIp = $_SERVER['REMOTE_ADDR'];
		if (!$this->RBruteForce->isIpBanned($this->_options) || in_array($myIp, $this->_ipsAllowed)) {
			$user = $this->Auth->identify();
			if ($user) {
				$this->Auth->setUser($user);
				return $this->redirect($this->Auth->redirectUrl());
			}
			$this->RBruteForce->check($this->_options); //unsuccessful logins will be checked
			$this->Flash->error(__('Invalid username or password, try again'));
		} else {
			$this->Flash->error(__("Please, wait {$this->_options['expire']} to try login again!'));	
		}
	} else {
		if ($this->RBruteForce->isIpBanned($this->_options)) {
			$this->Flash->error(__("Please, wait {$this->_options['expire']} to try login again!'));
		}
	}
}

That is all! :)

Options

You could use options to alter the default behaviour.

$options = [
	'maxAttempts' => 4,			 //max failed attempts before banning
	'expire' => '3 minutes',	 //expiration time
	'dataLog' => false,			 //log the user submitted data
	'attemptLog' => 'beforeBan', //all|beforeBan
	'checkUrl' => true,			 //check url or not
	'cleanupAttempts' => 1000,	 //delete all old entries from attempts database if there are more rows that this
	'urlToRedirect'     => '/r_brute_force/Rbruteforces/failed' //url to redirect if failed.
	];
$this->RBruteForce->check($options);

You do not have to include options where default value is good for you. For example.

$this->RBruteForce->check(
		[
		'maxAttempts' => 3,
		'attemptLog' => 'all'
		]
	);

maxAttempts

Users will banned after this many unsuccessful attempts. Normally 3-5 should be enough.

expire

The ban will exists for this time. This should be something like:

20 seconds
5 minutes
1 hour
2 days
3 weeks
1 month

dataLog

If this option is set to true the user submitted data will be saved to the plugin's database. You could analize this data any time you want.

attemptLog

There are two valid values; all and beforeBan

If you choose all than all attempts will be logged into the plugins database. If you choose beforeBan only attempts before banning will be logged.

checkUrl

Shoud the plugin include the url into the brute force check or not.

If set to false and somebody try to login at /users/login and than at /admin/users/login the plugin will count as they would be the same url. If set to true the plugin will se thw two above as different attempts.

cleanupAttempts

When you suffer a brute force attack you could have thousands of log entries in the database in a few minutes. If you want to limit how much data should be stored you could use this option. Normally you should not worry about this till you have less than a million record.

How does it work?

When a user (or an automated attack) send some data to login (or any other) function CakePHP will call your controller's corresponding method. In this method you should have

$this->RBruteForce->check();

This method calls the plugin and it will log every attempts. It checks the plugin database for the clients IP address. If there are more entries there within the given expiration the plugin bans the request, logs the attempt and redirect the user to the failed login page. Automated attacks will see this as a successful login.

On every failed attempt the plugin delays the rendering of the page with an extra 1 second. So after 3 attempts the rendering will be delayed with 3 seconds. This slows down automated attacks, and just a little inconvinience for real users.

If an IP address is banned and you check before user authentication the plugin will not let the user get in even with valid username and password.

To remove the ban before expire you should browse to /r_brute_force/rbruteforces and delete the ban manually. Alternatively you just wait till the ban expires.

Submitted data entries available at /r_brute_force/rbruteforcelogs.

Warning

This is not a firewall! If you use this plugin you are still open to brute force attacks. Slow attacks involving proxies are really hard to detect. If you want protection agains them you should write your own protection methods, like limiting user accounts after a few attempts, or asking for extra login data like security question, or whitelist IP-s from where admins could log in, or other ideas. In the same time you could ban top attempt sources on your server firewall. This information is available at /r_brute_force/rbruteforces. Be careful to not to ban out proxies used by legitim users.

egcservices / rbruteforce2

Maintainers

Details