X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=framework%2Fmain%2Fclasses%2Fauth%2Fclass_CookieAuth.php;fp=framework%2Fmain%2Fclasses%2Fauth%2Fclass_CookieAuth.php;h=a98999f4c954eb7d7936d98db081612894b9e311;hb=78a010fef84895720e796842208f01dfb619c332;hp=0000000000000000000000000000000000000000;hpb=7629f2314d517561d4301ddfb068a797b6ed8700;p=core.git

diff --git a/framework/main/classes/auth/class_CookieAuth.php b/framework/main/classes/auth/class_CookieAuth.php
new file mode 100644
index 00000000..a98999f4
--- /dev/null
+++ b/framework/main/classes/auth/class_CookieAuth.php
@@ -0,0 +1,127 @@
+<?php
+// Own namespace
+namespace CoreFramework\Auth;
+
+// Import framework stuff
+use CoreFramework\Object\BaseFrameworkSystem;
+use CoreFramework\Registry\Registerable;
+use CoreFramework\Response\Responseable;
+
+/**
+ * A cookie-bases authorization class
+ *
+ * @author		Roland Haeder <webmaster@shipsimu.org>
+ * @version		0.0.0
+ * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
+ * @license		GNU GPL 3.0 or any newer version
+ * @link		http://www.shipsimu.org
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+class CookieAuth extends BaseFrameworkSystem implements Authorizeable, Registerable {
+	/**
+	 * Protected constructor
+	 *
+	 * @return	void
+	 */
+	protected function __construct () {
+		// Call parent constructor
+		parent::__construct(__CLASS__);
+	}
+
+	/**
+	 * Creates an instance of this class by the given response instance
+	 *
+	 * @param	$responseInstance	An instance of a Responseable class
+	 * @return	$loginInstance		An instance of this login class
+	 */
+	public static final function createCookieAuth (Responseable $responseInstance) {
+		// Get a new instance
+		$loginInstance = new CookieAuth();
+
+		// Set the response instance
+		$loginInstance->setResponseInstance($responseInstance);
+
+		// Return the prepared instance
+		return $loginInstance;
+	}
+
+	/**
+	 * "Setter" for username auth data
+	 *
+	 * @param	$userName	The username from request we shall set
+	 * @return	void
+	 */
+	public function setUserAuth ($userName) {
+		$this->getResponseInstance()->addCookie('username', $userName);
+	}
+
+	/**
+	 * "Setter" for password hash auth data
+	 *
+	 * @param	$passHash	The hashed password from request we shall set
+	 * @return	void
+	 */
+	public function setPasswordAuth ($passHash) {
+		$this->getResponseInstance()->addCookie('u_hash', $passHash);
+	}
+
+	/**
+	 * Getter for user auth cookie
+	 *
+	 * @return	$userName	Username to get from cookie
+	 */
+	public function getUserAuth () {
+		// Get the username from cookie
+		$userName = $this->getRequestInstance()->readCookie('username');
+
+		// Return the username
+		return $userName;
+	}
+
+	/**
+	 * Getter for password hash auth cookie
+	 *
+	 * @return	$passHash	Password hash to get from cookie
+	 */
+	public function getPasswordAuth () {
+		// Get the username from cookie
+		$passHash = $this->getRequestInstance()->readCookie('u_hash');
+
+		// Return the username
+		return $passHash;
+	}
+
+	/**
+	 * Destroy the authorization data
+	 *
+	 * @return	void
+	 */
+	public function destroyAuthData () {
+		// Expire both cookies
+		$this->getResponseInstance()->expireCookie('username');
+		$this->getResponseInstance()->expireCookie('u_hash');
+	}
+
+	/**
+	 * Updates the authorization data and/or sets additional tracking data
+	 *
+	 * @return	void
+	 */
+	public function updateAuthData () {
+		$this->getResponseInstance()->refreshCookie('username');
+		$this->getResponseInstance()->refreshCookie('u_hash');
+	}
+
+}