Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Ali1/cakephp-bruteforce
A CakePHP plugin for dropping in Brute Force Protection to your controllers and methods.
https://github.com/Ali1/cakephp-bruteforce
Last synced: 2 months ago
JSON representation
A CakePHP plugin for dropping in Brute Force Protection to your controllers and methods.
- Host: GitHub
- URL: https://github.com/Ali1/cakephp-bruteforce
- Owner: Ali1
- License: mit
- Created: 2019-05-17T18:47:40.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-08T21:23:17.000Z (over 1 year ago)
- Last Synced: 2024-10-27T09:04:05.326Z (3 months ago)
- Language: PHP
- Size: 77.1 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cakephp - Bruteforce - Simple way to add Brute Force Protection to your installation without involving database. (Security)
README
# CakePHP Brute Force Plugin
[](http://cakephp.org)
[](/blob/master/LICENSE)
[](https://travis-ci.org/Ali1/cakephp-bruteforce)
[](https://coveralls.io/github/Ali1/cakephp-bruteforce?branch=master)
A CakePHP plugin for easy drop-in Brute Force Protection for your controller methods.
Component Wrapper for [Ali1/BruteForceShield](https://github.com/Ali1/BruteForceShield)
### Features
* IP address-based protection
* Uses the Cache class to store attempts so no database installation necessary
* Logs blocked attempts (uses CakePHP Logs)
* Does not count re-attempts with same challenge details (e.g. if a user tries the same username/password combination a few times)
* Can block multiple attempts at the same username earlier than the normal limit (to give users a chance to enter the correct username if they have been trying with the wrong one)
* Can be applied in AppController::initialize for simpler set up when authentication plugins are used
* Throws catchable exception which can optionally be caught
### Requirements
* Composer
* CakePHP 4.0+
* PHP 7.2+
### Installation
In your CakePHP root directory: run the following command:
```
composer require ali1/cakephp-bruteforce
```
Then in your Application.php in your project root, add the following snippet:
```php
// In project_root/Application.php:
$this->addPlugin('Bruteforce');
```
or you can use the following shell command to enable to plugin in your bootstrap.php automatically:
```
bin/cake plugin load Bruteforce
```
### Basic Use
Load the component:
````php
// in AppController.php or any controller
public function initialize(): void
{
parent::initialize();
$this->loadComponent('Bruteforce.Bruteforce');
}
````
Apply protection (`$this->Bruteforce->validate` must come before actually verifying or actioning the user submitted data)
````php
public function login(): void
{
$config = new \Ali1\BruteForceShield\Configuration(); // see possible options below
/**
* @param string $name a unique string to store the data under (different $name for different uses of Brute
* force protection within the same application.
* @param array $data an array of data, can use $this->request->getData()
* @param \Ali1\BruteForceShield\Configuration|null $config options
* @param string $cache Cache to use (default: 'default'). Make sure to use one with a duration longer than your time window otherwise you will not be protected.
* @return void
*/
$this->Bruteforce->validate(
'login',
['username' => $this->request->getData('username'), 'password' => $this->request->getData('password')],
$config,
'default'
);
// the user will never get here if fails Brute Force Protection
// a TooManyAttemptsException will be thrown
// usual login code here
}
````
### Configuration Options
The third argument for `validate` is the \Ali1\BruteForceShield\Configuration object.
Instructions on configuring Brute Force Protection can be found [here](https://github.com/Ali1/BruteForceShield#configuration).
### Usage
#### For a method for username / password BruteForce
```php
// UsersController.php
public $components = ['Bruteforce.Bruteforce'];
...
public function login()
{
// prior to actually verifying data
$bruteConfig = new \Ali1\BruteForceShield\Configuration();
$bruteConfig->setTotalAttemptsLimit(5);
$bruteConfig->setStricterLimitOnKey('username', 3); // setting a limit of 5 above, then a different limit here would mean the user has 3 chances to get the password right, but then an additional 2 chances if they try a different username
$bruteConfig->addUnencryptedKey('username'); // adding this would mean you could see which usernames are being attacked in your log files
$this->Bruteforce->validate(
'login', // unique name for this BruteForce action
['username' => $this->request->getData('username'), 'password' => $this->request->getData('password')],
$bruteConfig
);
// rest of the login code to authorize the attempt
}
```
#### Prevent URL based brute force
Non-form data can also be Brute Forced
````php
/**
* @param string|null $hashedid
*
* @return void
*/
public function publicAuthUrl(string $hashedid): void
{
try {
$bruteConfig = new Configuration();
$bruteConfig->addUnencryptedKey('hashedid');
$this->Bruteforce->validate(
'publicHash',
['hashedid' => $hashedid],
$bruteConfig
);
} catch (\Bruteforce\Exception\TooManyAttemptsException $e) {
$this->Flash->error('Too many requests attempted. Please try again in a few minutes');
return $this->redirect('/');
}
// then check if URL is actually valid
````
#### With user plugins (e.g. CakeDC/Users)
Although not ideal, when using plugins that you do not wish to extend or modify, you can safely place the `validate` method in AppController.php `initialize` method, since this will run prior to user verification within the plugin.
```php
// AppController.php::initialize()
$this->loadComponent('Bruteforce.Bruteforce'); // Keep above any authentication components if running on initialize (default)
$this->Bruteforce->validate(
'login', // unique name for this BruteForce action
['username' => $this->request->getData('username'), 'password' => $this->request->getData('password')] // user entered data
);
// this will not affect any other action except ones containing POSTed usernames and passwords (empty challenges never get counted or blocked)
```