<?php
+
/**
* Experimental captcha plugin framework.
* Not intended as a real production captcha system; derived classes
* can extend the base to produce their fancy images in place of the
* text-based test output here.
*
- * Copyright (C) 2005, 2006 Brion Vibber <brion@pobox.com>
+ * Copyright (C) 2005-2007 Brion Vibber <brion@wikimedia.org>
* http://www.mediawiki.org/
*
* This program is free software; you can redistribute it and/or modify
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* http://www.gnu.org/copyleft/gpl.html
*
- * @package MediaWiki
- * @subpackage Extensions
+ * @addtogroup Extensions
*/
if ( defined( 'MEDIAWIKI' ) ) {
$wgExtensionCredits['other'][] = array(
'name' => 'ConfirmEdit',
'author' => 'Brion Vibber',
- 'url' => 'http://meta.wikimedia.org/wiki/ConfirmEdit_extension',
+ 'url' => 'http://www.mediawiki.org/wiki/Extension:ConfirmEdit',
'description' => 'Simple captcha implementation',
);
$wgCaptchaClass = 'SimpleCaptcha';
/**
- * Currently the captcha works only for page edits.
+ * Actions which can trigger a captcha
*
* If the 'edit' trigger is on, *every* edit will trigger the captcha.
* This may be useful for protecting against vandalbot attacks.
* edits that include URLs that aren't in the current version of the page.
* This should catch automated linkspammers without annoying people when
* they make more typical edits.
+ *
+ * The captcha code should not use $wgCaptchaTriggers, but CaptchaTriggers()
+ * which also takes into account per namespace triggering.
*/
$wgCaptchaTriggers = array();
$wgCaptchaTriggers['edit'] = false; // Would check on every edit
+$wgCaptchaTriggers['create'] = false; // Check on page creation.
$wgCaptchaTriggers['addurl'] = true; // Check on edits that add URLs
$wgCaptchaTriggers['createaccount'] = true; // Special:Userlogin&type=signup
+$wgCaptchaTriggers['badlogin'] = true; // Special:Userlogin after failure
+
+/**
+ * You may wish to apply special rules for captcha triggering on some namespaces.
+ * $wgCaptchaTriggersOnNamespace[<namespace id>][<trigger>] forces an always on /
+ * always off configuration with that trigger for the given namespace.
+ * Leave unset to use the global options ($wgCaptchaTriggers).
+ *
+ * Shall not be used with 'createaccount' (it is not checked).
+ */
+$wgCaptchaTriggersOnNamespace = array();
+
+#Example:
+#$wgCaptchaTriggersOnNamespace[NS_TALK]['create'] = false; //Allow creation of talk pages without captchas.
+#$wgCaptchaTriggersOnNamespace[NS_PROJECT]['edit'] = true; //Show captcha whenever editing Project pages.
+
+/**
+ * Indicate how to store per-session data required to match up the
+ * internal captcha data with the editor.
+ *
+ * 'CaptchaSessionStore' uses PHP's session storage, which is cookie-based
+ * and may fail for anons with cookies disabled.
+ *
+ * 'CaptchaCacheStore' uses $wgMemc, which avoids the cookie dependency
+ * but may be fragile depending on cache configuration.
+ */
+global $wgCaptchaStorageClass;
+$wgCaptchaStorageClass = 'CaptchaSessionStore';
+
+/**
+ * Number of seconds a captcha session should last in the data cache
+ * before expiring when managing through CaptchaCacheStore class.
+ *
+ * Default is a half hour.
+ */
+global $wgCaptchaSessionExpiration;
+$wgCaptchaSessionExpiration = 30 * 60;
+/**
+ * Number of seconds after a bad login that a captcha will be shown to
+ * that client on the login form to slow down password-guessing bots.
+ *
+ * Has no effect if 'badlogin' is disabled in $wgCaptchaTriggers or
+ * if there is not a caching engine enabled.
+ *
+ * Default is five minutes.
+ */
+global $wgCaptchaBadLoginExpiration;
+$wgCaptchaBadLoginExpiration = 5 * 60;
/**
* Allow users who have confirmed their e-mail addresses to post
* Regex to whitelist URLs to known-good sites...
* For instance:
* $wgCaptchaWhitelist = '#^https?://([a-z0-9-]+\\.)?(wikimedia|wikipedia)\.org/#i';
- * @fixme Use the 'spam-whitelist' thingy instead?
+ * Local admins can define a whitelist under [[MediaWiki:captcha-addurl-whitelist]]
*/
$wgCaptchaWhitelist = false;
$wgHooks['UserCreateForm'][] = array( &$wgCaptcha, 'injectUserCreate' );
$wgHooks['AbortNewAccount'][] = array( &$wgCaptcha, 'confirmUserCreate' );
+
+ $wgHooks['LoginAuthenticateAudit'][] = array( &$wgCaptcha, 'triggerUserLogin' );
+ $wgHooks['UserLoginForm'][] = array( &$wgCaptcha, 'injectUserLogin' );
+ $wgHooks['AbortLogin'][] = array( &$wgCaptcha, 'confirmUserLogin' );
+
+ global $wgGroupPermissions, $wgCaptchaTriggers;
+ if( !$wgGroupPermissions['*']['read'] && $wgCaptchaTriggers['badlogin'] ) {
+ // We need to ensure that the captcha interface is accessible
+ // so that unauthenticated users can actually get in after a
+ // mistaken password typing.
+ global $wgWhitelistRead;
+ $image = Title::makeTitle( NS_SPECIAL, 'Captcha/image' );
+ $help = Title::makeTitle( NS_SPECIAL, 'Captcha/help' );
+ $wgWhitelistRead[] = $image->getPrefixedText();
+ $wgWhitelistRead[] = $help->getPrefixedText();
+ }
}
/**
}
class SimpleCaptcha {
+ function SimpleCaptcha() {
+ global $wgCaptchaStorageClass;
+ $this->storage = new $wgCaptchaStorageClass;
+ }
+
/**
* Insert a captcha prompt into the edit form.
* This sample implementation generates a simple arithmetic operation;
* @param OutputPage $out
*/
function editCallback( &$out ) {
- $out->addWikiText( $this->getMessage( 'edit' ) );
+ $out->addWikiText( $this->getMessage( $this->action ) );
$out->addHTML( $this->getForm() );
}
return true;
}
+ /**
+ * Inject a captcha into the user login form after a failed
+ * password attempt as a speedbump for mass attacks.
+ * @fixme if multiple thingies insert a header, could break
+ * @param SimpleTemplate $template
+ * @return bool true to keep running callbacks
+ */
+ function injectUserLogin( &$template ) {
+ if( $this->isBadLoginTriggered() ) {
+ global $wgOut;
+ $template->set( 'header',
+ "<div class='captcha'>" .
+ $wgOut->parse( $this->getMessage( 'badlogin' ) ) .
+ $this->getForm() .
+ "</div>\n" );
+ }
+ return true;
+ }
+
+ /**
+ * When a bad login attempt is made, increment an expiring counter
+ * in the memcache cloud. Later checks for this may trigger a
+ * captcha display to prevent too many hits from the same place.
+ * @param User $user
+ * @param string $password
+ * @param int $retval authentication return value
+ * @return bool true to keep running callbacks
+ */
+ function triggerUserLogin( $user, $password, $retval ) {
+ global $wgCaptchaTriggers, $wgCaptchaBadLoginExpiration, $wgMemc;
+ if( $retval == LoginForm::WRONG_PASS && $wgCaptchaTriggers['badlogin'] ) {
+ $key = $this->badLoginKey();
+ $count = $wgMemc->get( $key );
+ if( !$count ) {
+ $wgMemc->add( $key, 0, $wgCaptchaBadLoginExpiration );
+ }
+ $count = $wgMemc->incr( $key );
+ }
+ return true;
+ }
+
+ /**
+ * Check if a bad login has already been registered for this
+ * IP address. If so, require a captcha.
+ * @return bool
+ * @access private
+ */
+ function isBadLoginTriggered() {
+ global $wgMemc;
+ return intval( $wgMemc->get( $this->badLoginKey() ) ) > 0;
+ }
+
+ /**
+ * Internal cache key for badlogin checks.
+ * @return string
+ * @access private
+ */
+ function badLoginKey() {
+ return wfMemcKey( 'captcha', 'badlogin', 'ip', wfGetIP() );
+ }
+
/**
* Check if the submitted form matches the captcha session data provided
* by the plugin when the form was generated.
// ----------------------------------
+ /**
+ * @param EditPage $editPage
+ * @param string $action (edit/create/addurl...)
+ * @return bool true if action triggers captcha on editPage's namespace
+ */
+ function captchaTriggers( &$editPage, $action) {
+ global $wgCaptchaTriggers, $wgCaptchaTriggersOnNamespace;
+ //Special config for this NS?
+ if (isset( $wgCaptchaTriggersOnNamespace[$editPage->mTitle->getNamespace()][$action] ) )
+ return $wgCaptchaTriggersOnNamespace[$editPage->mTitle->getNamespace()][$action];
+
+ return ( !empty( $wgCaptchaTriggers[$action] ) ); //Default
+ }
+
+
/**
* @param EditPage $editPage
* @param string $newtext
return false;
}
- global $wgCaptchaTriggers;
- if( !empty( $wgCaptchaTriggers['edit'] ) ) {
+ if( $this->captchaTriggers( $editPage, 'edit' ) ) {
// Check on all edits
global $wgUser, $wgTitle;
$this->trigger = sprintf( "edit trigger by '%s' at [[%s]]",
$wgUser->getName(),
$wgTitle->getPrefixedText() );
+ $this->action = 'edit';
wfDebug( "ConfirmEdit: checking all edits...\n" );
return true;
}
- if( !empty( $wgCaptchaTriggers['addurl'] ) ) {
+ if( $this->captchaTriggers( $editPage, 'create' ) && !$editPage->mTitle->exists() ) {
+ //Check if creating a page
+ global $wgUser, $wgTitle;
+ $this->trigger = sprintf( "Create trigger by '%s' at [[%s]]",
+ $wgUser->getName(),
+ $wgTitle->getPrefixedText() );
+ $this->action = 'create';
+ wfDebug( "ConfirmEdit: checking on page creation...\n" );
+ return true;
+ }
+
+ if( $this->captchaTriggers( $editPage, 'addurl' ) ) {
// Only check edits that add URLs
$oldtext = $this->loadText( $editPage, $section );
$wgUser->getName(),
$wgTitle->getPrefixedText(),
implode( ", ", $addedLinks ) );
+ $this->action = 'addurl';
return true;
}
}
$wgUser->getName(),
$wgTitle->getPrefixedText(),
implode( ", ", $addedMatches ) );
+ $this->action = 'edit';
return true;
}
}
/**
* Filter callback function for URL whitelisting
+ * @param string url to check
* @return bool true if unknown, false if whitelisted
* @access private
*/
function filterLink( $url ) {
global $wgCaptchaWhitelist;
- return !( $wgCaptchaWhitelist && preg_match( $wgCaptchaWhitelist, $url ) );
+ $source = wfMsgForContent( 'captcha-addurl-whitelist' );
+
+ $whitelist = wfEmptyMsg( 'captcha-addurl-whitelist', $source )
+ ? false
+ : $this->buildRegexes( explode( "\n", $source ) );
+
+ $cwl = $wgCaptchaWhitelist !== false ? preg_match( $wgCaptchaWhitelist, $url ) : false;
+ $wl = $whitelist !== false ? preg_match( $whitelist, $url ) : false;
+
+ return !( $cwl || $wl );
+ }
+
+ /**
+ * Build regex from whitelist
+ * @param string lines from [[MediaWiki:Captcha-addurl-whitelist]]
+ * @return string Regex or bool false if whitelist is empty
+ * @access private
+ */
+ function buildRegexes( $lines ) {
+ # Code duplicated from the SpamBlacklist extension (r19197)
+
+ # Strip comments and whitespace, then remove blanks
+ $lines = array_filter( array_map( 'trim', preg_replace( '/#.*$/', '', $lines ) ) );
+
+ # No lines, don't make a regex which will match everything
+ if ( count( $lines ) == 0 ) {
+ wfDebug( "No lines\n" );
+ return false;
+ } else {
+ # Make regex
+ # It's faster using the S modifier even though it will usually only be run once
+ //$regex = 'http://+[a-z0-9_\-.]*(' . implode( '|', $lines ) . ')';
+ //return '/' . str_replace( '/', '\/', preg_replace('|\\\*/|', '/', $regex) ) . '/Si';
+ $regexes = '';
+ $regexStart = '/http:\/\/+[a-z0-9_\-.]*(';
+ $regexEnd = ')/Si';
+ $regexMax = 4096;
+ $build = false;
+ foreach( $lines as $line ) {
+ // FIXME: not very robust size check, but should work. :)
+ if( $build === false ) {
+ $build = $line;
+ } elseif( strlen( $build ) + strlen( $line ) > $regexMax ) {
+ $regexes .= $regexStart .
+ str_replace( '/', '\/', preg_replace('|\\\*/|', '/', $build) ) .
+ $regexEnd;
+ $build = $line;
+ } else {
+ $build .= '|' . $line;
+ }
+ }
+ if( $build !== false ) {
+ $regexes .= $regexStart .
+ str_replace( '/', '\/', preg_replace('|\\\*/|', '/', $build) ) .
+ $regexEnd;
+ }
+ return $regexes;
+ }
}
/**
return false;
}
} else {
- wfDebug( "ConfirmEdit: no new links.\n" );
+ wfDebug( "ConfirmEdit: no need to show captcha.\n" );
return true;
}
}
}
return true;
}
+
+ /**
+ * Hook for user login form submissions.
+ * @param User $u
+ * @param string $message
+ * @return bool true to continue, false to abort user creation
+ */
+ function confirmUserLogin( $u, $pass, &$retval ) {
+ if( $this->isBadLoginTriggered() ) {
+ $this->trigger = "post-badlogin login '" . $u->getName() . "'";
+ if( !$this->passCaptcha() ) {
+ $message = wfMsg( 'captcha-badlogin-fail' );
+ // Emulate a bad-password return to confuse the shit out of attackers
+ $retval = LoginForm::WRONG_PASS;
+ return false;
+ }
+ }
+ return true;
+ }
/**
* Given a required captcha run, test form input for correct
// Assign random index if we're not udpating
$info['index'] = strval( mt_rand() );
}
- $_SESSION['captcha' . $info['index']] = $info;
+ $this->storage->store( $info['index'], $info );
return $info['index'];
}
function retrieveCaptcha() {
global $wgRequest;
$index = $wgRequest->getVal( 'wpCaptchaId' );
- if( isset( $_SESSION['captcha' . $index] ) ) {
- return $_SESSION['captcha' . $index];
- } else {
- return false;
- }
+ return $this->storage->retrieve( $index );
}
/**
* it can't be reused.
*/
function clearCaptcha( $info ) {
- unset( $_SESSION['captcha' . $info['index']] );
+ $this->storage->clear( $info['index'] );
}
/**
global $wgOut, $ceAllowConfirmedEmail;
$wgOut->setPageTitle( wfMsg( 'captchahelp-title' ) );
$wgOut->addWikiText( wfMsg( 'captchahelp-text' ) );
+ if ( $this->storage->cookiesNeeded() ) {
+ $wgOut->addWikiText( wfMsg( 'captchahelp-cookies-needed' ) );
+ }
}
}
+class CaptchaSessionStore {
+ function store( $index, $info ) {
+ $_SESSION['captcha' . $info['index']] = $info;
+ }
+
+ function retrieve( $index ) {
+ if( isset( $_SESSION['captcha' . $index] ) ) {
+ return $_SESSION['captcha' . $index];
+ } else {
+ return false;
+ }
+ }
+
+ function clear( $index ) {
+ unset( $_SESSION['captcha' . $index] );
+ }
+
+ function cookiesNeeded() {
+ return true;
+ }
+}
+
+class CaptchaCacheStore {
+ function store( $index, $info ) {
+ global $wgMemc, $wgCaptchaSessionExpiration;
+ $wgMemc->set( wfMemcKey( 'captcha', $index ), $info,
+ $wgCaptchaSessionExpiration );
+ }
+
+ function retrieve( $index ) {
+ global $wgMemc;
+ $info = $wgMemc->get( wfMemcKey( 'captcha', $index ) );
+ if( $info ) {
+ return $info;
+ } else {
+ return false;
+ }
+ }
+
+ function clear( $index ) {
+ global $wgMemc;
+ $wgMemc->delete( wfMemcKey( 'captcha', $index ) );
+ }
+
+ function cookiesNeeded() {
+ return false;
+ }
+}
+
} # End invocation guard
-?>
+
ToastFreeware / toast / cookiecaptcha.git / blobdiff