inc/classes/main/auth/class_CookieAuth.php

   1 <?php
   2 /**
   3  * A cookie-bases authorization class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class CookieAuth extends BaseFrameworkSystem implements Authorizeable, Registerable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set part description
  35                 $this->setObjectDescription("Cookie-based login");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39
  40                 // Clean up a little
  41                 $this->removeNumberFormaters();
  42                 $this->removeSystemArray();
  43         }
  44
  45         /**
  46          * Creates an instance of this class by the given response instance
  47          *
  48          * @param       $responseInstance       An instance of a Responseable class
  49          * @return      $loginInstance          An instance of this login class
  50          */
  51         public final static function createCookieAuth (Responseable $responseInstance) {
  52                 // Get a new instance
  53                 $loginInstance = new CookieAuth();
  54
  55                 // Set the response instance
  56                 $loginInstance->setResponseInstance($responseInstance);
  57
  58                 // Return the prepared instance
  59                 return $loginInstance;
  60         }
  61
  62         /**
  63          * "Setter" for username auth data
  64          *
  65          * @param       $userName       The username from request we shall set
  66          * @return      void
  67          */
  68         public function setUserAuth ($userName) {
  69                 $this->getResponseInstance()->addCookie('username', $userName);
  70         }
  71
  72         /**
  73          * "Setter" for password hash auth data
  74          *
  75          * @param       $passHash       The hashed password from request we shall set
  76          * @return      void
  77          */
  78         public function setPasswordAuth ($passHash) {
  79                 $this->getResponseInstance()->addCookie('u_hash', $passHash, true);
  80         }
  81
  82         /**
  83          * Getter for user auth cookie
  84          *
  85          * @return      $userName       Username to get from cookie
  86          */
  87         public function getUserAuth () {
  88                 // Get the username from cookie
  89                 $userName = $this->getRequestInstance()->readCookie('username');
  90
  91                 // Return the username
  92                 return $userName;
  93         }
  94
  95         /**
  96          * Getter for password hash auth cookie
  97          *
  98          * @return      $passHash       Password hash to get from cookie
  99          */
 100         public function getPasswordAuth () {
 101                 // Get the username from cookie
 102                 $passHash = $this->getRequestInstance()->readCookie('u_hash');
 103
 104                 // Return the username
 105                 return $passHash;
 106         }
 107
 108         /**
 109          * Destroy the authorization data
 110          *
 111          * @return      void
 112          */
 113         public function destroyAuthData () {
 114                 // Expire both cookies
 115                 $this->getResponseInstance()->expireCookie('username');
 116                 $this->getResponseInstance()->expireCookie('u_hash');
 117         }
 118
 119         /**
 120          * Updates the authorization data and/or sets additional tracking data
 121          *
 122          * @param       $requestInstance        An instance of a Requestable class
 123          * @return      void
 124          */
 125         public function updateAuthData () {
 126                 $this->getResponseInstance()->refreshCookie('username');
 127                 $this->getResponseInstance()->refreshCookie('u_hash');
 128         }
 129 }
 130
 131 // [EOF]
 132 ?>