/lib/Cake/Controller/Component/Auth/BasicAuthenticate.php - pictcode - Redmine

pictcode / lib / Cake / Controller / Component / Auth / BasicAuthenticate.php @ 635eef61

       <?php
       /**
        * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
        * Copyright (c) Cake Software Foundation, Inc. (http://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. (http://cakefoundation.org)
        * @link          http://cakephp.org CakePHP(tm) Project
        * @license       http://www.opensource.org/licenses/mit-license.php MIT License
        */
       App::uses('BaseAuthenticate', 'Controller/Component/Auth');
       /**
        * Basic Authentication adapter for AuthComponent.
+       *
        * Provides Basic HTTP authentication support for AuthComponent. Basic Auth will
        * authenticate users against the configured userModel and verify the username
        * and passwords match.
+       *
        * ### Using Basic auth
+       *
        * In your controller's components array, add auth + the required settings.
        * ```
        *        public $components = array(
        *                'Auth' => array(
        *                        'authenticate' => array('Basic')
        *                )
        *        );
        * ```
+       *
        * You should also set `AuthComponent::$sessionKey = false;` in your AppController's
        * beforeFilter() to prevent CakePHP from sending a session cookie to the client.
+       *
        * Since HTTP Basic Authentication is stateless you don't need a login() action
        * in your controller. The user credentials will be checked on each request. If
        * valid credentials are not provided, required authentication headers will be sent
        * by this authentication provider which triggers the login dialog in the browser/client.
+       *
        * You may also want to use `$this->Auth->unauthorizedRedirect = false;`.
        * By default, unauthorized users are redirected to the referrer URL,
        * `AuthComponent::$loginAction`, or '/'. If unauthorizedRedirect is set to
        * false, a ForbiddenException exception is thrown instead of redirecting.
+       *
        * @package       Cake.Controller.Component.Auth
        * @since 2.0
        */
       class BasicAuthenticate extends BaseAuthenticate {
       /**
        * Constructor, completes configuration for basic authentication.
+       *
        * @param ComponentCollection $collection The Component collection used on this request.
        * @param array $settings An array of settings.
        */
               public function __construct(ComponentCollection $collection, $settings) {
                       parent::__construct($collection, $settings);
                       if (empty($this->settings['realm'])) {
                               $this->settings['realm'] = env('SERVER_NAME');
+                      }
+              }
       /**
        * Authenticate a user using HTTP auth. Will use the configured User model and attempt a
        * login using HTTP auth.
+       *
        * @param CakeRequest $request The request to authenticate with.
        * @param CakeResponse $response The response to add headers to.
        * @return mixed Either false on failure, or an array of user data on success.
        */
               public function authenticate(CakeRequest $request, CakeResponse $response) {
                       return $this->getUser($request);
+              }
       /**
        * Get a user based on information in the request. Used by cookie-less auth for stateless clients.
+       *
        * @param CakeRequest $request Request object.
        * @return mixed Either false or an array of user information
        */
               public function getUser(CakeRequest $request) {
                       $username = env('PHP_AUTH_USER');
                       $pass = env('PHP_AUTH_PW');
                       if (!is_string($username) || $username === '' || !is_string($pass) || $pass === '') {
                               return false;
+                      }
                       return $this->_findUser($username, $pass);
+              }
       /**
        * Handles an unauthenticated access attempt by sending appropriate login headers
+       *
        * @param CakeRequest $request A request object.
        * @param CakeResponse $response A response object.
        * @return void
        * @throws UnauthorizedException
        */
               public function unauthenticated(CakeRequest $request, CakeResponse $response) {
                       $Exception = new UnauthorizedException();
                       $Exception->responseHeader(array($this->loginHeaders()));
                       throw $Exception;
+              }
       /**
        * Generate the login headers
+       *
        * @return string Headers for logging in.
        */
               public function loginHeaders() {
                       return sprintf('WWW-Authenticate: Basic realm="%s"', $this->settings['realm']);
+              }
+      }