*
* API for MediaWiki 1.8+
*
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Copyright (C) 2006-2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com,
+ * Daniel Cannon (cannon dot danielc at gmail dot com)
*
* 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
}
/**
+ * Unit to authenticate log-in attempts to the current wiki.
+ *
* @addtogroup API
*/
class ApiLogin extends ApiBase {
-
+
+ /**
+ * The amount of time a user must wait after submitting
+ * a bad login (will be multiplied by the THROTTLE_FACTOR for each bad attempt)
+ */
+ const THROTTLE_TIME = 10;
+
+ /**
+ * The factor by which the wait-time in between authentication
+ * attempts is increased every failed attempt.
+ */
+ const THROTTLE_FACTOR = 1.5;
+
+ /**
+ * The maximum number of failed logins after which the wait increase stops.
+ */
+ const THOTTLE_MAX_COUNT = 10;
+
public function __construct($main, $action) {
parent :: __construct($main, $action, 'lg');
}
+ /**
+ * Executes the log-in attempt using the parameters passed. If
+ * the log-in succeeeds, it attaches a cookie to the session
+ * and outputs the user id, username, and session token. If a
+ * log-in fails, as the result of a bad password, a nonexistant
+ * user, or any other reason, the host is cached with an expiry
+ * and no log-in attempts will be accepted until that expiry
+ * is reached. The expiry is $this->mLoginThrottle.
+ *
+ * @access public
+ */
public function execute() {
$name = $password = $domain = null;
extract($this->extractRequestParams());
$result = array ();
+ $nextLoginIn = $this->getNextLoginTimeout();
+ if ($nextLoginIn > 0) {
+ $result['result'] = 'NeedToWait';
+ $result['details'] = "Please wait $nextLoginIn seconds before next log-in attempt";
+ $result['wait'] = $nextLoginIn;
+ $this->getResult()->addValue(null, 'login', $result);
+ return;
+ }
+
$loginForm = new LoginForm($params);
switch ($loginForm->authenticateUserData()) {
case LoginForm :: SUCCESS :
ApiBase :: dieDebug(__METHOD__, 'Unhandled case value');
}
+ if ($result['result'] != 'Success') {
+ $result['wait'] = $this->cacheBadLogin();
+ }
+ // if we were allowed to try to login, memcache is fine
+
$this->getResult()->addValue(null, 'login', $result);
}
+
+ /**
+ * Caches a bad-login attempt associated with the host and with an
+ * expiry of $this->mLoginThrottle. These are cached by a key
+ * separate from that used by the captcha system--as such, logging
+ * in through the standard interface will get you a legal session
+ * and cookies to prove it, but will not remove this entry.
+ *
+ * Returns the number of seconds until next login attempt will be allowed.
+ *
+ * @access private
+ */
+ private function cacheBadLogin() {
+ global $wgMemc;
+
+ $key = $this->getMemCacheKey();
+ $val =& $wgMemc->get( $key );
+
+ $val['lastReqTime'] = time();
+ if (!isset($val['count'])) {
+ $val['count'] = 1;
+ } else {
+ $val['count'] = 1 + $val['count'];
+ }
+
+ $delay = ApiLogin::calculateDelay($val);
+
+ $wgMemc->delete($key);
+ $wgMemc->add( $key, $val, $delay );
+
+ return $delay;
+ }
+
+ /**
+ * How much time the client must wait before it will be
+ * allowed to try to log-in next.
+ * The return value is 0 if no wait is required.
+ */
+ private function getNextLoginTimeout() {
+ global $wgMemc;
+
+ $val = $wgMemc->get($this->getMemCacheKey());
+
+ $elapse = (time() - $val['lastReqTime']) / 1000; // in seconds
+ $canRetryIn = ApiLogin::calculateDelay($val) - $elapse;
+ $canRetryIn = $canRetryIn < 0 ? 0 : $canRetryIn;
+
+ return $canRetryIn;
+ }
+
+ /**
+ * Based on the number of previously attempted logins, returns
+ * the delay (in seconds) when the next login attempt will be allowed.
+ */
+ private static function calculateDelay($val) {
+ // Defensive programming
+ $count = $val['count'];
+ $count = $count < 1 ? 1 : $count;
+ $count = $count > self::THOTTLE_MAX_COUNT ? self::THOTTLE_MAX_COUNT : $count;
+
+ return self::THROTTLE_TIME + self::THROTTLE_TIME * ($count - 1) * self::THROTTLE_FACTOR;
+ }
+
+ /**
+ * Internal cache key for badlogin checks. Robbed from the
+ * ConfirmEdit extension and modified to use a key unique to the
+ * API login.3
+ *
+ * @return string
+ * @access private
+ */
+ private function getMemCacheKey() {
+ return wfMemcKey( 'apilogin', 'badlogin', 'ip', wfGetIP() );
+ }
+
protected function getAllowedParams() {
return array (
'name' => null,
protected function getDescription() {
return array (
- 'This module is used to login and get the authentication tokens.'
+ 'This module is used to login and get the authentication tokens. ' .
+ 'In the event of a successful log-in, a cookie will be attached ' .
+ 'to your session. In the event of a failed log-in, you will not ' .
+ 'be able to attempt another log-in through this method for 60 ' .
+ 'seconds--this is to prevent its use in aiding automated password ' .
+ 'crackers.'
);
}
/**
* At how many bytes should we compress?
*
- * @var interger
+ * @var integer
* @access private
*/
var $_compress_threshold;
/**
* Total # of bit buckets we have
*
- * @var interger
+ * @var integer
* @access private
*/
var $_bucketcount;
/**
* # of total servers we have
*
- * @var interger
+ * @var integer
* @access private
*/
var $_active;
* Adds a key/value to the memcache server if one isn't already set with
* that key
*
- * @param string $key Key to set with data
- * @param mixed $val Value to store
- * @param interger $exp (optional) Time to expire data at
+ * @param string $key Key to set with data
+ * @param mixed $val Value to store
+ * @param integer $exp (optional) Time to expire data at
*
* @return boolean
* @access public
* Decriment a value stored on the memcache server
*
* @param string $key Key to decriment
- * @param interger $amt (optional) Amount to decriment
+ * @param integer $amt (optional) Amount to decriment
*
* @return mixed FALSE on failure, value on success
* @access public
* Deletes a key from the server, optionally after $time
*
* @param string $key Key to delete
- * @param interger $time (optional) How long to wait before deleting
+ * @param integer $time (optional) How long to wait before deleting
*
* @return boolean TRUE on success, FALSE on failure
* @access public
* Increments $key (optionally) by $amt
*
* @param string $key Key to increment
- * @param interger $amt (optional) amount to increment
+ * @param integer $amt (optional) amount to increment
*
- * @return interger New key value?
+ * @return integer New key value?
* @access public
*/
function incr ($key, $amt=1)
*
* @param string $key Key to set value as
* @param mixed $value Value to store
- * @param interger $exp (optional) Experiation time
+ * @param integer $exp (optional) Experiation time
*
* @return boolean
* @access public
*
* @param string $key Key to set value as
* @param mixed $value Value to set
- * @param interger $exp (optional) Experiation time
+ * @param integer $exp (optional) Experiation time
*
* @return boolean TRUE on success
* @access public
/**
* Sets the compression threshold
*
- * @param interger $thresh Threshold to compress if larger than
+ * @param integer $thresh Threshold to compress if larger than
*
* @access public
*/
/**
* Connects $sock to $host, timing out after $timeout
*
- * @param interger $sock Socket to connect
+ * @param integer $sock Socket to connect
* @param string $host Host:IP to connect to
*
* @return boolean
// {{{ _hashfunc()
/**
- * Creates a hash interger based on the $key
+ * Creates a hash integer based on the $key
*
* @param string $key Key to hash
*
- * @return interger Hash value
+ * @return integer Hash value
* @access private
*/
function _hashfunc ($key)
*
* @param string $cmd Command to perform
* @param string $key Key to perform it on
- * @param interger $amt Amount to adjust
+ * @param integer $amt Amount to adjust
*
- * @return interger New value of $key
+ * @return integer New value of $key
* @access private
*/
function _incrdecr ($cmd, $key, $amt=1)
* @param string $cmd Command to perform
* @param string $key Key to act on
* @param mixed $val What we need to store
- * @param interger $exp When it should expire
+ * @param integer $exp When it should expire
*
* @return boolean
* @access private
dépôts / lhc / web / wiklou.git / commitdiff