Merge pull request #23 from matthiasgrube/curl_timeout

biscolab · web-flow · commit 62f9e6e49a64 · 2019-07-22T21:31:10.000+02:00
make curl timeout configurable
diff --git a/config/recaptcha.php b/config/recaptcha.php
@@ -39,6 +39,14 @@
 	 */
 	'version'                      => env('RECAPTCHA_DEFAULT_VERSION', 'v2'),
 
+	/**
+	 *
+	 * The curl timout in seconds to validate a recaptcha token
+	 * @since v3.4.3
+	 *
+	 */
+	'curl_timeout'                 => env('RECAPTCHA_CURL_TIMEOUT', 10),
+
 	/**
 	 *
 	 * IP addresses for which validation will be skipped
@@ -61,4 +69,4 @@
 	 *
 	 */
 	'default_token_parameter_name' => env('RECAPTCHA_DEFAULT_TOKEN_PARAMETER_NAME', 'token')
-];
+];
diff --git a/src/ReCaptchaBuilder.php b/src/ReCaptchaBuilder.php
@@ -35,6 +35,13 @@ class ReCaptchaBuilder {
 	 */
 	protected $version;
 
+	/**
+	 * The curl timeout
+	 * please visit https://curl.haxx.se/libcurl/c/CURLOPT_TIMEOUT.html
+	 * @var int
+	 */
+	protected $curl_timeout;
+
 	/**
 	 * Whether is true the ReCAPTCHA is inactive
 	 * @var boolean
@@ -46,11 +53,12 @@ class ReCaptchaBuilder {
 	 */
 	protected $api_url = 'https://www.google.com/recaptcha/api/siteverify';
 
-	public function __construct($api_site_key, $api_secret_key, $version = 'v2') {
+	public function __construct($api_site_key, $api_secret_key, $version = 'v2', $curl_timeout = 3) {
 
 		$this->setApiSiteKey($api_site_key);
 		$this->setApiSecretKey($api_secret_key);
 		$this->setVersion($version);
+		$this->setCurlTimeout($curl_timeout);
 		$this->setSkipByIp($this->skipByIp());
 	}
 
@@ -78,6 +86,25 @@ public function setApiSecretKey(string $api_secret_key): ReCaptchaBuilder {
 		return $this;
 	}
 
+	/**
+	 * @param int $curl_timeout
+	 * @return ReCaptchaBuilder
+	 */
+	public function setCurlTimeout(int $curl_timeout): ReCaptchaBuilder {
+
+		$this->curl_timeout = $curl_timeout;
+
+		return $this;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getCurlTimeout(): int {
+
+		return $this->curl_timeout;
+	}
+
 	/**
 	 * @param string $version
 	 *
@@ -258,7 +285,7 @@ public function validate($response) {
 			$curl = curl_init($url);
 			curl_setopt($curl, CURLOPT_HEADER, false);
 			curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
-			curl_setopt($curl, CURLOPT_TIMEOUT, 1);
+			curl_setopt($curl, CURLOPT_TIMEOUT, $this->curl_timeout);
 			curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
 			$curl_response = curl_exec($curl);
 		}
diff --git a/src/ReCaptchaBuilderInvisible.php b/src/ReCaptchaBuilderInvisible.php
@@ -21,10 +21,11 @@ class ReCaptchaBuilderInvisible extends ReCaptchaBuilder {
 	 *
 	 * @param string $api_site_key
 	 * @param string $api_secret_key
+	 * @param int $curl_timeout
 	 */
-	public function __construct(string $api_site_key, string $api_secret_key) {
+	public function __construct(string $api_site_key, string $api_secret_key, int $curl_timeout) {
 
-		parent::__construct($api_site_key, $api_secret_key, 'invisible');
+		parent::__construct($api_site_key, $api_secret_key, 'invisible', $curl_timeout);
 	}
 
 	/**
diff --git a/src/ReCaptchaBuilderV2.php b/src/ReCaptchaBuilderV2.php
@@ -21,10 +21,11 @@ class ReCaptchaBuilderV2 extends ReCaptchaBuilder {
 	 *
 	 * @param string $api_site_key
 	 * @param string $api_secret_key
+	 * @param int $curl_timeout
 	 */
-	public function __construct(string $api_site_key, string $api_secret_key) {
+	public function __construct(string $api_site_key, string $api_secret_key, int $curl_timeout) {
 
-		parent::__construct($api_site_key, $api_secret_key, 'v2');
+		parent::__construct($api_site_key, $api_secret_key, 'v2', $curl_timeout);
 	}
 
 	/**
diff --git a/src/ReCaptchaBuilderV3.php b/src/ReCaptchaBuilderV3.php
@@ -21,10 +21,11 @@ class ReCaptchaBuilderV3 extends ReCaptchaBuilder {
 	 *
 	 * @param string $api_site_key
 	 * @param string $api_secret_key
+	 * @param int $curl_timeout
 	 */
-	public function __construct(string $api_site_key, string $api_secret_key) {
+	public function __construct(string $api_site_key, string $api_secret_key, int $curl_timeout) {
 
-		parent::__construct($api_site_key, $api_secret_key, 'v3');
+		parent::__construct($api_site_key, $api_secret_key, 'v3', $curl_timeout);
 	}
 
 }
diff --git a/src/ReCaptchaServiceProvider.php b/src/ReCaptchaServiceProvider.php
@@ -114,7 +114,7 @@ protected function registerReCaptchaBuilder() {
 					break;
 			}
 
-			return new $recaptcha_class(config('recaptcha.api_site_key'), config('recaptcha.api_secret_key'));
+			return new $recaptcha_class(config('recaptcha.api_site_key'), config('recaptcha.api_secret_key'), config('recaptcha.curl_timeout'));
 
 		});
 	}
diff --git a/tests/ReCaptchaConfigurationTest.php b/tests/ReCaptchaConfigurationTest.php
@@ -37,6 +37,13 @@ public function testSkipIpWhiteListIsArray() {
 		$this->assertCount(2, $ip_whitelist);
 	}
 
+	/**
+	 * @test
+	 */
+	public function testCurlTimeoutIsSet() {
+		$this->assertEquals($this->recaptcha->getCurlTimeout(), 3);
+	}
+
 	/**
 	 * Define environment setup.
 	 *
@@ -56,6 +63,6 @@ protected function setUp(): void {
 
 		parent::setUp(); // TODO: Change the autogenerated stub
 
-		$this->recaptcha = new ReCaptchaBuilderV2('api_site_key', 'api_secret_key');
+		$this->recaptcha = new ReCaptchaBuilderV2('api_site_key', 'api_secret_key', 3);
 	}
 }
diff --git a/tests/ReCaptchaTest.php b/tests/ReCaptchaTest.php
@@ -85,8 +85,8 @@ protected function setUp(): void {
 
 		parent::setUp(); // TODO: Change the autogenerated stub
 
-		$this->recaptcha_invisible = new ReCaptchaBuilderInvisible('api_site_key', 'api_secret_key');
-		$this->recaptcha_v2 = new ReCaptchaBuilderV2('api_site_key', 'api_secret_key');
+		$this->recaptcha_invisible = new ReCaptchaBuilderInvisible('api_site_key', 'api_secret_key', 3);
+		$this->recaptcha_v2 = new ReCaptchaBuilderV2('api_site_key', 'api_secret_key', 3);
 
 	}
 }
diff --git a/tests/ReCaptchaV3Test.php b/tests/ReCaptchaV3Test.php
@@ -106,7 +106,7 @@ protected function setUp(): void {
 
 		parent::setUp(); // TODO: Change the autogenerated stub
 
-		$this->recaptcha_v3 = new ReCaptchaBuilderV3('api_site_key', 'api_secret_key');
+		$this->recaptcha_v3 = new ReCaptchaBuilderV3('api_site_key', 'api_secret_key', 3);
 
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,11 @@ class ReCaptchaBuilderInvisible extends ReCaptchaBuilder {`
`21`	`21`	`*`
`22`	`22`	`* @param string $api_site_key`
`23`	`23`	`* @param string $api_secret_key`
	`24`	`+ * @param int $curl_timeout`
`24`	`25`	`*/`
`25`		`- public function __construct(string $api_site_key, string $api_secret_key) {`
	`26`	`+ public function __construct(string $api_site_key, string $api_secret_key, int $curl_timeout) {`
`26`	`27`
`27`		`- parent::__construct($api_site_key, $api_secret_key, 'invisible');`
	`28`	`+ parent::__construct($api_site_key, $api_secret_key, 'invisible', $curl_timeout);`
`28`	`29`	`}`
`29`	`30`
`30`	`31`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ protected function registerReCaptchaBuilder() {`
`114`	`114`	`break;`
`115`	`115`	`}`
`116`	`116`
`117`		`- return new $recaptcha_class(config('recaptcha.api_site_key'), config('recaptcha.api_secret_key'));`
	`117`	`+ return new $recaptcha_class(config('recaptcha.api_site_key'), config('recaptcha.api_secret_key'), config('recaptcha.curl_timeout'));`
`118`	`118`
`119`	`119`	`});`
`120`	`120`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,13 @@ public function testSkipIpWhiteListIsArray() {`
`37`	`37`	`$this->assertCount(2, $ip_whitelist);`
`38`	`38`	`}`
`39`	`39`
	`40`	`+ /**`
	`41`	`+ * @test`
	`42`	`+ */`
	`43`	`+ public function testCurlTimeoutIsSet() {`
	`44`	`+ $this->assertEquals($this->recaptcha->getCurlTimeout(), 3);`
	`45`	`+ }`
	`46`	`+`
`40`	`47`	`/**`
`41`	`48`	`* Define environment setup.`
`42`	`49`	`*`
`@@ -56,6 +63,6 @@ protected function setUp(): void {`
`56`	`63`
`57`	`64`	`parent::setUp(); // TODO: Change the autogenerated stub`
`58`	`65`
`59`		`- $this->recaptcha = new ReCaptchaBuilderV2('api_site_key', 'api_secret_key');`
	`66`	`+ $this->recaptcha = new ReCaptchaBuilderV2('api_site_key', 'api_secret_key', 3);`
`60`	`67`	`}`
`61`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,8 +85,8 @@ protected function setUp(): void {`
`85`	`85`
`86`	`86`	`parent::setUp(); // TODO: Change the autogenerated stub`
`87`	`87`
`88`		`- $this->recaptcha_invisible = new ReCaptchaBuilderInvisible('api_site_key', 'api_secret_key');`
`89`		`- $this->recaptcha_v2 = new ReCaptchaBuilderV2('api_site_key', 'api_secret_key');`
	`88`	`+ $this->recaptcha_invisible = new ReCaptchaBuilderInvisible('api_site_key', 'api_secret_key', 3);`
	`89`	`+ $this->recaptcha_v2 = new ReCaptchaBuilderV2('api_site_key', 'api_secret_key', 3);`
`90`	`90`
`91`	`91`	`}`
`92`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -106,7 +106,7 @@ protected function setUp(): void {`
`106`	`106`
`107`	`107`	`parent::setUp(); // TODO: Change the autogenerated stub`
`108`	`108`
`109`		`- $this->recaptcha_v3 = new ReCaptchaBuilderV3('api_site_key', 'api_secret_key');`
	`109`	`+ $this->recaptcha_v3 = new ReCaptchaBuilderV3('api_site_key', 'api_secret_key', 3);`
`110`	`110`
`111`	`111`	`}`
`112`	`112`	`}`