<?php
/**
*
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 2.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Auth;
use Cake\Http\Response;
use Cake\Http\ServerRequest;
/**
* Form authentication adapter for AuthComponent.
*
* Allows you to authenticate users based on form POST data.
* Usually, this is a login form that users enter information into.
*
* ### Using Form auth
*
* Load `AuthComponent` in your controller's `initialize()` and add 'Form' in 'authenticate' key
*
* ```
* $this->loadComponent('Auth', [
* 'authenticate' => [
* 'Form' => [
* 'fields' => ['username' => 'email', 'password' => 'passwd'],
* 'finder' => 'auth',
* ]
* ]
* ]);
* ```
*
* When configuring FormAuthenticate you can pass in config to which fields, model and finder
* are used. See `BaseAuthenticate::$_defaultConfig` for more information.
*
* @see https://book.cakephp.org/3/en/controllers/components/authentication.html
*/
class FormAuthenticate extends BaseAuthenticate
{
/**
* Checks the fields to ensure they are supplied.
*
* @param \Cake\Http\ServerRequest $request The request that contains login information.
* @param array $fields The fields to be checked.
* @return bool False if the fields have not been supplied. True if they exist.
*/
protected function _checkFields(ServerRequest $request, array $fields)
{
foreach ([$fields['username'], $fields['password']] as $field) {
$value = $request->getData($field);
if (empty($value) || !is_string($value)) {
return false;
}
}
return true;
}
/**
* Authenticates the identity contained in a request. Will use the `config.userModel`, and `config.fields`
* to find POST data that is used to find a matching record in the `config.userModel`. Will return false if
* there is no post data, either username or password is missing, or if the scope conditions have not been met.
*
* @param \Cake\Http\ServerRequest $request The request that contains login information.
* @param \Cake\Http\Response $response Unused response object.
* @return array|false False on login failure. An array of User data on success.
*/
public function authenticate(ServerRequest $request, Response $response)
{
$fields = $this->_config['fields'];
if (!$this->_checkFields($request, $fields)) {
return false;
}
return $this->_findUser(
$request->getData($fields['username']),
$request->getData($fields['password'])
);
}
}