https://github.com/node-link/cakephp-remember-me

CakePHP plugin that performs Remember-me authentication with the new cookie algorithm of version 3.5 or later.
https://github.com/node-link/cakephp-remember-me

cakephp cakephp-plugin cookie remember-me security

Last synced: about 2 months ago
JSON representation

CakePHP plugin that performs Remember-me authentication with the new cookie algorithm of version 3.5 or later.

• Host: GitHub
• URL: https://github.com/node-link/cakephp-remember-me
• Owner: node-link
• License: mit
• Created: 2018-09-27T04:33:51.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-10-29T14:28:27.000Z (about 6 years ago)
• Last Synced: 2024-11-18T09:51:57.241Z (2 months ago)
• Topics: cakephp, cakephp-plugin, cookie, remember-me, security
• Language: PHP
• Size: 8.79 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RememberMe plugin for CakePHP

CakePHP plugin that performs Remember-me authentication with the new cookie algorithm of version 3.5 or later.

## Requirements

* CakePHP 3.5 or later

* PHP 5.6 or later

## Installation

### 1. Install plugin

You can install this plugin into your CakePHP application using [composer](http://getcomposer.org).

The recommended way to install composer packages is:

```bash

composer require node-link/cakephp-remember-me

```

### 2. Load plugin

Please load the plugin manually as follows:

```php

addPlugin('NodeLink/RememberMe');

    }

}

```

Prior to 3.6.0, you should use `Plugin::load()`:

```php

 true]);

```

Or, use `bin/cake` to load the plugin as follows:

```bash

bin/cake plugin load -b NodeLink/RememberMe

```

### 3. Set up `AuthComponent`

In the `AppController.php` of your application, set up `AuthComponent`.

```php

loadComponent('Auth', [

            'authenticate' => [

                'Form' => [

                    'userModel' => 'Users',

                    'fields' => ['username' => 'username', 'password' => 'password'],

                ],

                'NodeLink/RememberMe.Cookie' => [

                    'userModel' => 'Users',  // Please set the same as 'Form'.

                    'fields' => ['token' => 'remember_token'],  // Specify the column where you want to save the token for Remember-me authentication.

                ],

            ],

        ]);

        // ...

    }

}

```

### 4. Updating database and models

Please update database and models as necessary.

```sql

ALTER TABLE `users` ADD `remember_token` VARCHAR(64) NULL DEFAULT NULL;

```

```php

Form->control('remember_me', ['type' => 'checkbox', 'label' => __('Remember me')]); ?>

Or

= $this->Form->checkbox('remember_me'); ?>

= $this->Form->label('remember_me', __('Remember me')); ?>

```

## Configuration

Edit `config/.env` or `config/app.php`.

The full default configuration is as follows:

```php

 [

        'cookieKey' => env('SECURITY_COOKIE_KEY', env('SECURITY_SALT', '__SALT__')),

    ],

    'RememberMe' => [

        'field' => 'remember_me',

        'cookie' => [

            'name' => 'remember_me',

            'expires' => '+1 year',

            'path' => '',

            'domain' => '',

            'secure' => false,

            'httpOnly' => true,

        ],

    ],

];

```

It is recommended to set random string to `SECURITY_COOKIE_KEY` of `config/.env`, or `'Security.cookieKey'` of `config/app.php`.

## Reporting Issues

If you have a problem with the RememberMe plugin, please send a pull request or open an issue on [GitHub](https://github.com/node-link/cakephp-remember-me/issues).

Also, I would appreciate it if you contribute to updating `README.md` file.