-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add docs from gofiber/contrib@a07a32f
- Loading branch information
1 parent
0521df1
commit fb2669a
Showing
2 changed files
with
85 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| --- | ||
| id: hcaptcha | ||
| --- | ||
|
|
||
| # HCaptcha | ||
|
|
||
|  | ||
| [](https://gofiber.io/discord) | ||
|  | ||
|  | ||
|  | ||
|
|
||
| A simple [HCaptcha](https://hcaptcha.com) middleware to prevent bot attacks. | ||
|
|
||
| :::note | ||
|
|
||
| Requires Go **1.21** and above | ||
|
|
||
| ::: | ||
|
|
||
| ## Install | ||
|
|
||
| :::caution | ||
|
|
||
| This middleware only supports Fiber **v3**. | ||
|
|
||
| ::: | ||
|
|
||
| ```shell | ||
| go get -u github.com/gofiber/fiber/v3 | ||
| go get -u github.com/gofiber/contrib/hcaptcha | ||
| ``` | ||
|
|
||
| ## Signature | ||
|
|
||
| ```go | ||
| hcaptcha.New(config hcaptcha.Config) fiber.Handler | ||
| ``` | ||
|
|
||
| ## Config | ||
|
|
||
| | Property | Type | Description | Default | | ||
| |:----------------|:----------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------| | ||
| | SecretKey | `string` | The secret key you obtained from the HCaptcha admin panel. This field must not be empty. | `""` | | ||
| | ResponseKeyFunc | `func(fiber.Ctx) (string, error)` | ResponseKeyFunc should return the token that captcha provides upon successful solving. By default, it gets the token from the body by parsing a JSON request and returns the `hcaptcha_token` field. | `hcaptcha.DefaultResponseKeyFunc` | | ||
| | SiteVerifyURL | `string` | This property specifies the API resource used for token authentication. | `https://api.hcaptcha.com/siteverify` | | ||
|
|
||
| ## Example | ||
|
|
||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "github.com/gofiber/contrib/hcaptcha" | ||
| "github.com/gofiber/fiber/v3" | ||
| "log" | ||
| ) | ||
|
|
||
| const ( | ||
| TestSecretKey = "0x0000000000000000000000000000000000000000" | ||
| TestSiteKey = "20000000-ffff-ffff-ffff-000000000002" | ||
| ) | ||
|
|
||
| func main() { | ||
| app := fiber.New() | ||
| captcha := hcaptcha.New(hcaptcha.Config{ | ||
| // Must set the secret key | ||
| SecretKey: TestSecretKey, | ||
| }) | ||
|
|
||
| app.Get("/api/", func(c fiber.Ctx) error { | ||
| return c.JSON(fiber.Map{ | ||
| "hcaptcha_site_key": TestSiteKey, | ||
| }) | ||
| }) | ||
|
|
||
| app.Post("/api/robots-excluded", func(c fiber.Ctx) error { | ||
| return c.SendString("You are not a robot") | ||
| }, captcha) | ||
|
|
||
| log.Fatal(app.Listen(":3000")) | ||
| } | ||
| ``` |