123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261 |
- <?php
- /**
- * This is a PHP library that handles calling reCAPTCHA.
- *
- * @copyright Copyright (c) 2015, Google Inc.
- * @link https://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
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
- namespace ReCaptcha;
- /**
- * reCAPTCHA client.
- */
- class ReCaptcha
- {
- /**
- * Version of this client library.
- * @const string
- */
- const VERSION = 'php_1.2.1';
- /**
- * URL for reCAPTCHA sitevrerify API
- * @const string
- */
- const SITE_VERIFY_URL = 'https://www.google.com/recaptcha/api/siteverify';
- /**
- * Invalid JSON received
- * @const string
- */
- const E_INVALID_JSON = 'invalid-json';
- /**
- * Could not connect to service
- * @const string
- */
- const E_CONNECTION_FAILED = 'connection-failed';
- /**
- * Did not receive a 200 from the service
- * @const string
- */
- const E_BAD_RESPONSE = 'bad-response';
- /**
- * Not a success, but no error codes received!
- * @const string
- */
- const E_UNKNOWN_ERROR = 'unknown-error';
- /**
- * ReCAPTCHA response not provided
- * @const string
- */
- const E_MISSING_INPUT_RESPONSE = 'missing-input-response';
- /**
- * Expected hostname did not match
- * @const string
- */
- const E_HOSTNAME_MISMATCH = 'hostname-mismatch';
- /**
- * Expected APK package name did not match
- * @const string
- */
- const E_APK_PACKAGE_NAME_MISMATCH = 'apk_package_name-mismatch';
- /**
- * Expected action did not match
- * @const string
- */
- const E_ACTION_MISMATCH = 'action-mismatch';
- /**
- * Score threshold not met
- * @const string
- */
- const E_SCORE_THRESHOLD_NOT_MET = 'score-threshold-not-met';
- /**
- * Challenge timeout
- * @const string
- */
- const E_CHALLENGE_TIMEOUT = 'challenge-timeout';
- /**
- * Shared secret for the site.
- * @var string
- */
- private $secret;
- /**
- * Method used to communicate with service. Defaults to POST request.
- * @var RequestMethod
- */
- private $requestMethod;
- /**
- * Create a configured instance to use the reCAPTCHA service.
- *
- * @param string $secret The shared key between your site and reCAPTCHA.
- * @param RequestMethod $requestMethod method used to send the request. Defaults to POST.
- * @throws \RuntimeException if $secret is invalid
- */
- public function __construct($secret, RequestMethod $requestMethod = null)
- {
- if (empty($secret)) {
- throw new \RuntimeException('No secret provided');
- }
- if (!is_string($secret)) {
- throw new \RuntimeException('The provided secret must be a string');
- }
- $this->secret = $secret;
- $this->requestMethod = (is_null($requestMethod)) ? new RequestMethod\Post() : $requestMethod;
- }
- /**
- * Calls the reCAPTCHA siteverify API to verify whether the user passes
- * CAPTCHA test and additionally runs any specified additional checks
- *
- * @param string $response The user response token provided by reCAPTCHA, verifying the user on your site.
- * @param string $remoteIp The end user's IP address.
- * @return Response Response from the service.
- */
- public function verify($response, $remoteIp = null)
- {
- // Discard empty solution submissions
- if (empty($response)) {
- $recaptchaResponse = new Response(false, array(self::E_MISSING_INPUT_RESPONSE));
- return $recaptchaResponse;
- }
- $params = new RequestParameters($this->secret, $response, $remoteIp, self::VERSION);
- $rawResponse = $this->requestMethod->submit($params);
- $initialResponse = Response::fromJson($rawResponse);
- $validationErrors = array();
- if (isset($this->hostname) && strcasecmp($this->hostname, $initialResponse->getHostname()) !== 0) {
- $validationErrors[] = self::E_HOSTNAME_MISMATCH;
- }
- if (isset($this->apkPackageName) && strcasecmp($this->apkPackageName, $initialResponse->getApkPackageName()) !== 0) {
- $validationErrors[] = self::E_APK_PACKAGE_NAME_MISMATCH;
- }
- if (isset($this->action) && strcasecmp($this->action, $initialResponse->getAction()) !== 0) {
- $validationErrors[] = self::E_ACTION_MISMATCH;
- }
- if (isset($this->threshold) && $this->threshold > $initialResponse->getScore()) {
- $validationErrors[] = self::E_SCORE_THRESHOLD_NOT_MET;
- }
- if (isset($this->timeoutSeconds)) {
- $challengeTs = strtotime($initialResponse->getChallengeTs());
- if ($challengeTs > 0 && time() - $challengeTs > $this->timeoutSeconds) {
- $validationErrors[] = self::E_CHALLENGE_TIMEOUT;
- }
- }
- if (empty($validationErrors)) {
- return $initialResponse;
- }
- return new Response(
- false,
- array_merge($initialResponse->getErrorCodes(), $validationErrors),
- $initialResponse->getHostname(),
- $initialResponse->getChallengeTs(),
- $initialResponse->getApkPackageName(),
- $initialResponse->getScore(),
- $initialResponse->getAction()
- );
- }
- /**
- * Provide a hostname to match against in verify()
- * This should be without a protocol or trailing slash, e.g. www.google.com
- *
- * @param string $hostname Expected hostname
- * @return ReCaptcha Current instance for fluent interface
- */
- public function setExpectedHostname($hostname)
- {
- $this->hostname = $hostname;
- return $this;
- }
- /**
- * Provide an APK package name to match against in verify()
- *
- * @param string $apkPackageName Expected APK package name
- * @return ReCaptcha Current instance for fluent interface
- */
- public function setExpectedApkPackageName($apkPackageName)
- {
- $this->apkPackageName = $apkPackageName;
- return $this;
- }
- /**
- * Provide an action to match against in verify()
- * This should be set per page.
- *
- * @param string $action Expected action
- * @return ReCaptcha Current instance for fluent interface
- */
- public function setExpectedAction($action)
- {
- $this->action = $action;
- return $this;
- }
- /**
- * Provide a threshold to meet or exceed in verify()
- * Threshold should be a float between 0 and 1 which will be tested as response >= threshold.
- *
- * @param float $threshold Expected threshold
- * @return ReCaptcha Current instance for fluent interface
- */
- public function setScoreThreshold($threshold)
- {
- $this->threshold = floatval($threshold);
- return $this;
- }
- /**
- * Provide a timeout in seconds to test against the challenge timestamp in verify()
- *
- * @param int $timeoutSeconds Expected hostname
- * @return ReCaptcha Current instance for fluent interface
- */
- public function setChallengeTimeout($timeoutSeconds)
- {
- $this->timeoutSeconds = $timeoutSeconds;
- return $this;
- }
- }
|