Skip to content

Cache recently used tokens for a short period #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gapple wants to merge 1 commit into
base: 7.x-1.x
Choose a base branch
from
Open

Cache recently used tokens for a short period #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions persistent_login.install
100755 → 100644
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,31 @@ function persistent_login_schema() {
'uid_expires' => array('uid', 'expires'),
),
);
$schema['persistent_login_cache'] = array(
'description' => "Stores recently used tokens so that multipe requests don't trigger false errors.",
'fields' => array(
'uid' => array('type' => 'int', 'unsigned' => 1, 'not null' => 1,
'description' => 'The {users}.uid this row is for.',
),
'series' => array('type' => 'varchar', 'length' => 32, 'not null' => 1,
'description' => 'The long-lived series identifying the PL token sequence.',
),
'token' => array('type' => 'varchar', 'length' => 32, 'not null' => 1,
'description' => 'The single-use PL login token.',
),
'expires' => array('type' => 'int', 'unsigned' => 1, 'not null' => 1,
'description' => 'The expiration time for this cache entry.',
),
'ip' => array('type' => 'char', 'length' => 15, 'not null' => 1,
'description' => 'The IP address used to invalidate the token.'
),
),
'primary key' => array('uid', 'series', 'token'),
'indexes' => array(
'expires' => array('expires'),
'uid_expires' => array('uid', 'expires'),
),
);
$schema['persistent_login_history'] = array(
'description' => 'Stores previous entries from the {persistent_login} table just before they are erased; currently used. The uid, series, token, and expires fields are copied verbatim.',
'fields' => array(
Expand Down Expand Up @@ -137,3 +162,39 @@ function persistent_login_update_6001() {

return $ret;
}

/**
* Add new invalidation cache table
*/
function persistent_login_update_6001() {
$ret = array();

$schema['persistent_login_cache'] = array(
'description' => "Stores recently used tokens so that multipe requests don't trigger false errors.",
'fields' => array(
'uid' => array('type' => 'int', 'unsigned' => 1, 'not null' => 1,
'description' => 'The {users}.uid this row is for.',
),
'series' => array('type' => 'varchar', 'length' => 32, 'not null' => 1,
'description' => 'The long-lived series identifying the PL token sequence.',
),
'token' => array('type' => 'varchar', 'length' => 32, 'not null' => 1,
'description' => 'The single-use PL login token.',
),
'expires' => array('type' => 'int', 'unsigned' => 1, 'not null' => 1,
'description' => 'The expiration time for this cache entry.',
),
'ip' => array('type' => 'char', 'length' => 15, 'not null' => 1,
'description' => 'The IP address used to invalidate the token.'
),
),
'primary key' => array('uid', 'series', 'token'),
'indexes' => array(
'expires' => array('expires'),
'uid_expires' => array('uid', 'expires'),
),
);
db_create_table($ret, 'persistent_login_cache', $schema['persistent_login_cache']);

return $ret;
}
65 changes: 59 additions & 6 deletions persistent_login.module
100755 → 100644
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ admin/settings/persistent_login
");

define('PERSISTENT_LOGIN_MAXLIFE', 30);
define('PERSISTENT_LOGIN_VALIDATION_PERIOD', 30);

/**
* Implementation of hook_help().
Expand Down Expand Up @@ -189,7 +190,7 @@ function persistent_login_user($op, &$edit, &$account, $category = NULL) {
// persistent_login_check(), $edit['persistent_login'] is also
// set along with pl_series and pl_expiration. Either way, issue a
// new PL cookie, preserving series and expiration if present.
if (!empty($edit['persistent_login'])) {
if (!empty($edit['persistent_login']) && empty($edit['persistent_login_cache'])) {
_persistent_login_create_cookie($account, $edit);
}
// Assume this is a non-PL login; clear persistent_login_login.
Expand Down Expand Up @@ -258,6 +259,8 @@ function persistent_login_user($op, &$edit, &$account, $category = NULL) {
*/
function persistent_login_cron() {
_persistent_login_invalidate('cron', 'expires > 0 AND expires < %d', time());

db_query("DELETE FROM {persistent_login_cache} WHERE expires < %d", time());
}

/**
Expand Down Expand Up @@ -323,17 +326,23 @@ function _persistent_login_check() {
require_once './includes/path.inc';
require_once './includes/theme.inc';

if ($r['pl_token'] === $token) {
// Delete the one-time use persistent login cookie.
_persistent_login_invalidate('used', "uid = %d AND series = '%s'", $uid, $series);

if ($r['pl_token'] === $token || _persistent_login_check_cache($uid, $series, $token)) {
// The Persistent Login cookie is valid. $r is a 'user form'
// that contains only name, uid, pl_series, pl_token, and
// pl_expires. Add persistent_login so we and other modules can
// tell what is going on.
//
$r['persistent_login'] = 1;

// Only remove the current token if it was not valid via the cache.
if(!_persistent_login_check_cache($uid, $series, $token)){
// Delete the one-time use persistent login cookie.
_persistent_login_invalidate('used', "uid = %d AND series = '%s'", $uid, $series);
}
else{
// We will need to know in hook_user('login') to not generate a new token.
$r['persistent_login_cached'] = 1;
}

// Log in the user. Use user_external_login() so all the right
// things happen. Be sure to override persistent_login_login to
// TRUE afterwards (our hook_user sets it to FALSE).
Expand Down Expand Up @@ -396,6 +405,37 @@ function _persistent_login_check() {
}
}

/**
* Helper function to check the invalidation cache for recently used tokens.
*
* A single request should only check one PL pair but use an array for
* the cache just to be safe.
*/
function _persistent_login_check_cache($uid, $series, $token, $ip = null){
static $static = array();

if ($ip == null) {$ip = ip_address();}

// A multi-dimensional array would be overkill, so concatenate for a unique string.
$key = $uid . $series . $token;

if(!isset($static[$key])){
$res =
db_result(
db_query("SELECT plc.ip FROM {persistent_login_cache} plc " .
"WHERE plc.uid = %d " .
"AND plc.series = '%s' " .
"AND plc.token = '%s' " .
"AND plc.expires < %d ",
$uid, $series, $token, time()
)
);
$static[$key] = $res;
}

return ($static[$key] == $ip);
}

/**
* Create a Persistent Login cookie.
*
Expand Down Expand Up @@ -513,6 +553,7 @@ function _persistent_login_match($path) {
}

function _persistent_login_invalidate($why, $where) {
// Any additional arguments are values for the where clause
$vals = func_get_args();
array_shift($vals);
array_shift($vals);
Expand All @@ -524,5 +565,17 @@ function _persistent_login_invalidate($why, $where) {
db_query("INSERT INTO {persistent_login_history} (uid, series, token, expires, at, why) SELECT uid, series, token, expires, %d, '%s' FROM {persistent_login} WHERE ". $where, $vals2);
}

// save used entries in a short-lifetime cache
if($why == 'used'){
$vals3 = $vals;
array_unshift($vals3,
time() + PERSISTENT_LOGIN_VALIDATION_PERIOD,
ip_address()
);

db_query("INSERT INTO {persistent_login_cache} (uid, series, token, expires, ip) " .
"SELECT uid, series, token, %d, '%s' FROM {persistent_login} WHERE ". $where, $vals3);
}

db_query('DELETE FROM {persistent_login} WHERE '. $where, $vals);
}