recaptchalib.php

   1 <?php
   2 /*
   3  * This is a PHP library that handles calling reCAPTCHA.
   4  *    - Documentation and latest version
   5  *          http://recaptcha.net/plugins/php/
   6  *    - Get a reCAPTCHA API Key
   7  *          http://recaptcha.net/api/getkey
   8  *    - Discussion group
   9  *          http://groups.google.com/group/recaptcha
  10  *
  11  * Copyright (c) 2007 reCAPTCHA -- http://recaptcha.net
  12  * AUTHORS:
  13  *   Mike Crawford
  14  *   Ben Maurer
  15  *
  16  * Permission is hereby granted, free of charge, to any person obtaining a copy
  17  * of this software and associated documentation files (the "Software"), to deal
  18  * in the Software without restriction, including without limitation the rights
  19  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  20  * copies of the Software, and to permit persons to whom the Software is
  21  * furnished to do so, subject to the following conditions:
  22  *
  23  * The above copyright notice and this permission notice shall be included in
  24  * all copies or substantial portions of the Software.
  25  *
  26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  27  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  28  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  29  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  30  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  31  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  32  * THE SOFTWARE.
  33  */
  34
  35 /**
  36  * The reCAPTCHA server URL's
  37  */
  38 $recaptcha_api_server = 'http://api.recaptcha.net';
  39 $recaptcha_api_secure_server = 'https://api-secure.recaptcha.net';
  40 $recaptcha_verify_server = 'api-verify.recaptcha.net';
  41
  42
  43 /**
  44  * Encodes the given data into a query string format
  45  * @param $data - array of string elements to be encoded
  46  * @return string - encoded request
  47  */
  48 function _recaptcha_qsencode ($data) {
  49         $req = "";
  50         foreach ( $data as $key => $value )
  51                 $req .= $key . '=' . urlencode( stripslashes($value) ) . '&';
  52
  53         // Cut the last '&'
  54         $req=substr($req,0,strlen($req)-1);
  55         return $req;
  56 }
  57
  58
  59
  60 /**
  61  * Submits an HTTP POST to a reCAPTCHA server
  62  * @param string $host
  63  * @param string $path
  64  * @param array $data
  65  * @param int port
  66  * @return array response
  67  */
  68 function _recaptcha_http_post($host, $path, $data, $port = 80) {
  69
  70         $req = _recaptcha_qsencode ($data);
  71
  72         $http_request  = "POST $path HTTP/1.0\r\n";
  73         $http_request .= "Host: $host\r\n";
  74         $http_request .= "Content-Type: application/x-www-form-urlencoded;\r\n";
  75         $http_request .= "Content-Length: " . strlen($req) . "\r\n";
  76         $http_request .= "User-Agent: reCAPTCHA/PHP\r\n";
  77         $http_request .= "\r\n";
  78         $http_request .= $req;
  79
  80         $response = '';
  81         if( false == ( $fs = @fsockopen($host, $port, $errno, $errstr, 10) ) ) {
  82                 die ('Could not open socket');
  83         }
  84
  85         fwrite($fs, $http_request);
  86
  87         while ( !feof($fs) )
  88                 $response .= fgets($fs, 1160); // One TCP-IP packet
  89         fclose($fs);
  90         $response = explode("\r\n\r\n", $response, 2);
  91
  92         return $response;
  93 }
  94
  95 /**
  96  * Gets the challenge HTML (javascript and non-javascript version).
  97  * This is called from the browser, and the resulting reCAPTCHA HTML widget
  98  * is embedded within the HTML form it was called from.
  99  * @param string $pubkey A public key for reCAPTCHA
 100  * @param string $error The error given by reCAPTCHA (optional, default is null)
 101  * @param boolean $use_ssl Should the request be made over ssl? (optional, default is false)
 102
 103  * @return string - The HTML to be embedded in the user's form.
 104  */
 105 function recaptcha_get_html ($pubkey, $error = null, $use_ssl = false)
 106 {
 107         global $recaptcha_api_server, $recaptcha_api_ssl_server;
 108
 109         if ($pubkey == null || $pubkey == '') {
 110                 die ("To use reCAPTCHA you must get an API key from <a href='http://recaptcha.net/api/getkey'>http://recaptcha.net/api/getkey</a>");
 111         }
 112
 113         if ($use_ssl) {
 114            $server = $recaptcha_api_ssl_server;
 115         } else {
 116            $server = $recaptcha_api_server;
 117         }
 118         $errorpart = "";
 119         if ($error) {
 120            $errorpart = "&amp;error=" . $error;
 121         }
 122         return '<script type="text/javascript" src="'. $server . '/challenge?k=' . $pubkey . $errorpart . '"></script>
 123
 124         <noscript>
 125                 <iframe src="'. $server . '/noscript?k=' . $pubkey . $errorpart . '" height="300" width="500" frameborder="0"></iframe><br>
 126                 <textarea name="recaptcha_challenge_field" rows="3" cols="40"></textarea>
 127                 <input type="hidden" name="recaptcha_response_field" value="manual_challenge">
 128         </noscript>';
 129 }
 130
 131 /**
 132  * A ReCaptchaResponse is returned from recaptcha_check_answer()
 133  */
 134 class ReCaptchaResponse {
 135         var $is_valid;
 136         var $error;
 137 }
 138
 139 /**
 140   * Calls an HTTP POST function to verify if the user's guess was correct
 141   * @param string $privkey
 142   * @param string $remoteip
 143   * @param string $challenge
 144   * @param string $response
 145   * @return ReCaptchaResponse
 146   */
 147 function recaptcha_check_answer ($privkey, $remoteip, $challenge, $response)
 148 {
 149         if ($privkey == null || $privkey == '') {
 150                 die ("To use reCAPTCHA you must get an API key from <a href='http://recaptcha.net/api/getkey'>http://recaptcha.net/api/getkey</a>");
 151         }
 152
 153         if ($remoteip == null || $remoteip == '') {
 154                 die ("For security reasons, you must pass the remote ip to reCAPTCHA");
 155         }
 156
 157         //discard spam submissions
 158         if ($challenge == null || strlen($challenge) == 0 || $response == null || strlen($response) == 0) {
 159                 $recaptcha_response = new ReCaptchaResponse();
 160                 $recaptcha_response->is_valid = false;
 161                 $recaptcha_response->error = 'incorrect-captcha-sol';
 162                 return $recaptcha_response;
 163         }
 164
 165         global $recaptcha_verify_server;
 166         $response = _recaptcha_http_post ($recaptcha_verify_server, "/verify",
 167                                           array (
 168                                                  'privatekey' => $privkey,
 169                                                  'remoteip' => $remoteip,
 170                                                  'challenge' => $challenge,
 171                                                  'response' => $response
 172                                                  )
 173                                           );
 174
 175         $answers = explode ("\n", $response [1]);
 176         $recaptcha_response = new ReCaptchaResponse();
 177
 178         if (trim ($answers [0]) == 'true') {
 179                 $recaptcha_response->is_valid = true;
 180         }
 181         else {
 182                 $recaptcha_response->is_valid = false;
 183                 $recaptcha_response->error = $answers [1];
 184         }
 185         return $recaptcha_response;
 186
 187 }
 188
 189 /**
 190  * gets a URL where the user can sign up for reCAPTCHA. If your application
 191  * has a configuration page where you enter a key, you should provide a link
 192  * using this function.
 193  * @param string $domain The domain where the page is hosted
 194  * @param string $appname The name of your application
 195  */
 196 function recaptcha_get_signup_url ($domain = null, $appname = null) {
 197         return "http://recaptcha.net/api/getkey?" .  _recaptcha_qsencode (array ('domain' => $domain, 'app' => $appname));
 198 }
 199
 200 /* Mailhide related code */
 201
 202 function _recaptcha_aes_encrypt($val,$ky) {
 203         if (! function_exists ("mcrypt_encrypt")) {
 204                 die ("To use reCAPTCHA Mailhide, you need to have the mcrypt php module installed.");
 205         }
 206         $mode=MCRYPT_MODE_CBC;
 207         $enc=MCRYPT_RIJNDAEL_128;
 208         $val=str_pad($val, (16*(floor(strlen($val) / 16)+(strlen($val) % 16==0?2:1))), chr(16-(strlen($val) % 16)));
 209         return mcrypt_encrypt($enc, $ky, $val, $mode, "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0");
 210 }
 211
 212
 213 function _recaptcha_mailhide_urlbase64 ($x) {
 214         return strtr(base64_encode ($x), '+/', '-_');
 215 }
 216
 217 /* gets the reCAPTCHA Mailhide url for a given email, public key and private key */
 218 function recaptcha_mailhide_url($pubkey, $privkey, $email) {
 219         if ($pubkey == '' || $pubkey == null || $privkey == "" || $privkey == null) {
 220                 die ("To use reCAPTCHA Mailhide, you have to sign up for a public and private key, " .
 221                      "you can do so at <a href='http://mailhide.recaptcha.net/apikey'>http://mailhide.recaptcha.net/apikey</a>");
 222         }
 223
 224         $ky = pack('H*', $privkey);
 225         $cryptmail = _recaptcha_aes_encrypt ($email, $ky);
 226
 227         return "http://mailhide.recaptcha.net/d?k=" . $pubkey . "&c=" . _recaptcha_mailhide_urlbase64 ($cryptmail);
 228 }
 229
 230 /**
 231  * gets the parts of the email to expose to the user.
 232  * eg, given johndoe@example,com return ["john", "example.com"].
 233  * the email is then displayed as john...@example.com
 234  */
 235 function _recaptcha_mailhide_email_parts ($email) {
 236         $arr = preg_split("/@/", $email );
 237
 238         if (strlen ($arr[0]) <= 4) {
 239                 $arr[0] = substr ($arr[0], 0, 1);
 240         } elseif (strlen ($arr[0]) <= 6) {
 241                 $arr[0] = substr ($arr[0], 0, 3);
 242         } else {
 243                 $arr[0] = substr ($arr[0], 0, 4);
 244         }
 245         return $arr;
 246 }
 247
 248 /**
 249  * Gets html to display an email address given a public an private key.
 250  * to get a key, go to:
 251  *
 252  * http://mailhide.recaptcha.net/apikey
 253  */
 254 function recaptcha_mailhide_html($pubkey, $privkey, $email) {
 255         $emailparts = _recaptcha_mailhide_email_parts ($email);
 256         $url = recaptcha_mailhide_url ($pubkey, $privkey, $email);
 257
 258         return htmlentities($emailparts[0]) . "<a href='" . htmlentities ($url) .
 259                 "' 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]);
 260
 261 }
 262