3 namespace Org\Mxchange\CoreFramework\Auth;
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;
12 * A cookie-bases authorization class
14 * @author Roland Haeder <webmaster@shipsimu.org>
16 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2023 Core Developer Team
17 * @license GNU GPL 3.0 or any newer version
18 * @link http://www.shipsimu.org
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.
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.
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/>.
33 class CookieAuth extends BaseFrameworkSystem implements Authorizeable, Registerable {
35 * Protected constructor
39 private function __construct () {
40 // Call parent constructor
41 parent::__construct(__CLASS__);
45 * Creates an instance of this class by the given response instance
47 * @param $responseInstance An instance of a Responseable class
48 * @return $loginInstance An instance of this login class
50 public static final function createCookieAuth (Responseable $responseInstance) {
52 $loginInstance = new CookieAuth();
54 // Return the prepared instance
55 return $loginInstance;
59 * "Setter" for username auth data
61 * @param $userName The username from request we shall set
64 public function setUserAuth (string $userName) {
65 FrameworkBootstrap::getResponseInstance()->addCookie('username', $userName);
69 * "Setter" for password hash auth data
71 * @param $passHash The hashed password from request we shall set
74 public function setPasswordAuth (string $passHash) {
75 FrameworkBootstrap::getResponseInstance()->addCookie('u_hash', $passHash);
79 * Getter for user auth cookie
81 * @return $userName Username to get from cookie
83 public function getUserAuth () {
84 // Get the username from cookie
85 $userName = FrameworkBootstrap::getRequestInstance()->readCookie('username');
87 // Return the username
92 * Getter for password hash auth cookie
94 * @return $passHash Password hash to get from cookie
96 public function getPasswordAuth () {
97 // Get the username from cookie
98 $passHash = FrameworkBootstrap::getRequestInstance()->readCookie('u_hash');
100 // Return the username
105 * Destroy the authorization data
109 public function destroyAuthData () {
110 // Expire both cookies
111 FrameworkBootstrap::getResponseInstance()->expireCookie('username');
112 FrameworkBootstrap::getResponseInstance()->expireCookie('u_hash');
116 * Updates the authorization data and/or sets additional tracking data
120 public function updateAuthData () {
121 FrameworkBootstrap::getResponseInstance()->refreshCookie('username');
122 FrameworkBootstrap::getResponseInstance()->refreshCookie('u_hash');