diff --git a/CHANGES.txt b/CHANGES.txt new file mode 100644 index 0000000..de74505 --- /dev/null +++ b/CHANGES.txt @@ -0,0 +1 @@ +, -- Initial release. diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..fe069b8 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018, Steib Cristian. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..2985d18 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include *.txt +recursive-include docs *.txt diff --git a/README.md b/README.md new file mode 100644 index 0000000..c789c83 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# crecaptcha +###### A simple python module for Google Recaptcha V3 +A pure python module, don't requires requests library +## Installation +- from latest version on PyPi: + ```bash + pip install crecaptcha + ``` + +## how to use? +```python +from crecatpcha.crecaptcha import crecaptcha +SECRET_KEY = 'Your secret key' + +def some_function(): + response_token = 'the response token from the client' + + if crecaptcha(SECRET_KEY, response_token, 'action_name'): + # safe action + pass + else: + # is a bot, take your custom action. + pass + ``` + + +## how to use with django? +### Configuration: +In the settings.py define the following values: + **CRECAPTCHA_SECRET_KEY**: the recaptcha secret key. + **CRECAPTCHA_KEY_NAME**: the name of the var in the POST request, by default is 'recaptcha_token'. + Example: + ```python +CRECAPTCHA_SECRET_KEY = "jgjdnvurmfj3nrfo3nrlksjf" # Mandatory +CRECAPTCHA_KEY_NAME = "grecatpcha" # by default is 'recaptcha_token' + ``` + +### Usage: +#### Simple way: +In the following example if the recaptcha validation fails, it will raise an HttpResponseForbidden +```python +from crecatpcha.django_crecatpcha import crecaptcha + +@crecaptcha('login') +def login_user(request): + pass + +@crecaptcha('register', threshold=0.6) +def register_user(request): + pass + +``` + +#### Advance way: +You can define your custom callback when the validations fails, an optionally you can send args & kwargs. + +```python +from crecatpcha.django_crecatpcha import crecaptcha + +def register_user_on_crecaptcha_error(request, *args, **kwargs): + pass + +@crecaptcha('register', register_user_on_crecaptcha_error, args_on_error=[], kwargs_on_error={}) +def register_user(request): + pass +``` diff --git a/crecatpcha/__init__.py b/crecatpcha/__init__.py new file mode 100644 index 0000000..b6e690f --- /dev/null +++ b/crecatpcha/__init__.py @@ -0,0 +1 @@ +from . import * diff --git a/crecatpcha/crecaptcha.py b/crecatpcha/crecaptcha.py new file mode 100644 index 0000000..155e750 --- /dev/null +++ b/crecatpcha/crecaptcha.py @@ -0,0 +1,54 @@ +""" +Codigos de errores: + + +100 - es humano +101 - fallo la comunicacion con google +102 - accion incorrecta +103 - no alcanzo el umbral esperadp + +""" + +import http.client, urllib.parse +import json +import logging + +logger = logging.getLogger(__name__) + +headers = { + "Content-type": "application/x-www-form-urlencoded", + "Accept": "text/plain" +} + + +def request(payload): + params = urllib.parse.urlencode(payload) + conn = http.client.HTTPSConnection("www.google.com") + conn.request('POST', '/recaptcha/api/siteverify', params, headers) + return json.loads(conn.getresponse().read()) + + +def is_a_human(secret_key, response_token, action=None, threshold=0.5): + payload = { + 'secret': secret_key, + 'response': response_token + } + response = request(payload) + if not response['success']: + logger.warning("Failed comunication") + return False, 101 + elif response["score"] >= threshold: + if action and response.get('action', None): + if action != response['action']: + logger.warning("Bad action name. action send: %s , action expected: %s" % (action, response['action'])) + return False, 102 + logger.info("Is human") + return True, 100 + else: + logger.warning("Threshold failed, get: %s , expected < %s" % (response['score'], threshold)) + return False, 103 + + +def crecaptcha(secret_key, response_token, action=None, threshold=0.5): + ok, _ = is_a_human(secret_key, response_token, action, threshold) + return ok diff --git a/crecatpcha/django_crecatpcha.py b/crecatpcha/django_crecatpcha.py new file mode 100644 index 0000000..59fb734 --- /dev/null +++ b/crecatpcha/django_crecatpcha.py @@ -0,0 +1,34 @@ +from crecatpcha.crecaptcha import is_a_human +import logging +from django.conf import settings +from django.http import HttpResponseForbidden + +logger = logging.getLogger(__name__) + +SECRET_KEY = settings.CRECAPTCHA_SECRET_KEY +try: + KEY_NAME = settings.CRECAPTCHA_KEY_NAME +except: + KEY_NAME = 'recaptcha_token' + + +def crecaptcha(action=None, + on_error_function=None, + args_on_error=[], + kwargs_on_error={}, + threshold=0.5): + def do_challenge(func): + def check_captcha(*args, **kwargs): + request = args[0] + ok, code = is_a_human(SECRET_KEY, request.POST[KEY_NAME], action=action, threshold=threshold) + if ok: + return func(*args, **kwargs) + else: + if not on_error_function: + raise HttpResponseForbidden + kwargs_on_error['data'] = {'code': code, 'info': 'cRecaptcha error'} + return on_error_function(*args, *args_on_error, **kwargs_on_error) + + return check_captcha + + return do_challenge diff --git a/docs/usage.txt b/docs/usage.txt new file mode 100644 index 0000000..01cdc4d --- /dev/null +++ b/docs/usage.txt @@ -0,0 +1 @@ +first doc diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..4bfced3 --- /dev/null +++ b/setup.py @@ -0,0 +1,22 @@ +from setuptools import setup + +setup( + name='crecaptcha', + version='0.1.3', + author='Steib Cristian', + author_email='cristiansteib@gmail.com', + packages=['crecatpcha'], + url='https://github.com/cristiansteib/crecatpcha/', + license='LICENSE.txt', + description='reCatpcha api v3.0 - with django support', + long_description=open('README.md').read(), + long_description_content_type="text/markdown", + classifiers=[ + "Programming Language :: Python :: 3", + "Operating System :: OS Independent", + "Framework :: Django", + "Framework :: Flask", + "License :: OSI Approved :: Apache Software License", + "Topic :: Security" + ], +)