https://github.com/devlop/speedtrap
Simple speedtrap honeypot made for Laravel FormRequest
https://github.com/devlop/speedtrap
laravel spam-detection validation
Last synced: 13 days ago
JSON representation
Simple speedtrap honeypot made for Laravel FormRequest
- Host: GitHub
- URL: https://github.com/devlop/speedtrap
- Owner: devlop
- License: mit
- Created: 2021-02-16T20:10:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-05T08:39:24.000Z (about 5 years ago)
- Last Synced: 2024-12-11T19:48:02.412Z (over 1 year ago)
- Topics: laravel, spam-detection, validation
- Language: PHP
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Speedtrap
Simple speedtrap honeypot made for Laravel FormRequest that detects spam bots by measuring the time it took to submit the form.
# Installation
```
composer require devlop/speedtrap
```
If you wish to change any of the speedtrap configuration options (such as the default threshold of 5 seconds or component name) you can publish the config, but this is usually not needed.
```
php artisan vendor:publish --provider="Devlop\Speedtrap\SpeedtrapServiceProvider"
```
# Usage
First, add the `WithSpeedtrap` trait to your FormRequest.
```php
namespace App\Http\Requests;
use Devlop\Speedtrap\WithSpeedtrap;
use Illuminate\Foundation\Http\FormRequest;
class DemoRequest extends FormRequest
{
use WithSpeedtrap;
```
Next you need to add the speedtrap to your form.
```html
... all your other form contents
```
Optionally you can add a message to show when the speedtrap was triggered, this only works when using automatic validation.
```html
Slow down there muchacho!
... all your other form contents
```
Lastly, you need to configure the validation, it can either be automatic or manual.
## Automatic validation
Add the speedtrap rules to your rules configuration, this will make it redirect back to the form when triggered, as any other form validation error.
```php
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules() : array
{
return $this->withSpeedtrapRules([
// your normal rules goes here
]);
}
```
Optionally you can also register the rules like this
```php
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules() : array
{
return [
// your normal rules goes here,
$this->getSpeedtrapInputName() => $this->speedtrapRules(),
];
}
```
## Manual validation
If you are doing the validation manually you have more control of how you handle spammers,
maybe you want to silently ignore it and give the spammer the impression of success? it's all up to you.
```php
namespace App\Http\Controllers;
use App\Requests\DemoRequest;
use Illuminate\Http\Request;
class DemoController
{
public function store(DemoRequest $request)
{
// get the speedtrap
$speedtrap = $request->speedtrap();
if ($speedtrap->triggered()) {
// do something when the speedtrap was triggered
}
}
}
```