Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/euantorano/recaptcha.nim
reCAPTCHA support for Nim, supporting rendering a capctcha and verifying a user's response.
https://github.com/euantorano/recaptcha.nim
captcha nim recaptcha
Last synced: about 1 month ago
JSON representation
reCAPTCHA support for Nim, supporting rendering a capctcha and verifying a user's response.
- Host: GitHub
- URL: https://github.com/euantorano/recaptcha.nim
- Owner: euantorano
- License: bsd-3-clause
- Created: 2017-03-06T20:19:06.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-04-15T21:24:20.000Z (almost 5 years ago)
- Last Synced: 2024-11-08T04:44:11.556Z (3 months ago)
- Topics: captcha, nim, recaptcha
- Language: Nim
- Size: 22.5 KB
- Stars: 16
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# reCAPTCHA
reCAPTCHA support for Nim, supporting rendering a capctcha and verifying a user's response. This library supports reCaptcha from:
* https://www.google.com/recaptcha/admin
* https://recaptcha.net
* https://hcaptcha.com
## Installation
```
nimble install recaptcha
```
## Usage
Before using this modul, be sure to register at the reCaptcha providers website in order to get your client secret and site key. These are required to use this module. Register at:
* [Google reCaptcha](https://www.google.com/recaptcha/admin)
* [hCaptcha](https://hcaptcha.com)
Once you have your client secret and site key, you should create an instance of `ReCaptcha`:
```nim
import recaptcha
let captcha = initReCaptcha("MY_SECRET_KEY", "MY_SITE_KEY", Google)
#let captcha = initReCaptcha("MY_SECRET_KEY", "MY_SITE_KEY", RecaptchaNet) <-- using recaptcha.net
#let captcha = initReCaptcha("MY_SECRET_KEY", "MY_SITE_KEY", Hcaptcha) <-- using hcaptcha.com
```
You can print out the required HTML code to show the reCAPTCHA element on the page using the `render` method:
```nim
import recaptcha
let captcha = initReCaptcha("MY_SECRET_KEY", "MY_SITE_KEY", Google)
echo captcha.render()
```
(or you can use the `$` stringify shortcut to achieve the same thing)
Once the user has submitted the captcha back to you, you should verify their response:
```nim
import recaptcha, asyncdispatch
let captcha = initReCaptcha("MY_SECRET_KEY", "MY_SITE_KEY", Google)
let response = await captcha.verify(THEIR_RESPONSE)
```
If the user is a valid user, `response` will be `true`. Otherwise, it will be `false`.
Should there be an issue with the data sent to the reCAPTCHA service, an exception of type `CaptchaVerificationError` will be thrown.
In most cases, captchas are used within a HTML `` element. In this case, the user's response will be available within form parameter named `g-recaptcha-response` for `Google` and `reCaptha.net` and within `h-recaptcha-repsonse` for `hCaptcha`.
You may also optionally pass the user's IP address along to reCAPTCHA during verification as an extra check:
```nim
import recaptcha, asyncdispatch
let captcha = initReCaptcha("MY_SECRET_KEY", "MY_SITE_KEY", Google)
let response = await captcha.verify(THEIR_RESPONSE, USERS_IP_ADDRESS)
```
# Example
The example below uses `Google` as validator.
```nim
import recaptcha, asyncdispatch, jester
from strutils import format
const htmlForm = """
Verify
"""
let
secretKey = "123456789"
siteKey = "987654321"
captcha = initReCaptcha(secretKey, siteKey, Google)
routes:
get "/login":
resp(htmlForm.format(siteKey))
post "/verify":
let checkCap = await captcha.verify(@"g-recaptcha-response")
if checkCap:
resp("Welcome")
else:
resp("You failed the captcha")
```