nextcloud/lib/private/user/session.php

288 lines
7.3 KiB
PHP
Raw Normal View History

2013-05-29 01:46:57 +04:00
<?php
/**
* Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
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
*/
public function listen($scope, $method, $callback) {
$this->manager->listen($scope, $method, $callback);
}
/**
* @param string $scope optional
* @param string $method optional
* @param callable $callback optional
*/
public function removeListener($scope = null, $method = null, $callback = null) {
$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() {
// fetch the deprecated \OC::$session if it changed for backwards compatibility
if (isset(\OC::$session) && \OC::$session !== $this->session) {
\OC::$server->getLogger()->warning(
'One of your installed apps still seems to use the deprecated '.
'\OC::$session and has replaced it with a new instance. Please file a bug against it.'.
'Closing and replacing session in UserSession instance.'
);
$this->setSession(\OC::$session);
}
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;
// maintain deprecated \OC::$session
if (\OC::$session !== $this->session) {
if (\OC::$session instanceof \OCP\ISession) {
\OC::$session->close();
}
\OC::$session = $session;
}
}
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 \OC\User\User
*/
public function getUser() {
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;
}
}
}
/**
* 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
2013-06-03 15:33:56 +04:00
*/
2013-05-29 01:46:57 +04:00
public function login($uid, $password) {
$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));
return true;
} 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->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_Preferences::getKeys($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_Preferences::deleteKey($uid, 'login_token', $currentToken);
$newToken = \OC::$server->getSecureRandom()->getMediumStrengthGenerator()->generate(32);
\OC_Preferences::setValue($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();
}
/**
* Set cookie value to use in next page load
*
* @param string $username username to be set
* @param string $token
*/
public function setMagicInCookie($username, $token) {
$secure_cookie = \OC_Config::getValue("forcessl", false); //TODO: DI for cookies and OC_Config
$expires = time() + \OC_Config::getValue('remember_login_cookie_lifetime', 60 * 60 * 24 * 15);
2013-06-01 02:35:16 +04:00
setcookie("oc_username", $username, $expires, \OC::$WEBROOT, '', $secure_cookie);
setcookie("oc_token", $token, $expires, \OC::$WEBROOT, '', $secure_cookie, true);
2014-05-13 02:27:36 +04:00
setcookie("oc_remember_login", "1", $expires, \OC::$WEBROOT, '', $secure_cookie);
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() {
unset($_COOKIE["oc_username"]); //TODO: DI
unset($_COOKIE["oc_token"]);
unset($_COOKIE["oc_remember_login"]);
2013-07-09 18:46:35 +04:00
setcookie('oc_username', '', time()-3600, \OC::$WEBROOT);
setcookie('oc_token', '', time()-3600, \OC::$WEBROOT);
setcookie('oc_remember_login', '', time()-3600, \OC::$WEBROOT);
// old cookies might be stored under /webroot/ instead of /webroot
// and Firefox doesn't like it!
setcookie('oc_username', '', time()-3600, \OC::$WEBROOT . '/');
setcookie('oc_token', '', time()-3600, \OC::$WEBROOT . '/');
setcookie('oc_remember_login', '', time()-3600, \OC::$WEBROOT . '/');
2013-05-29 01:46:57 +04:00
}
}