inc/main/classes/auth/class_CookieAuth.php

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