Gerrit Patch Uploader has uploaded a new change for review.
https://gerrit.wikimedia.org/r/180076
Change subject: Use the modernized reCaptcha API, which hopefully allows for
intervention-free verification
......................................................................
Use the modernized reCaptcha API, which hopefully allows for intervention-free
verification
This is a bit of a "quick and dirty" patch to get it to use the new API, (and
syncs with upstream plus a modification to avoid naming conflicts) which is
very simplified. While it's also there, it also removes support for the
deprecated settings.
Change-Id: I6ac403f683ea187da1afd2c4c09f7499677ddc2f
---
M ReCaptcha.class.php
M ReCaptcha.php
M recaptchalib.php
3 files changed, 131 insertions(+), 265 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/ConfirmEdit
refs/changes/76/180076/1
diff --git a/ReCaptcha.class.php b/ReCaptcha.class.php
index cd274a9..95b7f3f 100644
--- a/ReCaptcha.class.php
+++ b/ReCaptcha.class.php
@@ -10,12 +10,30 @@
*
*/
function getForm() {
- global $wgReCaptchaPublicKey, $wgReCaptchaTheme;
+ global $wgReCaptchaPublicKey;
- $useHttps = ( isset( $_SERVER['HTTPS'] ) && $_SERVER['HTTPS']
== 'on' );
- $js = 'var RecaptchaOptions = ' . Xml::encodeJsVar( array(
'theme' => $wgReCaptchaTheme, 'tabindex' => 1 ) );
-
- return Html::inlineScript( $js ) . recaptcha_get_html(
$wgReCaptchaPublicKey, $this->recaptcha_error, $useHttps );
+ return '<script src="https://www.google.com/recaptcha/api.js";
async defer></script>
+<div class="g-recaptcha" data-sitekey="' . $wgReCaptchaPublicKey . '"></div>
+<noscript>
+ <div style="width: 302px; height: 352px;">
+ <div style="width: 302px; height: 352px; position: relative;">
+ <div style="width: 302px; height: 352px; position: absolute;">
+ <iframe src="https://www.google.com/recaptcha/api/fallback?k=' .
$wgReCaptchaPublicKey . '"
+ frameborder="0" scrolling="no"
+ style="width: 302px; height:352px; border-style: none;">
+ </iframe>
+ </div>
+ <div style="width: 250px; height: 80px; position: absolute;
border-style: none;
+ bottom: 21px; left: 25px; margin: 0px; padding: 0px; right:
25px;">
+ <textarea id="g-recaptcha-response" name="g-recaptcha-response"
+ class="g-recaptcha-response"
+ style="width: 250px; height: 80px; border: 1px solid #c1c1c1;
+ margin: 0px; padding: 0px; resize: none;" value="">
+ </textarea>
+ </div>
+ </div>
+ </div>
+</noscript>';
}
/**
@@ -27,9 +45,8 @@
function passCaptcha() {
global $wgReCaptchaPrivateKey, $wgRequest;
- // API is hardwired to return wpCaptchaId and wpCaptchaWord, so
use that if the standard two are empty
- $challenge = $wgRequest->getVal( 'recaptcha_challenge_field',
$wgRequest->getVal( 'wpCaptchaId' ) );
- $response = $wgRequest->getVal( 'recaptcha_response_field',
$wgRequest->getVal( 'wpCaptchaWord' ) );
+ // API is hardwired to return wpCaptchaWord, so use that if it
is empty
+ $response = $wgRequest->getVal( 'g-recaptcha-response',
$wgRequest->getVal( 'wpCaptchaWord' ) );
if ( $response === null ) {
// new captcha session
@@ -38,15 +55,15 @@
$ip = $wgRequest->getIP();
- $recaptcha_response = recaptcha_check_answer(
- $wgReCaptchaPrivateKey,
+ $recaptcha = new ReCaptchaObject($wgReCaptchaPrivateKey);
+
+ $recaptcha_response = $recaptcha->verifyResponse(
$ip,
- $challenge,
$response
);
- if ( !$recaptcha_response->is_valid ) {
- $this->recaptcha_error = $recaptcha_response->error;
+ if ( !$recaptcha_response->success ) {
+ $this->recaptcha_error =
$recaptcha_response->errorCodes;
return false;
}
@@ -83,8 +100,7 @@
public function APIGetAllowedParams( &$module, &$params, $flags ) {
if ( $flags && $this->isAPICaptchaModule( $module ) ) {
- $params['recaptcha_challenge_field'] = null;
- $params['recaptcha_response_field'] = null;
+ $params['g-recaptcha-response'] = null;
}
return true;
@@ -92,8 +108,7 @@
public function APIGetParamDescription( &$module, &$desc ) {
if ( $this->isAPICaptchaModule( $module ) ) {
- $desc['recaptcha_challenge_field'] = 'Field from the
ReCaptcha widget';
- $desc['recaptcha_response_field'] = 'Field from the
ReCaptcha widget';
+ $desc['g-recaptcha-response'] = 'Field from the
ReCaptcha widget';
}
return true;
diff --git a/ReCaptcha.php b/ReCaptcha.php
index b474f98..fcac6dd 100644
--- a/ReCaptcha.php
+++ b/ReCaptcha.php
@@ -6,7 +6,9 @@
*
* @addtogroup Extensions
* @author Mike Crawford <[email protected]>
+ * @author Calvin Buckley <[email protected]>
* @copyright Copyright (c) 2007 reCAPTCHA -- http://recaptcha.net
+ * @copyright Copyright (c) 2014 Calvin Buckley
* @licence MIT/X11
*/
@@ -28,16 +30,6 @@
// Set these in LocalSettings.php
$wgReCaptchaPublicKey = '';
$wgReCaptchaPrivateKey = '';
-// For backwards compatibility
-$recaptcha_public_key = '';
-$recaptcha_private_key = '';
-
-/**
- * Sets the theme for ReCaptcha
- *
- * See http://code.google.com/apis/recaptcha/docs/customization.html
- */
-$wgReCaptchaTheme = 'red';
$wgExtensionFunctions[] = 'efReCaptcha';
@@ -46,20 +38,9 @@
*/
function efReCaptcha() {
global $wgReCaptchaPublicKey, $wgReCaptchaPrivateKey;
- global $recaptcha_public_key, $recaptcha_private_key;
global $wgServerName;
- // Backwards compatibility
- if ( $wgReCaptchaPublicKey == '' ) {
- $wgReCaptchaPublicKey = $recaptcha_public_key;
- }
- if ( $wgReCaptchaPrivateKey == '' ) {
- $wgReCaptchaPrivateKey = $recaptcha_private_key;
- }
-
if ( $wgReCaptchaPublicKey == '' || $wgReCaptchaPrivateKey == '' ) {
- die ( 'You need to set $wgReCaptchaPrivateKey and
$wgReCaptchaPublicKey in LocalSettings.php to ' .
- "use the reCAPTCHA plugin. You can sign up for
a key <a href='" .
- htmlentities( recaptcha_get_signup_url (
$wgServerName, "mediawiki" ) ) . "'>here</a>." );
+ die ( 'You need to set $wgReCaptchaPrivateKey and
$wgReCaptchaPublicKey in LocalSettings.php to use the reCAPTCHA plugin. You can
get one <a href="https://www.google.com/recaptcha/admin";>here</a>.' );
}
}
diff --git a/recaptchalib.php b/recaptchalib.php
index a04f567..bea3c12 100644
--- a/recaptchalib.php
+++ b/recaptchalib.php
@@ -2,16 +2,14 @@
/**
* This is a PHP library that handles calling reCAPTCHA.
* - Documentation and latest version
- * http://recaptcha.net/plugins/php/
+ * https://developers.google.com/recaptcha/docs/php
* - Get a reCAPTCHA API Key
* https://www.google.com/recaptcha/admin/create
* - Discussion group
* http://groups.google.com/group/recaptcha
*
- * Copyright (c) 2007 reCAPTCHA -- http://recaptcha.net
- * AUTHORS:
- * Mike Crawford
- * Ben Maurer
+ * @copyright Copyright (c) 2014, Google Inc.
+ * @link http://www.google.com/recaptcha
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to
deal
@@ -33,242 +31,114 @@
*/
/**
- * The reCAPTCHA server URL's
+ * A ReCaptchaResponse is returned from checkAnswer().
*/
-define( "RECAPTCHA_API_SERVER", "http://www.google.com/recaptcha/api"; );
-define( "RECAPTCHA_API_SECURE_SERVER", "https://www.google.com/recaptcha/api";
);
-define( "RECAPTCHA_VERIFY_SERVER", "www.google.com" );
+class ReCaptchaResponse
+{
+ public $success;
+ public $errorCodes;
+}
/**
- * Encodes the given data into a query string format
- * @param $data - array of string elements to be encoded
- * @return string - encoded request
+ * Note from MW extension dev: this class had its name changed from upstream
+ * to avoid conflicting with the extension's name itself
*/
-function _recaptcha_qsencode ( $data ) {
+class ReCaptchaObject
+{
+ private static $_signupUrl = "https://www.google.com/recaptcha/admin";;
+ private static $_siteVerifyUrl =
+ "https://www.google.com/recaptcha/api/siteverify?";;
+ private $_secret;
+ private static $_version = "php_1.0";
+
+ /**
+ * Constructor.
+ *
+ * @param string $secret shared secret between site and ReCAPTCHA server.
+ */
+ function ReCaptchaObject($secret)
+ {
+ if ($secret == null || $secret == "") {
+ die("To use reCAPTCHA you must get an API key from <a href='"
+ . self::$_signupUrl . "'>" . self::$_signupUrl . "</a>");
+ }
+ $this->_secret=$secret;
+ }
+
+ /**
+ * Encodes the given data into a query string format.
+ *
+ * @param array $data array of string elements to be encoded.
+ *
+ * @return string - encoded request.
+ */
+ private function _encodeQS($data)
+ {
$req = "";
- foreach ( $data as $key => $value )
- $req .= $key . '=' . urlencode( stripslashes( $value ) ) . '&';
+ foreach ($data as $key => $value) {
+ $req .= $key . '=' . urlencode(stripslashes($value)) . '&';
+ }
// Cut the last '&'
- $req = substr( $req, 0, strlen( $req ) -1 );
+ $req=substr($req, 0, strlen($req)-1);
return $req;
-}
+ }
-
-
-/**
- * Submits an HTTP POST to a reCAPTCHA server
- * @param string $host
- * @param string $path
- * @param array $data
- * @param int port
- * @return array response
- */
-function _recaptcha_http_post( $host, $path, $data, $port = 80 ) {
-
- $req = _recaptcha_qsencode ( $data );
-
- $http_request = "POST $path HTTP/1.0\r\n";
- $http_request .= "Host: $host\r\n";
- $http_request .= "Content-Type:
application/x-www-form-urlencoded;\r\n";
- $http_request .= "Content-Length: " . strlen( $req ) . "\r\n";
- $http_request .= "User-Agent: reCAPTCHA/PHP\r\n";
- $http_request .= "\r\n";
- $http_request .= $req;
-
- $response = '';
- if ( false == ( $fs = @fsockopen( $host, $port, $errno, $errstr, 10 )
) ) {
- die ( 'Could not open socket' );
- }
-
- fwrite( $fs, $http_request );
-
- while ( !feof( $fs ) )
- $response .= fgets( $fs, 1160 ); // One TCP-IP packet
- fclose( $fs );
- $response = explode( "\r\n\r\n", $response, 2 );
-
+ /**
+ * Submits an HTTP GET to a reCAPTCHA server.
+ *
+ * @param string $path url path to recaptcha server.
+ * @param array $data array of parameters to be sent.
+ *
+ * @return array response
+ */
+ private function _submitHTTPGet($path, $data)
+ {
+ $req = $this->_encodeQS($data);
+ $response = file_get_contents($path . $req);
return $response;
-}
+ }
+ /**
+ * Calls the reCAPTCHA siteverify API to verify whether the user passes
+ * CAPTCHA test.
+ *
+ * @param string $remoteIp IP address of end user.
+ * @param string $response response string from recaptcha verification.
+ *
+ * @return ReCaptchaResponse
+ */
+ public function verifyResponse($remoteIp, $response)
+ {
+ // Discard empty solution submissions
+ if ($response == null || strlen($response) == 0) {
+ $recaptchaResponse = new ReCaptchaResponse();
+ $recaptchaResponse->success = false;
+ $recaptchaResponse->errorCodes = 'missing-input';
+ return $recaptchaResponse;
+ }
+ $getResponse = $this->_submitHttpGet(
+ self::$_siteVerifyUrl,
+ array (
+ 'secret' => $this->_secret,
+ 'remoteip' => $remoteIp,
+ 'v' => self::$_version,
+ 'response' => $response
+ )
+ );
+ $answers = json_decode($getResponse, true);
+ $recaptchaResponse = new ReCaptchaResponse();
-/**
- * Gets the challenge HTML (javascript and non-javascript version).
- * This is called from the browser, and the resulting reCAPTCHA HTML widget
- * is embedded within the HTML form it was called from.
- * @param string $pubkey A public key for reCAPTCHA
- * @param string $error The error given by reCAPTCHA (optional, default is
null)
- * @param boolean $use_ssl Should the request be made over ssl? (optional,
default is false)
-
- * @return string - The HTML to be embedded in the user's form.
- */
-function recaptcha_get_html ( $pubkey, $error = null, $use_ssl = false )
-{
- if ( $pubkey == null || $pubkey == '' ) {
- die ( "To use reCAPTCHA you must get an API key from <a
href='https://www.google.com/recaptcha/admin/create'>https://www.google.com/recaptcha/admin/create</a>"
);
- }
-
- if ( $use_ssl ) {
- $server = RECAPTCHA_API_SECURE_SERVER;
+ if (trim($answers ['success']) == true) {
+ $recaptchaResponse->success = true;
} else {
- $server = RECAPTCHA_API_SERVER;
+ $recaptchaResponse->success = false;
+ $recaptchaResponse->errorCodes = $answers [error-codes];
}
- $errorpart = "";
- if ( $error ) {
- $errorpart = "&error=" . $error;
- }
- return '<script type="text/javascript" src="' . $server .
'/challenge?k=' . $pubkey . $errorpart . '"></script>
-
- <noscript>
- <iframe src="' . $server . '/noscript?k=' . $pubkey .
$errorpart . '" height="300" width="500" frameborder="0"></iframe><br/>
- <textarea name="recaptcha_challenge_field" rows="3"
cols="40"></textarea>
- <input type="hidden" name="recaptcha_response_field"
value="manual_challenge"/>
- </noscript>';
+ return $recaptchaResponse;
+ }
}
-
-
-
-/**
- * A ReCaptchaResponse is returned from recaptcha_check_answer()
- */
-class ReCaptchaResponse {
- public $is_valid;
- public $error;
-}
-
-
-/**
- * Calls an HTTP POST function to verify if the user's guess was correct
- * @param string $privkey
- * @param string $remoteip
- * @param string $challenge
- * @param string $response
- * @param array $extra_params an array of extra variables to post to the
server
- * @return ReCaptchaResponse
- */
-function recaptcha_check_answer ( $privkey, $remoteip, $challenge, $response,
$extra_params = array() )
-{
- if ( $privkey == null || $privkey == '' ) {
- die ( "To use reCAPTCHA you must get an API key from <a
href='https://www.google.com/recaptcha/admin/create'>https://www.google.com/recaptcha/admin/create</a>"
);
- }
-
- if ( $remoteip == null || $remoteip == '' ) {
- die ( "For security reasons, you must pass the remote ip to
reCAPTCHA" );
- }
-
-
-
- // discard spam submissions
- if ( $challenge == null || strlen( $challenge ) == 0 || $response ==
null || strlen( $response ) == 0 ) {
- $recaptcha_response = new ReCaptchaResponse();
- $recaptcha_response->is_valid = false;
- $recaptcha_response->error = 'incorrect-captcha-sol';
- return $recaptcha_response;
- }
-
- $response = _recaptcha_http_post ( RECAPTCHA_VERIFY_SERVER,
"/recaptcha/api/verify",
- array (
- 'privatekey' => $privkey,
- 'remoteip' => $remoteip,
- 'challenge' => $challenge,
- 'response' => $response
- ) + $extra_params
- );
-
- $answers = explode ( "\n", $response [1] );
- $recaptcha_response = new ReCaptchaResponse();
-
- if ( trim ( $answers [0] ) == 'true' ) {
- $recaptcha_response->is_valid = true;
- }
- else {
- $recaptcha_response->is_valid = false;
- $recaptcha_response->error = $answers [1];
- }
- return $recaptcha_response;
-
-}
-
-/**
- * gets a URL where the user can sign up for reCAPTCHA. If your application
- * has a configuration page where you enter a key, you should provide a link
- * using this function.
- * @param string $domain The domain where the page is hosted
- * @param string $appname The name of your application
- */
-function recaptcha_get_signup_url ( $domain = null, $appname = null ) {
- return "https://www.google.com/recaptcha/admin/create?"; .
_recaptcha_qsencode ( array ( 'domains' => $domain, 'app' => $appname ) );
-}
-
-function _recaptcha_aes_pad( $val ) {
- $block_size = 16;
- $numpad = $block_size - ( strlen ( $val ) % $block_size );
- return str_pad( $val, strlen ( $val ) + $numpad, chr( $numpad ) );
-}
-
-/* Mailhide related code */
-
-function _recaptcha_aes_encrypt( $val, $ky ) {
- if ( ! function_exists ( "mcrypt_encrypt" ) ) {
- die ( "To use reCAPTCHA Mailhide, you need to have the mcrypt
php module installed." );
- }
- $mode = MCRYPT_MODE_CBC;
- $enc = MCRYPT_RIJNDAEL_128;
- $val = _recaptcha_aes_pad( $val );
- return mcrypt_encrypt( $enc, $ky, $val, $mode,
"\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0" );
-}
-
-
-function _recaptcha_mailhide_urlbase64 ( $x ) {
- return strtr( base64_encode ( $x ), '+/', '-_' );
-}
-
-/* gets the reCAPTCHA Mailhide url for a given email, public key and private
key */
-function recaptcha_mailhide_url( $pubkey, $privkey, $email ) {
- if ( $pubkey == '' || $pubkey == null || $privkey == "" || $privkey ==
null ) {
- die ( "To use reCAPTCHA Mailhide, you have to sign up for a
public and private key, " .
- "you can do so at <a
href='http://www.google.com/recaptcha/mailhide/apikey'>http://www.google.com/recaptcha/mailhide/apikey</a>"
);
- }
-
-
- $ky = pack( 'H*', $privkey );
- $cryptmail = _recaptcha_aes_encrypt ( $email, $ky );
-
- return "http://www.google.com/recaptcha/mailhide/d?k="; . $pubkey .
"&c=" . _recaptcha_mailhide_urlbase64 ( $cryptmail );
-}
-
-/**
- * gets the parts of the email to expose to the user.
- * eg, given johndoe@example,com return ["john", "example.com"].
- * the email is then displayed as [email protected]
- */
-function _recaptcha_mailhide_email_parts ( $email ) {
- $arr = preg_split( "/@/", $email );
-
- if ( strlen ( $arr[0] ) <= 4 ) {
- $arr[0] = substr ( $arr[0], 0, 1 );
- } elseif ( strlen ( $arr[0] ) <= 6 ) {
- $arr[0] = substr ( $arr[0], 0, 3 );
- } else {
- $arr[0] = substr ( $arr[0], 0, 4 );
- }
- return $arr;
-}
-
-/**
- * Gets html to display an email address given a public an private key.
- * to get a key, go to:
- *
- * http://www.google.com/recaptcha/mailhide/apikey
- */
-function recaptcha_mailhide_html( $pubkey, $privkey, $email ) {
- $emailparts = _recaptcha_mailhide_email_parts ( $email );
- $url = recaptcha_mailhide_url ( $pubkey, $privkey, $email );
-
- return htmlentities( $emailparts[0] ) . "<a href='" . htmlentities (
$url ) .
- "' onclick=\"window.open('" . htmlentities ( $url ) . "', '',
'toolbar=0,scrollbars=0,location=0,statusbar=0,menubar=0,resizable=0,width=500,height=300');
return false;\" title=\"Reveal this e-mail address\">...</a>@" . htmlentities
( $emailparts [1] );
-
-}
+?>
--
To view, visit https://gerrit.wikimedia.org/r/180076
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I6ac403f683ea187da1afd2c4c09f7499677ddc2f
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/ConfirmEdit
Gerrit-Branch: master
Gerrit-Owner: Gerrit Patch Uploader <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
