Add methods geetest_v4, lemin, turnstile and amazon_waf to TwoCaptcha class. (#51)

iamarkadiypolukhin · 2captcha · web-flow · commit 1b2782fc58ab · 2023-03-01T21:24:53.000+04:00
* Add methods geetest_v4, lemin, turnstile and amazon_waf

* Update methods geetest_v4, lemin, turnstile, amazon_waf. Add examples in README

* use url instead of pageurl

* add geetest v4 example

* add geetest_v4 test

* add lemin example

* use the save env variable in examples

* add lemin test

* add turnstile example

* add turnstile test

* added amazon_waf example

* added amazon_waf test

---------

Co-authored-by: 2captcha &lt;support@2captcha.com&gt;
diff --git a/README.md b/README.md
@@ -1,27 +1,36 @@
 # Python Module for 2Captcha API
 The easiest way to quickly integrate [2Captcha] captcha solving service into your code to automate solving of any types of captcha.
 
-- [Installation](#installation)
-- [Configuration](#configuration)
-- [Solve captcha](#solve-captcha)
-  - [Normal Captcha](#normal-captcha)
-  - [Text](#text-captcha)
-  - [ReCaptcha v2](#recaptcha-v2)
-  - [ReCaptcha v3](#recaptcha-v3)
-  - [FunCaptcha](#funcaptcha)
-  - [GeeTest](#geetest)
-  - [hCaptcha](#hcaptcha)
-  - [KeyCaptcha](#keycaptcha)
-  - [Capy](#capy)
-  - [Grid (ReCaptcha V2 Old Method)](#grid)
-  - [Canvas](#canvas)
-  - [ClickCaptcha](#clickcaptcha)
-  - [Rotate](#rotate)
-- [Other methods](#other-methods)
-  - [send / getResult](#send--getresult)
-  - [balance](#balance)
-  - [report](#report)
-- [Error handling](#error-handling)
+- [Python Module for 2Captcha API](#python-module-for-2captcha-api)
+  - [Installation](#installation)
+  - [Configuration](#configuration)
+    - [TwoCaptcha instance options](#twocaptcha-instance-options)
+  - [Solve captcha](#solve-captcha)
+    - [Captcha options](#captcha-options)
+    - [Normal Captcha](#normal-captcha)
+    - [Text Captcha](#text-captcha)
+    - [ReCaptcha v2](#recaptcha-v2)
+    - [ReCaptcha v3](#recaptcha-v3)
+    - [FunCaptcha](#funcaptcha)
+    - [GeeTest](#geetest)
+    - [hCaptcha](#hcaptcha)
+    - [GeeTest v4](#geetest-v4)
+    - [Lemin Cropped Captcha](#lemin-cropped-captcha)
+    - [Cloudflare Turnstile](#cloudflare-turnstile)
+    - [Amazon WAF](#amazon-waf)
+    - [KeyCaptcha](#keycaptcha)
+    - [Capy](#capy)
+    - [Grid](#grid)
+    - [Canvas](#canvas)
+    - [ClickCaptcha](#clickcaptcha)
+    - [Rotate](#rotate)
+  - [Other methods](#other-methods)
+    - [send / getResult](#send--getresult)
+    - [balance](#balance)
+    - [report](#report)
+    - [Error handling](#error-handling)
+    - [Proxies](#proxies)
+    - [Async calls](#async-calls)
 
 ## Installation
 
@@ -56,14 +65,14 @@ solver = TwoCaptcha(**config)
 
 ### TwoCaptcha instance options
 
-|Option|Default value|Description|
-|---|---|---|
-|server|`2captcha.com`|API server. You can set it to `rucaptcha.com` if your account is registered there|
-|softId|-|your software ID obtained after publishing in [2captcha sofware catalog]|
-|callback|-|URL of your web-sever that receives the captcha recognition result. The URl should be first registered in [pingback settings] of your account|
-|defaultTimeout|120|Polling timeout in seconds for all captcha types except ReCaptcha. Defines how long the module tries to get the answer from `res.php` API endpoint|
-|recaptchaTimeout|600|Polling timeout for ReCaptcha in seconds. Defines how long the module tries to get the answer from `res.php` API endpoint|
-|pollingInterval|10|Interval in seconds between requests to `res.php` API endpoint, setting values less than 5 seconds is not recommended|
+| Option           | Default value  | Description                                                                                                                                        |
+| ---------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| server           | `2captcha.com` | API server. You can set it to `rucaptcha.com` if your account is registered there                                                                  |
+| softId           | -              | your software ID obtained after publishing in [2captcha sofware catalog]                                                                           |
+| callback         | -              | URL of your web-sever that receives the captcha recognition result. The URl should be first registered in [pingback settings] of your account      |
+| defaultTimeout   | 120            | Polling timeout in seconds for all captcha types except ReCaptcha. Defines how long the module tries to get the answer from `res.php` API endpoint |
+| recaptchaTimeout | 600            | Polling timeout for ReCaptcha in seconds. Defines how long the module tries to get the answer from `res.php` API endpoint                          |
+| pollingInterval  | 10             | Interval in seconds between requests to `res.php` API endpoint, setting values less than 5 seconds is not recommended                              |
 
 >  **IMPORTANT:** once `callback` is defined for `TwoCaptcha` instance, all methods return only the captcha ID and DO NOT poll the API to get the result. The result will be sent to the callback URL.
 To get the answer manually use [getResult method](#send--getresult)
@@ -72,17 +81,17 @@ To get the answer manually use [getResult method](#send--getresult)
 When you submit any image-based captcha use can provide additional options to help 2captcha workers to solve it properly.
 
 ### Captcha options
-|Option|Default Value|Description|
-|---|---|---|
-|numeric|0|Defines if captcha contains numeric or other symbols [see more info in the API docs][post options]|
-|minLength|0|minimal answer lenght|
-|maxLength|0|maximum answer length|
-|phrase|0|defines if the answer contains multiple words or not|
-|caseSensitive|0|defines if the answer is case sensitive|
-|calc|0|defines captcha requires calculation|
-|lang|-|defines the captcha language, see the [list of supported languages] |
-|hintImg|-|an image with hint shown to workers with the captcha|
-|hintText|-|hint or task text shown to workers with the captcha|
+| Option        | Default Value | Description                                                                                        |
+| ------------- | ------------- | -------------------------------------------------------------------------------------------------- |
+| numeric       | 0             | Defines if captcha contains numeric or other symbols [see more info in the API docs][post options] |
+| minLength     | 0             | minimal answer lenght                                                                              |
+| maxLength     | 0             | maximum answer length                                                                              |
+| phrase        | 0             | defines if the answer contains multiple words or not                                               |
+| caseSensitive | 0             | defines if the answer is case sensitive                                                            |
+| calc          | 0             | defines captcha requires calculation                                                               |
+| lang          | -             | defines the captcha language, see the [list of supported languages]                                |
+| hintImg       | -             | an image with hint shown to workers with the captcha                                               |
+| hintText      | -             | hint or task text shown to workers with the captcha                                                |
 
 Below you can find basic examples for every captcha type. Check out [examples directory] to find more examples with all available options.
 
@@ -147,6 +156,48 @@ result = solver.hcaptcha(sitekey='10000000-ffff-ffff-ffff-000000000001',
 
 ```
 
+### GeeTest v4
+Use this method to solve GeeTest v4. Returns the response in JSON.
+```python
+result = solver.geetest_v4(captcha_id='e392e1d7fd421dc63325744d5a2b9c73',
+                            url='https://www.site.com/page/',  
+                            param1=..., ...)
+
+```
+
+
+### Lemin Cropped Captcha
+Use this method to solve hCaptcha challenge. Returns JSON with answer containing the following values: answer, challenge_id.
+```python
+result = solver.lemin(captcha_id='CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d901d',
+                            div_id='lemin-cropped-captcha', 
+                            url='https://www.site.com/page/',
+                            param1=..., ...)
+
+```
+
+
+### Cloudflare Turnstile
+Use this method to solve Cloudflare Turnstile. Returns JSON with the token.
+```python
+result = solver.turnstile(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
+                            url='http://mysite.com/', 
+                            param1=..., ...)
+
+```
+
+### Amazon WAF
+Use this method to solve Amazon WAF Captcha also known as AWS WAF Captcha is a part of Intelligent threat mitigation for Amazon AWS. Returns JSON with the token.
+```python
+result = solver.amazon_waf(sitekey='0x1AAAAAAAAkg0s2VIOD34y5',
+                            iv='CgAHbCe2GgAAAAAj', 
+                            context='9BUgmlm48F92WUoqv97a49ZuEJJ50TCk9MVr3C7WMtQ0X6flVbufM4n8mjFLmbLVAPgaQ1Jydeaja94iAS49ljb+sUNLoukWedAQZKrlY4RdbOOzvcFqmD/ZepQFS9N5w15Exr4VwnVq+HIxTsDJwRviElWCdzKDebN/mk8/eX2n7qJi5G3Riq0tdQw9+C4diFZU5E97RSeahejOAAJTDqduqW6uLw9NsjJBkDRBlRjxjn5CaMMo5pYOxYbGrM8Un1JH5DMOLeXbq1xWbC17YSEoM1cRFfTgOoc+VpCe36Ai9Kc='
+                            url='https://non-existent-example.execute-api.us-east-1.amazonaws.com/latest'
+                            param1=..., ...)
+
+```
+
+
 ### KeyCaptcha
 Token-based method to solve KeyCaptcha.
 ```python
diff --git a/examples/amazon_waf.py b/examples/amazon_waf.py
@@ -0,0 +1,30 @@
+import sys
+import os
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
+
+from twocaptcha import TwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = TwoCaptcha(api_key)
+
+try:
+    result = solver.amazon_waf(
+        sitekey='AQIDAHjcYu/GjX+QlghicBgQ/7bFaQZ+m5FKCMDnO+vTbNg96AFsClhVgr5q0UFRdXhhHEwiAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMLMbH8d6uQSrYTraoAgEQgDvtSNxdEyG7Zu393cHyPdWNCZgeIB52+W7fCTI8U5z15z1NdPUdnB1ZHoK7ewpwoSMm5mzkJJld0cnvGw==',
+        iv='CgAAYDJb9CAAACAq',
+        context='wCho9T9OcETTT8fu1k6+rszr5aGt4eLd+K3mHpV8VbSkjAWJGJx/iQ16RKDCTQBtU5OSeE+SQqoS5iTzhgGtvwgmBbr7X/I+aXaNfb2JRZ8eJ7CnQpM9QRwnv7vGgrGRBGhkh/jaVYmXdy0j0x21s3dCBlA4VN3naDHIweZqkyhXqJBNI1Ep8OMSnhXtPebboB117aBW4IU4XEOii8EE1G4Z7ndWhrNVVXYYwVoxfnSqfYX//CJir6dZfLMbCt5t7NnO8yjsx/YHGVXFVBt2Zrj0ZTxowoYbHU/BKyFaXgUj+ZQ=',
+        url='https://efw47fpad9.execute-api.us-east-1.amazonaws.com/latest',
+    )
+
+except Exception as e:
+    sys.exit(e)
+
+else:
+    sys.exit('result: ' + str(result))
diff --git a/examples/geetest_v4.py b/examples/geetest_v4.py
@@ -0,0 +1,26 @@
+import sys
+import os
+import requests
+sys.path.append(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
+
+from twocaptcha import TwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = TwoCaptcha(api_key)
+
+try:
+    result = solver.geetest_v4(captcha_id='e392e1d7fd421dc63325744d5a2b9c73',
+                                url='https://2captcha.com/demo/geetest-v4')
+
+except Exception as e:
+    sys.exit(e)
+
+else:
+    sys.exit('result: ' + str(result))
diff --git a/examples/lemin.py b/examples/lemin.py
@@ -0,0 +1,27 @@
+import sys
+import os
+sys.path.append(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
+
+from twocaptcha import TwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = TwoCaptcha(api_key)
+
+try:
+    result = solver.lemin(captcha_id='CROPPED_3dfdd5c_d1872b526b794d83ba3b365eb15a200b',
+                                div_id='lemin-cropped-captcha', 
+                                url='https://2captcha.com/demo/lemin')
+
+
+except Exception as e:
+    sys.exit(e)
+
+else:
+    sys.exit('result: ' + str(result))
diff --git a/examples/turnstile.py b/examples/turnstile.py
@@ -0,0 +1,28 @@
+import sys
+import os
+
+sys.path.append(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
+
+from twocaptcha import TwoCaptcha
+
+# in this example we store the API key inside environment variables that can be set like:
+# export APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Linux or macOS
+# set APIKEY_2CAPTCHA=1abc234de56fab7c89012d34e56fa7b8 on Windows
+# you can just set the API key directly to it's value like:
+# api_key="1abc234de56fab7c89012d34e56fa7b8"
+
+api_key = os.getenv('APIKEY_2CAPTCHA', 'YOUR_API_KEY')
+
+solver = TwoCaptcha(api_key)
+
+try:
+    result = solver.turnstile(
+        sitekey='0x4AAAAAAAC3DHQFLr1GavRN',
+        url='https://2captcha.com/demo/turnstile',
+    )
+
+except Exception as e:
+    sys.exit(e)
+
+else:
+    sys.exit('result: ' + str(result))
diff --git a/tests/test_amazon_waf.py b/tests/test_amazon_waf.py
@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+
+import unittest
+
+try:
+    from .abstract import AbstractTest
+except ImportError:
+    from abstract import AbstractTest
+
+class AmazonWAFTest(AbstractTest):
+    
+
+    def test_all_params(self):
+        
+        
+        params = {
+                'sitekey' : 'AQIDAHjcYu/GjX+QlghicBgQ/7bFaQZ+m5FKCMDnO+vTbNg96AFsClhVgr5q0UFRdXhhHEwiAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMLMbH8d6uQSrYTraoAgEQgDvtSNxdEyG7Zu393cHyPdWNCZgeIB52+W7fCTI8U5z15z1NdPUdnB1ZHoK7ewpwoSMm5mzkJJld0cnvGw==',
+                'url'     : 'https://www.site.com/page/',
+                'iv'      : 'CgAAYDJb9CAAACAq',
+                'context' : 'wCho9T9OcETTT8fu1k6+rszr5aGt4eLd+K3mHpV8VbSkjAWJGJx/iQ16RKDCTQBtU5OSeE+SQqoS5iTzhgGtvwgmBbr7X/I+aXaNfb2JRZ8eJ7CnQpM9QRwnv7vGgrGRBGhkh/jaVYmXdy0j0x21s3dCBlA4VN3naDHIweZqkyhXqJBNI1Ep8OMSnhXtPebboB117aBW4IU4XEOii8EE1G4Z7ndWhrNVVXYYwVoxfnSqfYX//CJir6dZfLMbCt5t7NnO8yjsx/YHGVXFVBt2Zrj0ZTxowoYbHU/BKyFaXgUj+ZQ='
+                }
+        
+        sends = {
+                'method'  : 'amazon_waf',
+                'sitekey' : 'AQIDAHjcYu/GjX+QlghicBgQ/7bFaQZ+m5FKCMDnO+vTbNg96AFsClhVgr5q0UFRdXhhHEwiAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMLMbH8d6uQSrYTraoAgEQgDvtSNxdEyG7Zu393cHyPdWNCZgeIB52+W7fCTI8U5z15z1NdPUdnB1ZHoK7ewpwoSMm5mzkJJld0cnvGw==',
+                'iv'      : 'CgAAYDJb9CAAACAq',
+                'context' : 'wCho9T9OcETTT8fu1k6+rszr5aGt4eLd+K3mHpV8VbSkjAWJGJx/iQ16RKDCTQBtU5OSeE+SQqoS5iTzhgGtvwgmBbr7X/I+aXaNfb2JRZ8eJ7CnQpM9QRwnv7vGgrGRBGhkh/jaVYmXdy0j0x21s3dCBlA4VN3naDHIweZqkyhXqJBNI1Ep8OMSnhXtPebboB117aBW4IU4XEOii8EE1G4Z7ndWhrNVVXYYwVoxfnSqfYX//CJir6dZfLMbCt5t7NnO8yjsx/YHGVXFVBt2Zrj0ZTxowoYbHU/BKyFaXgUj+ZQ=',
+                'pageurl' : 'https://www.site.com/page/',
+                }
+
+        return self.send_return(sends, self.solver.amazon_waf, **params)
+
+
+if __name__ == '__main__':
+
+    unittest.main()
+
+
+        # sitekey='AQIDAHjcYu/GjX+QlghicBgQ/7bFaQZ+m5FKCMDnO+vTbNg96AFsClhVgr5q0UFRdXhhHEwiAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMLMbH8d6uQSrYTraoAgEQgDvtSNxdEyG7Zu393cHyPdWNCZgeIB52+W7fCTI8U5z15z1NdPUdnB1ZHoK7ewpwoSMm5mzkJJld0cnvGw==',
+        # iv='CgAAYDJb9CAAACAq',
+        # context='wCho9T9OcETTT8fu1k6+rszr5aGt4eLd+K3mHpV8VbSkjAWJGJx/iQ16RKDCTQBtU5OSeE+SQqoS5iTzhgGtvwgmBbr7X/I+aXaNfb2JRZ8eJ7CnQpM9QRwnv7vGgrGRBGhkh/jaVYmXdy0j0x21s3dCBlA4VN3naDHIweZqkyhXqJBNI1Ep8OMSnhXtPebboB117aBW4IU4XEOii8EE1G4Z7ndWhrNVVXYYwVoxfnSqfYX//CJir6dZfLMbCt5t7NnO8yjsx/YHGVXFVBt2Zrj0ZTxowoYbHU/BKyFaXgUj+ZQ=',
+        # url='https://efw47fpad9.execute-api.us-east-1.amazonaws.com/latest',
diff --git a/tests/test_geetest_v4.py b/tests/test_geetest_v4.py
@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+
+import unittest
+
+try:
+    from .abstract import AbstractTest
+except ImportError:
+    from abstract import AbstractTest
+
+
+
+class GeeTest_V4(AbstractTest):
+    
+
+    def test_all_params(self):
+        
+        
+        params = {
+                'captcha_id': 'e392e1d7fd421dc63325744d5a2b9c73',
+                'url'       : 'https://2captcha.com/demo/geetest-v4',                }
+        
+        sends = {
+                'method'     : 'geetest_v4',
+                'captcha_id' : 'e392e1d7fd421dc63325744d5a2b9c73',
+                'pageurl'    : 'https://2captcha.com/demo/geetest-v4',
+                }
+
+        return self.send_return(sends, self.solver.geetest_v4, **params)
+
+
+if __name__ == '__main__':
+
+    unittest.main()
+
diff --git a/tests/test_lemin.py b/tests/test_lemin.py
@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+
+import unittest
+
+try:
+    from .abstract import AbstractTest
+except ImportError:
+    from abstract import AbstractTest
+
+
+
+class LeminTest(AbstractTest):
+    
+
+    def test_all_params(self):
+        
+        
+        params = {
+                 'captcha_id' : 'CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d901d',
+                 'div_id'     : 'lemin-cropped-captcha',
+                 'api_server' : 'https://api.leminnow.com/',
+                 'url'        : 'http://mysite.com/',
+                }
+        
+        sends = {
+                'method'     : 'lemin',
+                'captcha_id' : 'CROPPED_1abcd2f_a1234b567c890d12ef3a456bc78d901d',
+                'div_id'     : 'lemin-cropped-captcha',
+                'api_server' : 'https://api.leminnow.com/',
+                'pageurl'    : 'http://mysite.com/',
+                }
+
+        return self.send_return(sends, self.solver.lemin, **params)
+
+
+
+
+
+if __name__ == '__main__':
+
+    unittest.main()
+
diff --git a/tests/test_turnstile.py b/tests/test_turnstile.py
diff --git a/twocaptcha/solver.py b/twocaptcha/solver.py
