From f06aa8058b7e32ba32d4551074b6e0b8a300f751 Mon Sep 17 00:00:00 2001
From: Thomas Bruederli <thomas@roundcube.net>
Date: Mon, 21 Oct 2013 15:02:40 -0400
Subject: [PATCH] Bump version after security fix
---
program/include/rcube_session.php | 330 ++++++++++++++++++++++++++++++++++++++++++-------------
1 files changed, 252 insertions(+), 78 deletions(-)
diff --git a/program/include/rcube_session.php b/program/include/rcube_session.php
index 7384af3..e00401f 100644
--- a/program/include/rcube_session.php
+++ b/program/include/rcube_session.php
@@ -5,8 +5,12 @@
| program/include/rcube_session.php |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2005-2011, The Roundcube Dev Team |
- | Licensed under the GNU GPL |
+ | Copyright (C) 2005-2012, The Roundcube Dev Team |
+ | Copyright (C) 2011, Kolab Systems AG |
+ | |
+ | Licensed under the GNU General Public License version 3 or |
+ | any later version with exceptions for skins & plugins. |
+ | See the README file for a full license statement. |
| |
| PURPOSE: |
| Provide database supported session management |
@@ -36,33 +40,59 @@
private $unsets = array();
private $gc_handlers = array();
private $cookiename = 'roundcube_sessauth';
- private $vars = false;
+ private $vars;
private $key;
private $now;
- private $prev;
private $secret = '';
private $ip_check = false;
+ private $logging = false;
private $keep_alive = 0;
+ private $memcache;
/**
* Default constructor
*/
- public function __construct($db, $lifetime=60)
+ public function __construct($db, $config)
{
- $this->db = $db;
- $this->start = microtime(true);
- $this->ip = $_SERVER['REMOTE_ADDR'];
+ $this->db = $db;
+ $this->start = microtime(true);
+ $this->ip = $_SERVER['REMOTE_ADDR'];
+ $this->logging = $config->get('log_session', false);
+ $lifetime = $config->get('session_lifetime', 1) * 60;
$this->set_lifetime($lifetime);
- // set custom functions for PHP session management
- session_set_save_handler(
- array($this, 'open'),
- array($this, 'close'),
- array($this, 'read'),
- array($this, 'write'),
- array($this, 'destroy'),
- array($this, 'gc'));
+ // use memcache backend
+ if ($config->get('session_storage', 'db') == 'memcache') {
+ $this->memcache = rcmail::get_instance()->get_memcache();
+
+ // set custom functions for PHP session management if memcache is available
+ if ($this->memcache) {
+ session_set_save_handler(
+ array($this, 'open'),
+ array($this, 'close'),
+ array($this, 'mc_read'),
+ array($this, 'mc_write'),
+ array($this, 'mc_destroy'),
+ array($this, 'gc'));
+ }
+ else {
+ raise_error(array('code' => 604, 'type' => 'db',
+ 'line' => __LINE__, 'file' => __FILE__,
+ 'message' => "Failed to connect to memcached. Please check configuration"),
+ true, true);
+ }
+ }
+ else {
+ // set custom functions for PHP session management
+ session_set_save_handler(
+ array($this, 'open'),
+ array($this, 'close'),
+ array($this, 'db_read'),
+ array($this, 'db_write'),
+ array($this, 'db_destroy'),
+ array($this, 'db_gc'));
+ }
}
@@ -78,25 +108,39 @@
}
- // read session data
- public function read($key)
+ /**
+ * Delete session data for the given key
+ *
+ * @param string Session ID
+ */
+ public function destroy($key)
+ {
+ return $this->memcache ? $this->mc_destroy($key) : $this->db_destroy($key);
+ }
+
+
+ /**
+ * Read session data from database
+ *
+ * @param string Session ID
+ * @return string Session vars
+ */
+ public function db_read($key)
{
$sql_result = $this->db->query(
- sprintf("SELECT vars, ip, %s AS changed FROM %s WHERE sess_id = ?",
- $this->db->unixtimestamp('changed'), get_table_name('session')),
- $key);
+ "SELECT vars, ip, changed FROM ".get_table_name('session')
+ ." WHERE sess_id = ?", $key);
- if ($sql_arr = $this->db->fetch_assoc($sql_result)) {
- $this->changed = $sql_arr['changed'];
+ if ($sql_result && ($sql_arr = $this->db->fetch_assoc($sql_result))) {
+ $this->changed = strtotime($sql_arr['changed']);
$this->ip = $sql_arr['ip'];
$this->vars = base64_decode($sql_arr['vars']);
$this->key = $key;
- if (!empty($this->vars))
- return $this->vars;
+ return !empty($this->vars) ? (string) $this->vars : '';
}
- return false;
+ return null;
}
@@ -108,29 +152,25 @@
* @param string Serialized session vars
* @return boolean True on success
*/
- public function write($key, $vars)
+ public function db_write($key, $vars)
{
$ts = microtime(true);
$now = $this->db->fromunixtime((int)$ts);
+ // no session row in DB (db_read() returns false)
+ if (!$this->key) {
+ $oldvars = null;
+ }
// use internal data from read() for fast requests (up to 0.5 sec.)
- if ($key == $this->key && $ts - $this->start < 0.5) {
+ else if ($key == $this->key && (!$this->vars || $ts - $this->start < 0.5)) {
$oldvars = $this->vars;
- } else { // else read data again from DB
- $oldvars = $this->read($key);
+ }
+ else { // else read data again from DB
+ $oldvars = $this->db_read($key);
}
- if ($oldvars !== false) {
- $a_oldvars = $this->unserialize($oldvars);
- if (is_array($a_oldvars)) {
- foreach ((array)$this->unsets as $k)
- unset($a_oldvars[$k]);
-
- $newvars = $this->serialize(array_merge(
- (array)$a_oldvars, (array)$this->unserialize($vars)));
- }
- else
- $newvars = $vars;
+ if ($oldvars !== null) {
+ $newvars = $this->_fixvars($vars, $oldvars);
if ($newvars !== $oldvars) {
$this->db->query(
@@ -150,8 +190,30 @@
$key, base64_encode($vars), (string)$this->ip);
}
- $this->unsets = array();
return true;
+ }
+
+
+ /**
+ * Merge vars with old vars and apply unsets
+ */
+ private function _fixvars($vars, $oldvars)
+ {
+ if ($oldvars !== null) {
+ $a_oldvars = $this->unserialize($oldvars);
+ if (is_array($a_oldvars)) {
+ foreach ((array)$this->unsets as $k)
+ unset($a_oldvars[$k]);
+
+ $newvars = $this->serialize(array_merge(
+ (array)$a_oldvars, (array)$this->unserialize($vars)));
+ }
+ else
+ $newvars = $vars;
+ }
+
+ $this->unsets = array();
+ return $newvars;
}
@@ -159,13 +221,14 @@
* Handler for session_destroy()
*
* @param string Session ID
+ *
* @return boolean True on success
*/
- public function destroy($key)
+ public function db_destroy($key)
{
- $this->db->query(
- sprintf("DELETE FROM %s WHERE sess_id = ?", get_table_name('session')),
- $key);
+ if ($key) {
+ $this->db->query(sprintf("DELETE FROM %s WHERE sess_id = ?", get_table_name('session')), $key);
+ }
return true;
}
@@ -177,17 +240,96 @@
* @param string Session lifetime in seconds
* @return boolean True on success
*/
- public function gc($maxlifetime)
+ public function db_gc($maxlifetime)
{
// just delete all expired sessions
$this->db->query(
sprintf("DELETE FROM %s WHERE changed < %s",
get_table_name('session'), $this->db->fromunixtime(time() - $maxlifetime)));
- foreach ($this->gc_handlers as $fct)
- $fct();
+ $this->gc();
return true;
+ }
+
+
+ /**
+ * Read session data from memcache
+ *
+ * @param string Session ID
+ * @return string Session vars
+ */
+ public function mc_read($key)
+ {
+ if ($value = $this->memcache->get($key)) {
+ $arr = unserialize($value);
+ $this->changed = $arr['changed'];
+ $this->ip = $arr['ip'];
+ $this->vars = $arr['vars'];
+ $this->key = $key;
+
+ return !empty($this->vars) ? (string) $this->vars : '';
+ }
+
+ return null;
+ }
+
+
+ /**
+ * Save session data.
+ * handler for session_read()
+ *
+ * @param string Session ID
+ * @param string Serialized session vars
+ * @return boolean True on success
+ */
+ public function mc_write($key, $vars)
+ {
+ $ts = microtime(true);
+
+ // no session data in cache (mc_read() returns false)
+ if (!$this->key)
+ $oldvars = null;
+ // use internal data for fast requests (up to 0.5 sec.)
+ else if ($key == $this->key && (!$this->vars || $ts - $this->start < 0.5))
+ $oldvars = $this->vars;
+ else // else read data again
+ $oldvars = $this->mc_read($key);
+
+ $newvars = $oldvars !== null ? $this->_fixvars($vars, $oldvars) : $vars;
+
+ if ($newvars !== $oldvars || $ts - $this->changed > $this->lifetime / 2)
+ return $this->memcache->set($key, serialize(array('changed' => time(), 'ip' => $this->ip, 'vars' => $newvars)), MEMCACHE_COMPRESSED, $this->lifetime);
+
+ return true;
+ }
+
+
+ /**
+ * Handler for session_destroy() with memcache backend
+ *
+ * @param string Session ID
+ *
+ * @return boolean True on success
+ */
+ public function mc_destroy($key)
+ {
+ if ($key) {
+ // #1488592: use 2nd argument
+ $this->memcache->delete($key, 0);
+ }
+
+ return true;
+ }
+
+
+ /**
+ * Execute registered garbage collector routines
+ */
+ public function gc()
+ {
+ foreach ($this->gc_handlers as $fct)
+ call_user_func($fct);
}
@@ -196,36 +338,29 @@
*
* @param mixed Callback function
*/
- public function register_gc_handler($func_name)
+ public function register_gc_handler($func)
{
- if ($func_name && !in_array($func_name, $this->gc_handlers))
- $this->gc_handlers[] = $func_name;
+ foreach ($this->gc_handlers as $handler) {
+ if ($handler == $func) {
+ return;
+ }
+ }
+
+ $this->gc_handlers[] = $func;
}
/**
* Generate and set new session id
+ *
+ * @param boolean $destroy If enabled the current session will be destroyed
*/
- public function regenerate_id()
+ public function regenerate_id($destroy=true)
{
- // delete old session record
- $this->destroy(session_id());
- $this->vars = false;
+ session_regenerate_id($destroy);
- $randval = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
-
- for ($random = '', $i=1; $i <= 32; $i++) {
- $random .= substr($randval, mt_rand(0,(strlen($randval) - 1)), 1);
- }
-
- // use md5 value for id
- $this->key = md5($random);
- session_id($this->key);
-
- $cookie = session_get_cookie_params();
- $lifetime = $cookie['lifetime'] ? time() + $cookie['lifetime'] : 0;
-
- rcmail::setcookie(session_name(), $this->key, $lifetime);
+ $this->vars = null;
+ $this->key = session_id();
return true;
}
@@ -247,14 +382,32 @@
return true;
}
-
+
+
/**
* Kill this session
*/
public function kill()
{
+ $this->vars = null;
+ $this->ip = $_SERVER['REMOTE_ADDR']; // update IP (might have changed)
$this->destroy(session_id());
rcmail::setcookie($this->cookiename, '-del-', time() - 60);
+ }
+
+
+ /**
+ * Re-read session data from storage backend
+ */
+ public function reload()
+ {
+ if ($this->key && $this->memcache)
+ $data = $this->mc_read($this->key);
+ else if ($this->key)
+ $data = $this->db_read($this->key);
+
+ if ($data)
+ session_decode($data);
}
@@ -372,7 +525,6 @@
// valid time range is now - 1/2 lifetime to now + 1/2 lifetime
$now = time();
$this->now = $now - ($now % ($this->lifetime / 2));
- $this->prev = $this->now - ($this->lifetime / 2);
}
/**
@@ -439,13 +591,26 @@
$this->cookie = $_COOKIE[$this->cookiename];
$result = $this->ip_check ? $_SERVER['REMOTE_ADDR'] == $this->ip : true;
+ if (!$result)
+ $this->log("IP check failed for " . $this->key . "; expected " . $this->ip . "; got " . $_SERVER['REMOTE_ADDR']);
+
if ($result && $this->_mkcookie($this->now) != $this->cookie) {
- // Check if using id from previous time slot
- if ($this->_mkcookie($this->prev) == $this->cookie)
- $this->set_auth_cookie();
- else
- $result = false;
- }
+ $this->log("Session auth check failed for " . $this->key . "; timeslot = " . date('Y-m-d H:i:s', $this->now));
+ $result = false;
+
+ // Check if using id from a previous time slot
+ for ($i = 1; $i <= 2; $i++) {
+ $prev = $this->now - ($this->lifetime / 2) * $i;
+ if ($this->_mkcookie($prev) == $this->cookie) {
+ $this->log("Send new auth cookie for " . $this->key . ": " . $this->cookie);
+ $this->set_auth_cookie();
+ $result = true;
+ }
+ }
+ }
+
+ if (!$result)
+ $this->log("Session authentication failed for " . $this->key . "; invalid auth cookie sent; timeslot = " . date('Y-m-d H:i:s', $prev));
return $result;
}
@@ -472,5 +637,14 @@
$auth_string = "$this->key,$this->secret,$timeslot";
return "S" . (function_exists('sha1') ? sha1($auth_string) : md5($auth_string));
}
+
+ /**
+ *
+ */
+ function log($line)
+ {
+ if ($this->logging)
+ write_log('session', $line);
+ }
}
--
Gitblit v1.9.1