nextcloud/lib/private/user/session.php

318 lines
8.7 KiB
PHP
Raw Normal View History

2013-05-29 01:46:57 +04:00
<?php
/**
2015-03-26 13:44:34 +03:00
* @author Arthur Schiwon <blizzz@owncloud.com>
* @author Bernhard Posselt <dev@bernhard-posselt.com>
* @author Joas Schilling <nickvergessen@owncloud.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lukas Reschke <lukas@owncloud.com>
* @author Morris Jobke <hey@morrisjobke.de>
* @author Robin Appelman <icewind@owncloud.com>
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
* @author Thomas Müller <thomas.mueller@tmit.eu>
* @author Vincent Petry <pvince81@owncloud.com>
*
* @copyright Copyright (c) 2015, ownCloud, Inc.
* @license AGPL-3.0
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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 Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
2013-05-29 01:46:57 +04:00
*/
2013-05-29 01:46:57 +04:00
namespace OC\User;
use OC\Hooks\Emitter;
use OCP\IUserSession;
2013-05-29 01:46:57 +04:00
/**
* Class Session
*
* Hooks available in scope \OC\User:
* - preSetPassword(\OC\User\User $user, string $password, string $recoverPassword)
* - postSetPassword(\OC\User\User $user, string $password, string $recoverPassword)
* - preDelete(\OC\User\User $user)
* - postDelete(\OC\User\User $user)
* - preCreateUser(string $uid, string $password)
* - postCreateUser(\OC\User\User $user)
* - preLogin(string $user, string $password)
* - postLogin(\OC\User\User $user, string $password)
* - preRememberedLogin(string $uid)
* - postRememberedLogin(\OC\User\User $user)
2013-05-29 01:46:57 +04:00
* - logout()
*
* @package OC\User
*/
class Session implements IUserSession, Emitter {
2013-05-29 01:46:57 +04:00
/**
* @var \OC\User\Manager $manager
*/
private $manager;
/**
* @var \OC\Session\Session $session
*/
private $session;
/**
* @var \OC\User\User $activeUser
*/
protected $activeUser;
/**
* @param \OCP\IUserManager $manager
* @param \OCP\ISession $session
2013-05-29 01:46:57 +04:00
*/
public function __construct(\OCP\IUserManager $manager, \OCP\ISession $session) {
2013-05-29 01:46:57 +04:00
$this->manager = $manager;
$this->session = $session;
}
/**
* @param string $scope
* @param string $method
* @param callable $callback
*/
2015-05-08 15:27:22 +03:00
public function listen($scope, $method, callable $callback) {
2013-05-29 01:46:57 +04:00
$this->manager->listen($scope, $method, $callback);
}
/**
* @param string $scope optional
* @param string $method optional
* @param callable $callback optional
*/
2015-05-08 15:27:22 +03:00
public function removeListener($scope = null, $method = null, callable $callback = null) {
2013-05-29 01:46:57 +04:00
$this->manager->removeListener($scope, $method, $callback);
}
/**
2013-06-03 15:33:56 +04:00
* get the manager object
*
2013-05-29 01:46:57 +04:00
* @return \OC\User\Manager
*/
public function getManager() {
return $this->manager;
}
/**
* get the session object
*
* @return \OCP\ISession
*/
public function getSession() {
return $this->session;
}
/**
* set the session object
*
* @param \OCP\ISession $session
*/
public function setSession(\OCP\ISession $session) {
if ($this->session instanceof \OCP\ISession) {
$this->session->close();
}
$this->session = $session;
$this->activeUser = null;
}
2013-05-29 01:46:57 +04:00
/**
* set the currently active user
*
2014-05-13 02:27:36 +04:00
* @param \OC\User\User|null $user
2013-05-29 01:46:57 +04:00
*/
public function setUser($user) {
if (is_null($user)) {
$this->session->remove('user_id');
} else {
$this->session->set('user_id', $user->getUID());
}
$this->activeUser = $user;
}
/**
* get the current active user
*
* @return \OCP\IUser|null Current user, otherwise null
2013-05-29 01:46:57 +04:00
*/
public function getUser() {
// FIXME: This is a quick'n dirty work-around for the incognito mode as
// described at https://github.com/owncloud/core/pull/12912#issuecomment-67391155
if (\OC_User::isIncognitoMode()) {
return null;
}
2013-05-29 01:46:57 +04:00
if ($this->activeUser) {
return $this->activeUser;
} else {
$uid = $this->session->get('user_id');
if ($uid !== null) {
2013-05-29 01:46:57 +04:00
$this->activeUser = $this->manager->get($uid);
return $this->activeUser;
} else {
return null;
}
}
}
/**
2014-12-19 16:36:00 +03:00
* Checks whether the user is logged in
*
* @return bool if logged in
*/
public function isLoggedIn() {
return $this->getUser() !== null;
}
/**
* set the login name
*
2014-05-13 02:27:36 +04:00
* @param string|null $loginName for the logged in user
*/
2014-01-09 13:27:47 +04:00
public function setLoginName($loginName) {
if (is_null($loginName)) {
$this->session->remove('loginname');
} else {
2014-01-09 13:27:47 +04:00
$this->session->set('loginname', $loginName);
}
}
/**
* get the login name of the current user
*
* @return string
*/
2014-01-09 13:27:47 +04:00
public function getLoginName() {
if ($this->activeUser) {
return $this->session->get('loginname');
} else {
$uid = $this->session->get('user_id');
if ($uid) {
$this->activeUser = $this->manager->get($uid);
return $this->session->get('loginname');
} else {
return null;
}
}
}
2013-06-03 15:33:56 +04:00
/**
* try to login with the provided credentials
*
* @param string $uid
* @param string $password
* @return boolean|null
* @throws LoginException
2013-06-03 15:33:56 +04:00
*/
2013-05-29 01:46:57 +04:00
public function login($uid, $password) {
$this->session->regenerateId();
2013-05-29 01:46:57 +04:00
$this->manager->emit('\OC\User', 'preLogin', array($uid, $password));
$user = $this->manager->checkPassword($uid, $password);
if ($user !== false) {
if (!is_null($user)) {
if ($user->isEnabled()) {
$this->setUser($user);
2014-01-09 13:27:47 +04:00
$this->setLoginName($uid);
$this->manager->emit('\OC\User', 'postLogin', array($user, $password));
if ($this->isLoggedIn()) {
return true;
} else {
throw new LoginException('Login canceled by app');
}
} else {
return false;
}
2013-05-29 01:46:57 +04:00
}
} else {
return false;
}
}
/**
* perform login using the magic cookie (remember login)
*
* @param string $uid the username
* @param string $currentToken
* @return bool
*/
public function loginWithCookie($uid, $currentToken) {
$this->session->regenerateId();
$this->manager->emit('\OC\User', 'preRememberedLogin', array($uid));
$user = $this->manager->get($uid);
if (is_null($user)) {
// user does not exist
return false;
}
// get stored tokens
$tokens = \OC::$server->getConfig()->getUserKeys($uid, 'login_token');
// test cookies token against stored tokens
if (!in_array($currentToken, $tokens, true)) {
return false;
}
// replace successfully used token with a new one
\OC::$server->getConfig()->deleteUserValue($uid, 'login_token', $currentToken);
$newToken = \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate(32);
\OC::$server->getConfig()->setUserValue($uid, 'login_token', $newToken, time());
$this->setMagicInCookie($user->getUID(), $newToken);
//login
$this->setUser($user);
$this->manager->emit('\OC\User', 'postRememberedLogin', array($user));
return true;
}
2013-06-03 15:33:56 +04:00
/**
* logout the user from the session
*/
2013-05-29 01:46:57 +04:00
public function logout() {
$this->manager->emit('\OC\User', 'logout');
$this->setUser(null);
2014-01-09 13:27:47 +04:00
$this->setLoginName(null);
2013-05-29 01:46:57 +04:00
$this->unsetMagicInCookie();
$this->session->clear();
2013-05-29 01:46:57 +04:00
}
/**
* Set cookie value to use in next page load
*
* @param string $username username to be set
* @param string $token
*/
public function setMagicInCookie($username, $token) {
$secureCookie = \OC::$server->getRequest()->getServerProtocol() === 'https';
2015-12-03 18:41:23 +03:00
$expires = time() + \OC::$server->getConfig()->getSystemValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15);
setcookie("oc_username", $username, $expires, \OC::$WEBROOT, '', $secureCookie, true);
setcookie("oc_token", $token, $expires, \OC::$WEBROOT, '', $secureCookie, true);
setcookie("oc_remember_login", "1", $expires, \OC::$WEBROOT, '', $secureCookie, true);
2013-05-29 01:46:57 +04:00
}
/**
2013-06-03 15:33:56 +04:00
* Remove cookie for "remember username"
2013-05-29 01:46:57 +04:00
*/
public function unsetMagicInCookie() {
//TODO: DI for cookies and IRequest
$secureCookie = \OC::$server->getRequest()->getServerProtocol() === 'https';
2013-05-29 01:46:57 +04:00
unset($_COOKIE["oc_username"]); //TODO: DI
unset($_COOKIE["oc_token"]);
unset($_COOKIE["oc_remember_login"]);
setcookie('oc_username', '', time() - 3600, \OC::$WEBROOT, '',$secureCookie, true);
setcookie('oc_token', '', time() - 3600, \OC::$WEBROOT, '', $secureCookie, true);
setcookie('oc_remember_login', '', time() - 3600, \OC::$WEBROOT, '', $secureCookie, true);
// old cookies might be stored under /webroot/ instead of /webroot
// and Firefox doesn't like it!
setcookie('oc_username', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
setcookie('oc_token', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
setcookie('oc_remember_login', '', time() - 3600, \OC::$WEBROOT . '/', '', $secureCookie, true);
2013-05-29 01:46:57 +04:00
}
}