nojimage/cakephp-login-attempts

LoginAttempts plugin for CakePHP

v3.0.2 2024-03-01 14:44 UTC

Requires

• php: ^8.1
• cakephp/authentication: ^3.0
• cakephp/cakephp: ^5.0

Requires (Dev)

• cakephp/cakephp-codesniffer: ^5.1
• cakephp/migrations: ^4.0
• phpunit/phpunit: ^10.1

Suggests

• cakephp/authentication: To use FormAuthenticator.

MIT

README

Requirements

• CakePHP >= 5.0
• CakePHP Authentication plugin

Installation

You can install this plugin into your CakePHP application using composer.

The recommended way to install composer packages is:

composer require nojimage/cakephp-login-attempts"^3.0

Load plugin

Load the plugin by adding the following statement in your project's src/Application.php:

$this->addPlugin('LoginAttempts');

Create table

run migration command:

bin/cake migrations migrate -p LoginAttempts

Usage

Use LoginAttempts.Form authenticator instead of Form.

If use are using Authentication plugin:

        $service->loadAuthenticator('LoginAttempts.Form', [
            'fields' => ['username' => 'email'],
            'attemptLimit' => 5,
            'attemptDuration' => '+5 minutes',
        ]);

LoginAttempts.Form Options

attemptLimit

If the num of login failures of the user exceeds attemptLimit during attemptDuration, the user's login is not permitted.

default: 5

attemptDuration

If the num of login failures of the user exceeds attemptLimit during attemptDuration, the user's login is not permitted.

default: '+5 minutes'

attemptAction

The number of attempts is stored separately for this key. Use when there are multiple login forms and you want to set restrictions separately.

default: 'login'

attemptsStorageModel

A model used for logging a failure login and check count of failure login.

default: 'LoginAttempts.Attempts'