framework/main/classes/auth/class_CookieAuth.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Auth;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Bootstrap\FrameworkBootstrap;
   7 use Org\Mxchange\CoreFramework\Object\BaseFrameworkSystem;
   8 use Org\Mxchange\CoreFramework\Registry\Registerable;
   9 use Org\Mxchange\CoreFramework\Response\Responseable;
  10
  11 /**
  12  * A cookie-bases authorization class
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2019 Core Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.shipsimu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 class CookieAuth extends BaseFrameworkSystem implements Authorizeable, Registerable {
  34         /**
  35          * Protected constructor
  36          *
  37          * @return      void
  38          */
  39         protected function __construct () {
  40                 // Call parent constructor
  41                 parent::__construct(__CLASS__);
  42         }
  43
  44         /**
  45          * Creates an instance of this class by the given response instance
  46          *
  47          * @param       $responseInstance       An instance of a Responseable class
  48          * @return      $loginInstance          An instance of this login class
  49          */
  50         public static final function createCookieAuth (Responseable $responseInstance) {
  51                 // Get a new instance
  52                 $loginInstance = new CookieAuth();
  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                 FrameworkBootstrap::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                 FrameworkBootstrap::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 = FrameworkBootstrap::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 = FrameworkBootstrap::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                 FrameworkBootstrap::getResponseInstance()->expireCookie('username');
 112                 FrameworkBootstrap::getResponseInstance()->expireCookie('u_hash');
 113         }
 114
 115         /**
 116          * Updates the authorization data and/or sets additional tracking data
 117          *
 118          * @return      void
 119          */
 120         public function updateAuthData () {
 121                 FrameworkBootstrap::getResponseInstance()->refreshCookie('username');
 122                 FrameworkBootstrap::getResponseInstance()->refreshCookie('u_hash');
 123         }
 124
 125 }