├── .gitignore ├── .travis.yml ├── LICENSE ├── MANIFEST.in ├── README.md ├── README.txt ├── requirements.txt ├── samples ├── bare_metal_recaptcha.html ├── custom_callback_recaptcha.html ├── multiple_recaptcha.html ├── simple_recaptcha.html └── test_unit.py ├── setup.cfg ├── setup.py ├── snowpenguin ├── __init__.py └── django │ ├── __init__.py │ └── recaptcha3 │ ├── __init__.py │ ├── fields.py │ ├── locale │ └── it │ │ └── LC_MESSAGES │ │ ├── django.mo │ │ └── django.po │ ├── migrations │ └── __init__.py │ ├── templates │ └── snowpenguin │ │ └── recaptcha │ │ ├── recaptcha_execute.html │ │ ├── recaptcha_hidden_input.html │ │ ├── recaptcha_init.html │ │ └── recaptcha_ready.html │ ├── templatetags │ ├── __init__.py │ └── recaptcha3.py │ ├── tests.py │ └── widgets.py ├── sonar-project.properties ├── test_settings.py └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | 5 | # C extensions 6 | *.so 7 | 8 | # Distribution / packaging 9 | .Python 10 | env/ 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | *.egg-info/ 23 | .installed.cfg 24 | *.egg 25 | 26 | # PyInstaller 27 | # Usually these files are written by a python script from a template 28 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 29 | *.manifest 30 | *.spec 31 | 32 | # Installer logs 33 | pip-log.txt 34 | pip-delete-this-directory.txt 35 | 36 | # Unit test / coverage reports 37 | htmlcov/ 38 | .tox/ 39 | .coverage 40 | .coverage.* 41 | .cache 42 | nosetests.xml 43 | coverage.xml 44 | *,cover 45 | 46 | # Translations 47 | *.pot 48 | 49 | # Django stuff: 50 | *.log 51 | 52 | # Sphinx documentation 53 | docs/_build/ 54 | 55 | # PyBuilder 56 | target/ 57 | /venv/ 58 | /django-test/ 59 | *.iml 60 | .idea -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: python 2 | dist: xenial 3 | python: 4 | - '2.7' 5 | - '3.4' 6 | - '3.5' 7 | - '3.6' 8 | install: 9 | - pip install tox-travis 10 | - python setup.py -q install 11 | script: 12 | - tox 13 | deploy: 14 | provider: pypi 15 | skip_existing: true 16 | user: kbyte 17 | distributions: sdist bdist_wheel 18 | password: 19 | secure: aoMwfMufWOyOOvJAz/sXRL5v7xs/vr1WMpr+SNNO9lBKHCTCAXSVtz9zQjVfIAV0cbjuCv94Bw2/n7nom1SKjwh3nB0BXVjX+0O2R93zNhwsYdXoA5mLEpeELcW/rWygk/ECM33dRnL0JTkzYnPRSRgPTO1QSjzpRiXhzmFjO1COQgAafL3AqtDoQwmFjHXMYeFvyyp4jSssh/1GpEv33pexIZ+5F0uCEiXxudBhYoFlJIeZ2aLe+ngTR5cGqgqjpVR7dU2qrWYs0JMEU9eQazQcNEdVp7bEhj+I/5VTD1Md7hDbqRI+/zEIcsZ4g42kbW+y3wH95Nf196+lyNskihhruVMVN9VfbLr4aLwwvXF/SjsIoUL91ZcEhetoDzsmyS23zEvY1rsjAFRgSk+oCoC2RTQjOt1f6pomdjk3FR7jCv6WhH0GM1ZDZIKQEC4I4nz0gVTfFKmi4X2E+yU+AuEcMGjoVTmtZtqYMaTRUn5vYMgKxVP8RY+qDs9iqweShJtyGSXcBqbDN0bnV3T4R3KzdbMn83JlQgjNlTzbwC5O4Bq8tTDxyG9W/HyX6b+RQTjkbprNYTHJWop6zhZMUqh4JCq5HA49tDV7wXHFGkSNC8cT0xV2TdLFWcJrKCALH925S9Ynop/aLBm7uwItetKOmpVYtCyerTGbA+nP1Yw= 20 | on: 21 | tags: true 22 | python: '3.6' 23 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | (This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.) 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | {description} 474 | Copyright (C) {year} {fullname} 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | {signature of Ty Coon}, 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | 506 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.txt 2 | include README.md 3 | include LICENSE 4 | recursive-include snowpenguin/django/recaptcha3/templates *.html 5 | recursive-include snowpenguin/django/recaptcha3/locale *.mo -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Django reCaptcha v3 [![Build Status](https://travis-ci.org/kbytesys/django-recaptcha3.svg?branch=master)](https://travis-ci.org/kbytesys/django-recaptcha2) 2 | ---- 3 | 4 | This integration app implements a recaptcha field for Google reCaptcha v3. 5 | 6 | **Warning:** this package is **not** compatible with django-recaptcha2 7 | 8 | ---- 9 | 10 | ## How to install 11 | 12 | Install the required package from pip (or take the source and install it by yourself): 13 | 14 | ```bash 15 | pip install django-recaptcha3 16 | ``` 17 | 18 | Then add django-recaptcha3 to your installed apps: 19 | 20 | ```python 21 | INSTALLED_APPS = ( 22 | ... 23 | 'snowpenguin.django.recaptcha3', 24 | ... 25 | ) 26 | ``` 27 | 28 | And add your reCaptcha private and public key to your django settings.py and the default action name, recaptcha score threshold: 29 | 30 | ```python 31 | RECAPTCHA_PRIVATE_KEY = 'your private key' 32 | RECAPTCHA_PUBLIC_KEY = 'your public key' 33 | RECAPTCHA_DEFAULT_ACTION = 'generic' 34 | RECAPTCHA_SCORE_THRESHOLD = 0.5 35 | RECAPTCHA_LANGUAGE = 'en' # for auto detection language, remove this from your settings 36 | # If you require reCaptcha to be loaded from somewhere other than https://google.com 37 | # (e.g. to bypass firewall restrictions), you can specify what proxy to use. 38 | # RECAPTCHA_FRONTEND_PROXY_HOST = 'https://recaptcha.net' 39 | 40 | ``` 41 | 42 | If you have to create the apikey for the domains managed by your django project, you can visit this website. 43 | 44 | ## Usage 45 | ### Form and Widget 46 | You can simply create a reCaptcha enabled form with the field provided by this app: 47 | 48 | ```python 49 | from snowpenguin.django.recaptcha3.fields import ReCaptchaField 50 | 51 | class ExampleForm(forms.Form): 52 | [...] 53 | captcha = ReCaptchaField() 54 | [...] 55 | ``` 56 | 57 | Form validation of the ReCaptchaField causes us to verify the token returned from the client against the ReCaptcha servers and populates a dictionary containing the `score`, `action`, `hostname`, and `challenge_ts` fields as the form fields `cleaned_data`: 58 | 59 | ```python 60 | def formview(request): 61 | if request.method == "POST": 62 | form = ExampleForm(request.POST) 63 | if form.is_valid(): 64 | captcha_score = form.cleaned_data['captcha'].get('score') 65 | ``` 66 | 67 | If a communication problem occurs, the token supplied by the client is invalid or has expired then a ValidationError is raised. 68 | 69 | ## Automatic Enforcement 70 | 71 | If you want low scores to cause a ValidationError, pass an appropriate `score_threshold` to the `ReCaptchaField`, or set the configuration variable settings.RECAPTCHA_SCORE_THRESHOLD. 72 | 73 | The default value for the threshold is 0.0, which allows all successful capture responses through for you to later check the value of `score`. 74 | 75 | ```python 76 | from snowpenguin.django.recaptcha3.fields import ReCaptchaField 77 | 78 | class ExampleForm(forms.Form): 79 | [...] 80 | captcha = ReCaptchaField(score_threshold=0.5) 81 | [...] 82 | ``` 83 | 84 | You can also set the private key on the "private_key" argument of the ReCaptchaField contructor if you want to override the one inside your configuration. 85 | 86 | ### Templating 87 | You can use some template tags to simplify the reCaptcha adoption: 88 | 89 | * recaptcha_init: add the script tag for reCaptcha api. You have to put this tag somewhere in your "head" element 90 | * recaptcha_ready: call the execute function when the api script is loaded 91 | * recaptcha_execute: start the reCaptcha check and set the token from the api in your django forms. Token is valid for 120s, after this time it is automatically regenerated. 92 | * recaptcha_key: if you want to use reCaptcha manually in your template, you will need the sitekey (a.k.a. public api key). 93 | This tag returns a string with the configured public key. 94 | 95 | You can use the form as usual. 96 | 97 | ### Samples 98 | #### Simple 99 | 100 | Just create a form with the reCaptcha field and follow this template example: 101 | 102 | ```django 103 | {% load recaptcha3 %} 104 | 105 | 106 | {% recaptcha_init %} 107 | {% recaptcha_ready action_name='homepage' %} 108 | 109 | 110 |
111 | {% csrf_token %} 112 | {{ form }} 113 | 114 |
115 | 116 | 117 | ``` 118 | 119 | #### Custom callback 120 | 121 | The callback can be used to allow to use the token received from the api in ajax calls or whatever 122 | 123 | ```django 124 | {% load recaptcha3 %} 125 | 126 | 127 | 132 | {% recaptcha_init %} 133 | {% recaptcha_ready action_name='homepage' custom_callback='alertToken' %} 134 | 135 | 136 |
137 | {% csrf_token %} 138 | {{ form }} 139 | 140 |
141 | 142 | 143 | ``` 144 | 145 | #### Multiple render example 146 | 147 | You can render multiple reCaptcha without any extra effort: 148 | 149 | ```django 150 | {% load recaptcha3 %} 151 | 152 | 153 | {% recaptcha_init %} 154 | {% recaptcha_ready action_name='homepage' %} 155 | 156 | 157 |
158 | {% csrf_token %} 159 | {{ form1 }} 160 | 161 |
162 |
163 | {% csrf_token %} 164 | {{ form2 }} 165 | 166 |
167 | 168 | 169 | ``` 170 | 171 | #### Bare metal! 172 | 173 | You can use the plain javascript, just remember to set the correct value for the hidden field in the form 174 | 175 | ```django 176 | 177 | 178 | 179 | 193 | 194 | 195 |
196 | {% csrf_token %} 197 | {{ form }} 198 | 199 |
200 | 201 | 202 | ``` 203 | 204 | 205 | ## Testing 206 | ### Test unit support 207 | You can disable recaptcha field validation in unit tests by setting the RECAPTCHA_DISABLE env variable. This will skip the external call to Recaptca servers, returning a valid field with no data. 208 | 209 | ```python 210 | os.environ['RECAPTCHA_DISABLE'] = 'True' 211 | ``` 212 | You can use any word in place of "True", the clean function will check only if the variable exists. 213 | 214 | If you set `RECAPTCHA_DISABLE` to be valid json, it will be interpreted as a mock captcha server response allowing you to mock score/hostname/action as required: 215 | ```python 216 | os.environ['RECAPTCHA_DISABLE'] = json.dumps({'score': 0.4, 'hostname': 'localhost', 'action': 'homepage'}) 217 | ``` 218 | 219 | ### Test unit with recaptcha3 disabled 220 | ```python 221 | import os 222 | import unittest 223 | 224 | from yourpackage.forms import MyForm 225 | 226 | class TestCase(unittest.TestCase): 227 | def setUp(self): 228 | os.environ['RECAPTCHA_DISABLE'] = 'True' 229 | 230 | def test_myform(self): 231 | form = MyForm({ 232 | 'field1': 'field1_value' 233 | }) 234 | self.assertTrue(form.is_valid()) 235 | 236 | def tearDown(self): 237 | del os.environ['RECAPTCHA_DISABLE'] 238 | ``` 239 | -------------------------------------------------------------------------------- /README.txt: -------------------------------------------------------------------------------- 1 | This integration app implements a reCAPTCHA support for Google reCAPTCHA v3. -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Django>=1.8 2 | requests -------------------------------------------------------------------------------- /samples/bare_metal_recaptcha.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 18 | 19 | 20 |
21 | {% csrf_token %} 22 | {{ form }} 23 | 24 |
25 | 26 | -------------------------------------------------------------------------------- /samples/custom_callback_recaptcha.html: -------------------------------------------------------------------------------- 1 | {% load recaptcha3 %} 2 | 3 | 4 | 9 | {% recaptcha_init %} 10 | {% recaptcha_ready action_name='homepage' custom_callback='alertToken' %} 11 | 12 | 13 |
14 | {% csrf_token %} 15 | {{ form }} 16 | 17 |
18 | 19 | -------------------------------------------------------------------------------- /samples/multiple_recaptcha.html: -------------------------------------------------------------------------------- 1 | {% load recaptcha3 %} 2 | 3 | 4 | {% recaptcha_init %} 5 | {% recaptcha_ready action_name='homepage' %} 6 | 7 | 8 |
9 | {% csrf_token %} 10 | {{ form1 }} 11 | 12 |
13 |
14 | {% csrf_token %} 15 | {{ form2 }} 16 | 17 |
18 | 19 | -------------------------------------------------------------------------------- /samples/simple_recaptcha.html: -------------------------------------------------------------------------------- 1 | {% load recaptcha3 %} 2 | 3 | 4 | {% recaptcha_init %} 5 | {% recaptcha_ready action_name='homepage' %} 6 | 7 | 8 |
9 | {% csrf_token %} 10 | {{ form }} 11 | 12 |
13 | 14 | -------------------------------------------------------------------------------- /samples/test_unit.py: -------------------------------------------------------------------------------- 1 | import os 2 | import unittest 3 | 4 | from yourpackage.forms import MyForm 5 | 6 | class TestCase(unittest.TestCase): 7 | def setUp(self): 8 | os.environ['RECAPTCHA_DISABLE'] = 'True' 9 | 10 | def test_myform(self): 11 | form = MyForm({ 12 | 'field1': 'field1_value' 13 | }) 14 | self.assertTrue(form.is_valid()) 15 | 16 | def tearDown(self): 17 | del os.environ['RECAPTCHA_DISABLE'] -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [pep8] 2 | max-line-length = 120 -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | from setuptools import setup, find_packages 3 | 4 | 5 | def readme(): 6 | with open('README.txt') as f: 7 | return f.read() 8 | 9 | 10 | version = '0.4.0' 11 | 12 | 13 | setup( 14 | name='django-recaptcha3', 15 | packages=find_packages(exclude=['samples']), 16 | # package_data={'': ['']}, 17 | include_package_data=True, 18 | version=version, 19 | install_requires=[ 20 | 'requests' 21 | ], 22 | tests_require=( 23 | ['django-setuptest'], 24 | ), 25 | test_suite='setuptest.setuptest.SetupTestSuite', 26 | description='Django reCaptcha v3 field/widget', 27 | long_description=readme(), 28 | author='Andrea Briganti', 29 | author_email='kbytesys@gmail.com', 30 | url='https://github.com/kbytesys/django-recaptcha3', 31 | download_url='https://github.com/kbytesys/django-recaptcha3/tarball/v%s' % version, 32 | keywords=['django', 'recaptcha', 'recaptcha3'], 33 | license='GNU LGPL v2', 34 | classifiers=[ 35 | 'Development Status :: 4 - Beta', 36 | 'Environment :: Web Environment', 37 | 'Intended Audience :: Developers', 38 | 'License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)', 39 | 'Natural Language :: English', 40 | 'Programming Language :: Python', 41 | 'Programming Language :: Python :: 3', 42 | 'Framework :: Django', 43 | 'Framework :: Django :: 1.8', 44 | 'Framework :: Django :: 1.9', 45 | 'Framework :: Django :: 1.10', 46 | 'Framework :: Django :: 1.11', 47 | 'Framework :: Django :: 2.0', 48 | 'Framework :: Django :: 2.1', 49 | 'Operating System :: OS Independent', 50 | 'Topic :: Internet :: WWW/HTTP', 51 | 'Topic :: Software Development :: Libraries :: Python Modules' 52 | ] 53 | ) 54 | -------------------------------------------------------------------------------- /snowpenguin/__init__.py: -------------------------------------------------------------------------------- 1 | __path__ = __import__('pkgutil').extend_path(__path__, __name__) 2 | -------------------------------------------------------------------------------- /snowpenguin/django/__init__.py: -------------------------------------------------------------------------------- 1 | __path__ = __import__('pkgutil').extend_path(__path__, __name__) 2 | -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kbytesys/django-recaptcha3/cec505ebd362bc82f9bc61509e02a04547301dba/snowpenguin/django/recaptcha3/__init__.py -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/fields.py: -------------------------------------------------------------------------------- 1 | import json 2 | import logging 3 | import os 4 | 5 | from django import forms 6 | from django.conf import settings 7 | from django.core.exceptions import ValidationError 8 | from django.utils.translation import gettext_lazy as _ 9 | 10 | 11 | import requests 12 | 13 | from snowpenguin.django.recaptcha3.widgets import ReCaptchaHiddenInput 14 | 15 | logger = logging.getLogger(__name__) 16 | 17 | 18 | class ReCaptchaField(forms.CharField): 19 | def __init__(self, attrs=None, *args, **kwargs): 20 | if os.environ.get('RECAPTCHA_DISABLE', None) is None: 21 | self._private_key = kwargs.pop('private_key', settings.RECAPTCHA_PRIVATE_KEY) 22 | self._score_threshold = kwargs.pop('score_threshold', settings.RECAPTCHA_SCORE_THRESHOLD) 23 | 24 | if 'widget' not in kwargs: 25 | kwargs['widget'] = ReCaptchaHiddenInput() 26 | 27 | super(ReCaptchaField, self).__init__(*args, **kwargs) 28 | 29 | def clean(self, values): 30 | # Disable the check (and allow empty field value) if we run in a unittest 31 | if os.environ.get('RECAPTCHA_DISABLE', None) is not None: 32 | try: 33 | return json.loads(os.environ.get('RECAPTCHA_DISABLE', None)) 34 | except: 35 | return {} 36 | 37 | response_token = super(ReCaptchaField, self).clean(values) 38 | 39 | try: 40 | r = requests.post( 41 | 'https://www.google.com/recaptcha/api/siteverify', 42 | { 43 | 'secret': self._private_key, 44 | 'response': response_token 45 | }, 46 | timeout=5 47 | ) 48 | r.raise_for_status() 49 | except requests.RequestException as e: 50 | logger.exception(e) 51 | raise ValidationError( 52 | _('Connection to reCaptcha server failed'), 53 | code='connection_failed' 54 | ) 55 | 56 | json_response = r.json() 57 | logger.debug("Recieved response from reCaptcha server: %s", json_response) 58 | 59 | if bool(json_response['success']): 60 | if self._score_threshold is not None and self._score_threshold > json_response['score']: 61 | raise ValidationError( 62 | _('reCaptcha score is too low. score: %(score)s'), 63 | code='score', 64 | params={'score': json_response['score']}, 65 | ) 66 | return json_response 67 | else: 68 | if 'error-codes' in json_response: 69 | if 'missing-input-secret' in json_response['error-codes'] or \ 70 | 'invalid-input-secret' in json_response['error-codes']: 71 | 72 | logger.exception('Invalid reCaptcha secret key detected') 73 | raise ValidationError( 74 | _('Connection to reCaptcha server failed'), 75 | code='invalid_secret', 76 | ) 77 | else: 78 | raise ValidationError( 79 | _('reCaptcha invalid or expired, try again'), 80 | code='expired', 81 | ) 82 | else: 83 | logger.exception('No error-codes received from Google reCaptcha server') 84 | raise ValidationError( 85 | _('reCaptcha response from Google not valid, try again'), 86 | code='invalid_response', 87 | ) 88 | -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/locale/it/LC_MESSAGES/django.mo: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kbytesys/django-recaptcha3/cec505ebd362bc82f9bc61509e02a04547301dba/snowpenguin/django/recaptcha3/locale/it/LC_MESSAGES/django.mo -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/locale/it/LC_MESSAGES/django.po: -------------------------------------------------------------------------------- 1 | # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER 2 | # This file is distributed under the same license as the PACKAGE package. 3 | # 4 | # Kbyte , 2015. 5 | msgid "" 6 | msgstr "" 7 | "Project-Id-Version: \n" 8 | "Report-Msgid-Bugs-To: \n" 9 | "POT-Creation-Date: 2015-07-23 11:26+0000\n" 10 | "PO-Revision-Date: 2015-07-23 13:31+0200\n" 11 | "Last-Translator: Kbyte \n" 12 | "Language-Team: Italian \n" 13 | "Language: Italian\n" 14 | "MIME-Version: 1.0\n" 15 | "Content-Type: text/plain; charset=UTF-8\n" 16 | "Content-Transfer-Encoding: 8bit\n" 17 | "Plural-Forms: nplurals=2; plural=(n != 1);\n" 18 | "X-Generator: Lokalize 1.5\n" 19 | 20 | #: snowpenguin/django/recaptcha2/fields.py:33 21 | #: snowpenguin/django/recaptcha2/fields.py:46 22 | msgid "Connection to reCaptcha server failed" 23 | msgstr "Connessione al server di reCaptcha fallita" 24 | 25 | #: snowpenguin/django/recaptcha2/fields.py:50 26 | msgid "reCaptcha invalid or expired, try again" 27 | msgstr "reCaptcha non valido o scaduto, riprova" 28 | 29 | -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/migrations/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kbytesys/django-recaptcha3/cec505ebd362bc82f9bc61509e02a04547301dba/snowpenguin/django/recaptcha3/migrations/__init__.py -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/templates/snowpenguin/recaptcha/recaptcha_execute.html: -------------------------------------------------------------------------------- 1 | var grecaptcha_execute = function(){ 2 | grecaptcha.execute('{{ public_key }}', {action: '{{ action_name }}'}).then(function(token) { 3 | document.querySelectorAll('input.django-recaptcha-hidden-field').forEach(function (value) { 4 | value.value = token; 5 | }); 6 | return token; 7 | }) 8 | }; 9 | grecaptcha_execute() 10 | setInterval(grecaptcha_execute, 120000); 11 | {% if custom_callback %}.then(function(token) { 12 | window["{{ custom_callback }}"](token); 13 | }){% endif %} 14 | -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/templates/snowpenguin/recaptcha/recaptcha_hidden_input.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/templates/snowpenguin/recaptcha/recaptcha_init.html: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/templates/snowpenguin/recaptcha/recaptcha_ready.html: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/templatetags/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kbytesys/django-recaptcha3/cec505ebd362bc82f9bc61509e02a04547301dba/snowpenguin/django/recaptcha3/templatetags/__init__.py -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/templatetags/recaptcha3.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | from django import template 4 | from django.conf import settings 5 | from django.template.loader import get_template 6 | 7 | register = template.Library() 8 | 9 | 10 | @register.simple_tag 11 | def recaptcha_key(): 12 | return settings.RECAPTCHA_PUBLIC_KEY 13 | 14 | 15 | def recaptcha_init(public_key=None): 16 | 17 | return { 18 | 'public_key': public_key or settings.RECAPTCHA_PUBLIC_KEY, 19 | 'language': None if not hasattr(settings, 'RECAPTCHA_LANGUAGE') else settings.RECAPTCHA_LANGUAGE, 20 | 'google_api_host': 'https://www.google.com' if not hasattr(settings, 'RECAPTCHA_FRONTEND_PROXY_HOST') 21 | else settings.RECAPTCHA_FRONTEND_PROXY_HOST 22 | } 23 | 24 | 25 | def recaptcha_ready(public_key=None, action_name=None, custom_callback=None): 26 | return { 27 | 'public_key': public_key or settings.RECAPTCHA_PUBLIC_KEY, 28 | 'action_name': action_name or settings.RECAPTCHA_DEFAULT_ACTION, 29 | 'custom_callback': custom_callback 30 | } 31 | 32 | 33 | def recaptcha_execute(public_key=None, action_name=None, custom_callback=None): 34 | return { 35 | 'public_key': public_key or settings.RECAPTCHA_PUBLIC_KEY, 36 | 'action_name': action_name or settings.RECAPTCHA_DEFAULT_ACTION, 37 | 'custom_callback': custom_callback 38 | } 39 | 40 | 41 | def return_empty_context(*args, **kwargs): 42 | return '' 43 | 44 | 45 | if not os.environ.get('RECAPTCHA_DISABLE', None): 46 | register.inclusion_tag(get_template('snowpenguin/recaptcha/recaptcha_init.html'))(recaptcha_init) 47 | register.inclusion_tag(get_template('snowpenguin/recaptcha/recaptcha_ready.html'))(recaptcha_ready) 48 | register.inclusion_tag(get_template('snowpenguin/recaptcha/recaptcha_execute.html'))(recaptcha_execute) 49 | else: 50 | register.simple_tag(return_empty_context, name='recaptcha_init') 51 | register.simple_tag(return_empty_context, name='recaptcha_ready') 52 | register.simple_tag(return_empty_context, name='recaptcha_execute') 53 | -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/tests.py: -------------------------------------------------------------------------------- 1 | import json 2 | import os 3 | import mock 4 | 5 | from django.forms import Form 6 | from django.test import TestCase 7 | 8 | from snowpenguin.django.recaptcha3.fields import ReCaptchaField 9 | from snowpenguin.django.recaptcha3.widgets import ReCaptchaHiddenInput 10 | 11 | 12 | class RecaptchaTestForm(Form): 13 | recaptcha = ReCaptchaField(widget=ReCaptchaHiddenInput()) 14 | 15 | 16 | class TestRecaptchaForm(TestCase): 17 | def test_dummy_validation(self): 18 | os.environ['RECAPTCHA_DISABLE'] = 'True' 19 | 20 | # form should validate without a 'g-recaptcha-response' 21 | form = RecaptchaTestForm({}) 22 | s = self.assertTrue(form.is_valid()) 23 | # NOTE: no mocked response is returned 24 | self.assertEqual(form.cleaned_data['recaptcha'], {}) 25 | del os.environ['RECAPTCHA_DISABLE'] 26 | 27 | def test_dummy_validation_canfail(self): 28 | os.environ['RECAPTCHA_DISABLE'] = json.dumps({'score': 0.4, 'hostname': 'localhost', 'action': 'homepage'}) 29 | form = RecaptchaTestForm({}) 30 | # NOTE: score_threshold validation is not performed when disabled 31 | self.assertTrue(form.is_valid()) 32 | self.assertEqual(form.cleaned_data['recaptcha'].get('score'), 0.4) 33 | self.assertEqual(form.cleaned_data['recaptcha'].get('hostname'), 'localhost') 34 | self.assertEqual(form.cleaned_data['recaptcha'].get('action'), 'homepage') 35 | 36 | @mock.patch('requests.post') 37 | def test_validate_error_invalid_token(self, requests_post): 38 | 39 | recaptcha_response = {'success': False} 40 | requests_post.return_value.json = lambda: recaptcha_response 41 | 42 | form = RecaptchaTestForm({"g-recaptcha-response": "dummy token"}) 43 | self.assertFalse(form.is_valid()) 44 | 45 | @mock.patch('requests.post') 46 | def test_validate_error_lower_score(self, requests_post): 47 | 48 | recaptcha_response = { 49 | 'success': True, 50 | 'score': 0.5 51 | } 52 | requests_post.return_value.json = lambda: recaptcha_response 53 | 54 | class RecaptchaTestForm(Form): 55 | recaptcha = ReCaptchaField(score_threshold=0.7) 56 | form = RecaptchaTestForm({"g-recaptcha-response": "dummy token"}) 57 | self.assertFalse(form.is_valid()) 58 | self.assertEqual(form.errors['recaptcha'][0], 'reCaptcha score is too low. score: 0.5') 59 | 60 | @mock.patch('requests.post') 61 | def test_validate_success_highter_score(self, requests_post): 62 | 63 | recaptcha_response = { 64 | 'success': True, 65 | 'score': 0.7, 66 | 'hostname': 'example.com', 67 | 'action': 'click' 68 | } 69 | requests_post.return_value.json = lambda: recaptcha_response 70 | 71 | class RecaptchaTestForm(Form): 72 | recaptcha = ReCaptchaField(score_threshold=0.4) 73 | form = RecaptchaTestForm({"g-recaptcha-response": "dummy token"}) 74 | self.assertTrue(form.is_valid()) 75 | self.assertEqual(form.cleaned_data['recaptcha'].get('score'), 0.7) 76 | self.assertEqual(form.cleaned_data['recaptcha'].get('hostname'), 'example.com') 77 | self.assertEqual(form.cleaned_data['recaptcha'].get('action'), 'click') 78 | 79 | @mock.patch('requests.post') 80 | def test_settings_score_threshold(self, requests_post): 81 | 82 | recaptcha_response = { 83 | 'success': True, 84 | 'score': 0.6 85 | } 86 | requests_post.return_value.json = lambda: recaptcha_response 87 | 88 | class RecaptchaTestForm(Form): 89 | recaptcha = ReCaptchaField() 90 | form = RecaptchaTestForm({"g-recaptcha-response": "dummy token"}) 91 | self.assertTrue(form.is_valid()) 92 | 93 | @mock.patch('requests.post') 94 | def test_settings_score_threshold_override_fields(self, requests_post): 95 | 96 | recaptcha_response = { 97 | 'success': True, 98 | 'score': 0.6 99 | } 100 | requests_post.return_value.json = lambda: recaptcha_response 101 | 102 | with self.settings(RECAPTCHA_SCORE_THRESHOLD=0.7): 103 | class RecaptchaTestForm(Form): 104 | recaptcha = ReCaptchaField() 105 | 106 | form = RecaptchaTestForm({"g-recaptcha-response": "dummy token"}) 107 | self.assertFalse(form.is_valid()) 108 | 109 | @mock.patch('requests.post') 110 | def test_settings_score_threshold_override_each_fields(self, requests_post): 111 | 112 | recaptcha_response = { 113 | 'success': True, 114 | 'score': 0.4 115 | } 116 | requests_post.return_value.json = lambda: recaptcha_response 117 | 118 | with self.settings(RECAPTCHA_SCORE_THRESHOLD=0.7): 119 | class RecaptchaTestForm(Form): 120 | recaptcha = ReCaptchaField() 121 | 122 | class RecaptchaOverrideTestForm(Form): 123 | recaptcha = ReCaptchaField(score_threshold=0.3) 124 | 125 | form1 = RecaptchaTestForm({"g-recaptcha-response": "dummy token"}) 126 | self.assertFalse(form1.is_valid()) 127 | 128 | form2 = RecaptchaOverrideTestForm({"g-recaptcha-response": "dummy token"}) 129 | self.assertTrue(form2.is_valid()) 130 | 131 | @mock.patch('requests.post') 132 | def test_validate_success(self, requests_post): 133 | 134 | recaptcha_response = { 135 | 'success': True, 136 | 'score': 0.5 137 | } 138 | requests_post.return_value.json = lambda: recaptcha_response 139 | 140 | form = RecaptchaTestForm({"g-recaptcha-response": "dummy token"}) 141 | self.assertTrue(form.is_valid()) 142 | -------------------------------------------------------------------------------- /snowpenguin/django/recaptcha3/widgets.py: -------------------------------------------------------------------------------- 1 | from django.forms.widgets import Input 2 | 3 | 4 | class ReCaptchaHiddenInput(Input): 5 | input_type = 'hidden' 6 | template_name = 'snowpenguin/recaptcha/recaptcha_hidden_input.html' 7 | 8 | def value_from_datadict(self, data, files, name): 9 | return [data.get('g-recaptcha-response', None)] 10 | -------------------------------------------------------------------------------- /sonar-project.properties: -------------------------------------------------------------------------------- 1 | sonar.projectKey=kbytesys_django-recaptcha3 2 | sonar.organization=kbytesys-github 3 | sonar.projectName=Django reCAPTCHA3 4 | sonar.projectVersion=0.2.0 5 | sonar.sources=snowpenguin/ 6 | -------------------------------------------------------------------------------- /test_settings.py: -------------------------------------------------------------------------------- 1 | DATABASES = { 2 | 'default': { 3 | 'ENGINE': 'django.db.backends.sqlite3', 4 | 'NAME': 'test.sqlite', 5 | } 6 | } 7 | 8 | INSTALLED_APPS = ( 9 | 'snowpenguin.django.recaptcha3', 10 | ) 11 | 12 | RECAPTCHA_PRIVATE_KEY = 'your private key' 13 | RECAPTCHA_PUBLIC_KEY = 'your public key' 14 | RECAPTCHA_DEFAULT_ACTION = 'generic' 15 | RECAPTCHA_SCORE_THRESHOLD = 0.5 16 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = 3 | {py27}-{1.8,1.9,1.10,1.11}, 4 | {py34}-{1.8,1.9,1.10,1.11,2.0}, 5 | {py35,py36,py37}-{1.8,1.9,1.10,1.11,2.0,2.1,latest} 6 | 7 | [testenv] 8 | basepython = 9 | py27: python2.7 10 | py34: python3.4 11 | py35: python3.5 12 | py36: python3.6 13 | py37: python3.7 14 | commands= 15 | pip install git+git://github.com/kbytesys/django-setuptest.git@feature/pep8_config 16 | python setup.py test 17 | deps = 18 | mock 19 | 1.8: Django>=1.8,<1.9 20 | 1.9: Django>=1.9,<1.10 21 | 1.10: Django>=1.10,<1.11 22 | 1.11: Django>=1.11,<2.0 23 | 2.0: Django>=2.0,<2.1 24 | 2.1: Django>=2.1,<2.2 25 | latest: Django<3 26 | --------------------------------------------------------------------------------