Honeypot for Symfony2 forms.
A honey pot trap involves creating a form with an extra field that is hidden to human visitors but readable by robots. The robot fills out the invisible field and submits the form, leaving you to simply ignore their spammy submission or blacklist their IP. It’s a very simple concept that can be implemented in a few minutes and it just works – add them to your contact and submission forms to help reduce spam.
This version of the bundle requires Symfony 2.1+
Add EoHoneypotBundle in your composer.json:
{
"require": {
"eo/honeypot-bundle": "dev-master"
}
}
Now tell composer to download the bundle by running the command:
$ php composer.phar update eo/honeypot-bundle
Composer will install the bundle to your project's vendor/eo directory.
Enable the bundle in the kernel:
<?php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new Eo\HoneypotBundle\EoHoneypotBundle(),
);
}
To save honeypot catched requests into database you have to enable it in your configuration file: All parameters are optional
# app/config.yml
...
eo_honeypot:
storage:
database:
enabled: false
driver: mongodb # orm and mongodb are supported
class: ApplicationEoHoneypotBundle:HoneypotPrey
# You can also use file format to store honeypot preys.
# This may come handy if you need to parse logs with fail2ban
# file:
# enabled: false
# output: /var/log/honeypot.log
redirect:
enabled: true
url: "/"
# route: homepage
# route_parameters: ~
If you enable the database storage, you must create a class which extends
the Eo\HoneypotBundle\<Entity|Document>\HoneypotPrey base class :
<?php
namespace Application\Eo\HoneypotBundle\Entity;
use Doctrine\ORM\Mapping as ORM;
use Eo\HoneypotBundle\Entity\HoneypotPrey as BaseHoneypotPrey;
/**
* @ORM\Entity
*/
class HoneypotPrey extends BaseHoneypotPrey
{
/**
* @ORM\Id
* @ORM\Column(type="integer")
* @ORM\GeneratedValue(strategy="AUTO")
*/
protected $id;
public function getId()
{
return $this->id;
}
}
or
<?php
namespace Application\Eo\HoneypotBundle\Document;
use Doctrine\ODM\MongoDB\Mapping\Annotations as MongoDB;
use Eo\HoneypotBundle\Document\HoneypotPrey as BaseHoneypotPrey;
/**
* @MongoDB\Document
*/
class HoneypotPrey extends BaseHoneypotPrey
{
/**
* @MongoDB\Id
*/
protected $id;
public function getId()
{
return $this->id;
}
}
Once installed and configured you can start using honeypot type in your forms.
<?php
namespace Acme\DemoBundle\Form\Type;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
class FooType extends AbstractType
{
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder->add('name', 'text');
$builder->add('email', 'text');
// Honeypot field
$builder->add('SOME-FAKE-NAME', 'honeypot');
}
public function getName()
{
return 'foo';
}
}
If the hidden honeypot field has some data bundle will dispatch a bird.in.cage event. You can create an event listener to execute custom actions. See Eo\HoneypotBundle\Event\BirdInCage and How to Register Event Listeners and Subscribers for more information.
This bundle is under the MIT license. See the complete license in the bundle:
Resources/meta/LICENSE
Issues and feature requests related to this bundle are tracked in the Github issue tracker https://github.com/eymengunay/EoHoneypotBundle/issues.