Developed with love by KnpLabs Hire us for your project!
52

EoHoneypotBundle

by eymengunay

Honeypot type for Symfony forms

EoHoneypotBundle

Build Status
Scrutinizer Code Quality
Code Coverage
Latest Stable Version
Total Downloads

Honeypot for Symfony2 forms.

What is Honey pot?

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.

Prerequisites

This version of the bundle requires Symfony 2.1+

Installation

Step 1: Download EoHoneypotBundle using Composer

Add EoHoneypotBundle to your project by running the command:
bash
$ composer require eo/honeypot-bundle

Composer will install the bundle to your project's vendor/eo directory.

Step 2: Enable the bundle

If you use Symfony Flex - skip this step. Otherwise, enable the bundle in bundles.php:
```php
<?php
// config/bundles.php

<?php
return [
// ...
Eo\HoneypotBundle\EoHoneypotBundle::class => ['all' => true],
];
```

Step 3 (optional): Configure bundle to use database

To save honeypot catched requests into database you have to enable it in your configuration file:
All parameters are optional

# config/packages/eo_honeypot.yaml
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;
    }
}

Usage

Once installed and configured you can start using Eo\HoneypotBundle\Form\Type\HoneypotType
form type in your forms.

Basic usage example:

<?php

namespace Acme\DemoBundle\Form\Type;

use Eo\HoneypotBundle\Form\Type\HoneypotType;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\EmailType;
use Symfony\Component\Form\Extension\Core\Type\TextType;
use Symfony\Component\Form\FormBuilderInterface;

class FooType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        $builder->add('name', TextType);
        $builder->add('email', EmailType);

        // Honeypot field
        $builder->add('SOME-FAKE-NAME', HoneypotType::class);
    }
}

Events

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.

License

This bundle is under the MIT license. See the complete license in the bundle:

Resources/meta/LICENSE

Reporting an issue or a feature request

Issues and feature requests related to this bundle are tracked in the Github issue tracker https://github.com/eymengunay/EoHoneypotBundle/issues.

Copyright (c) Eymen Gunay <eymen@egunay.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
eo_honeypot:
redirect:
enabled: false
url: ~
route: ~
route_parameters:

# Prototype
name: []
storage:
database:
enabled: false
class: ApplicationEoHoneypotBundle:HoneypotPrey
driver: mongodb
file:
enabled: false
output: /var/log/honeypot.log
  • Merge pull request #28 from tominventisbe/feature/allow-disabling-form-error-when-filled-in
    By web-flow, 1 year ago
  • Allow disabling form error if honeypot is filled in
    By , 1 year ago
  • Merge pull request #27 from AkenRoberts/fix/tree-root-node
    By web-flow, 1 year ago
  • Fix TreeBuilder root node deprecation in 4.1+
    By , 1 year ago
  • Merge pull request #26 from polarbirke/master
    By web-flow, 1 year ago
  • Hide the HoneypotField from assistive technology (AT)
    By , 1 year ago
  • Merge pull request #25 from Aricura/master
    By web-flow, 1 year ago
  • #24 - Fix template reference
    By Stefan Herndler, 1 year ago
  • [minor] unsupported php versions removed from travis
    By eymengunay, 1 year ago
  • Merge pull request #23 from bocharsky-bw/patch-2
    By web-flow, 1 year ago
  • Merge branch 'master' into patch-2
    By web-flow, 1 year ago
  • Merge pull request #22 from bocharsky-bw/patch-1
    By web-flow, 1 year ago
  • Highlight syntax of code blocks in README
    By web-flow, 1 year ago
  • Update docs according to the latest Symfony version
    By web-flow, 1 year ago
  • Merge pull request #20 from ceesvanegmond/patch-1
    By web-flow, 1 year ago
  • Update composer.json
    By web-flow, 1 year ago
  • Merge pull request #19 from ceesvanegmond/patch-1
    By web-flow, 1 year ago
  • Symfony4 compatible
    By web-flow, 1 year ago
  • Merge pull request #18 from janopae/master
    By web-flow, 2 years ago
  • Fixed problem when using the web browser's autocomplete feature
    By janopae, 2 years ago
  • Merge pull request #14 from iisisrael/patch-13
    By eymengunay, 4 years ago
  • Upgraded to Symfony 3.
    By iisisrael, 4 years ago
  • Updated form type unit test to match dependency injection change.
    By iisisrael, 4 years ago
  • Fixed dependency injection of request to use the request stack service instead.
    By iisisrael, 4 years ago
  • Updated FormType for Symfony 3.
    By iisisrael, 4 years ago
  • Merge pull request #9 from stefantalen/master
    By eymengunay, 6 years ago
  • Setting position to fixed instead of absolute
    By stefantalen, 6 years ago
  • Allow to extends HoneypotPrey entity/document
    By emmanuelvella, 6 years ago
  • Fix HoneypotType test for php 5.3
    By emmanuelvella, 6 years ago
  • Add HoneypotType test
    By emmanuelvella, 6 years ago