README
¶
hcaptcha
Package hcaptcha is a middleware that provides hCaptcha rendering integration for Flamego.
Installation
The minimum requirement of Go is 1.18.
go get github.com/flamego/hcaptcha
Getting started
<!-- templates/home.tmpl -->
<html>
<head>
<script src="https://hcaptcha.com/1/api.js"></script>
</head>
<body>
<form method="POST">
<div class="h-captcha" data-sitekey="{{.SiteKey}}"></div>
<input type="submit" name="button" value="Submit">
</form>
</body>
</html>
package main
import (
"fmt"
"net/http"
"github.com/flamego/flamego"
"github.com/flamego/hcaptcha"
"github.com/flamego/template"
)
func main() {
f := flamego.Classic()
f.Use(template.Templater())
f.Use(hcaptcha.Captcha(
hcaptcha.Options{
Secret: "<SECRET>",
},
))
f.Get("/", func(t template.Template, data template.Data) {
data["SiteKey"] = "<SITE KEY>"
t.HTML(http.StatusOK, "home")
})
f.Post("/", func(w http.ResponseWriter, r *http.Request, h hcaptcha.HCaptcha) {
token := r.PostFormValue("h-captcha-response")
resp, err := h.Verify(token)
if err != nil {
w.WriteHeader(http.StatusBadRequest)
_, _ = w.Write([]byte(err.Error()))
return
} else if !resp.Success {
w.WriteHeader(http.StatusBadRequest)
_, _ = w.Write([]byte(fmt.Sprintf("Verification failed, error codes %v", resp.ErrorCodes)))
return
}
w.WriteHeader(http.StatusOK)
_, _ = w.Write([]byte("Verified!"))
})
f.Run()
}
Getting help
- Read documentation and examples.
- Please file an issue or start a discussion on the flamego/flamego repository.
License
This project is under the MIT License. See the LICENSE file for the full license text.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type HCaptcha ¶
type HCaptcha interface {
// Verify verifies the given token. An optional remote IP of the user may be
// passed as extra security criteria.
Verify(token string, remoteIP ...string) (*Response, error)
}
HCaptcha is a hCaptcha verify service.
type Options ¶
type Options struct {
// Client the HTTP client to make requests. The default is http.DefaultClient.
Client *http.Client
// Secret is the secret key to check user captcha codes. This field is required.
Secret string
}
Options contains options for both hcaptcha.Captcha middleware.
type Response ¶
type Response struct {
// Success indicates whether the passcode valid, and does it meet security
// criteria you specified.
Success bool `json:"success"`
// ChallengeTS is the timestamp of the challenge (ISO format
// yyyy-MM-dd'T'HH:mm:ssZZ).
ChallengeTS time.Time `json:"challenge_ts"`
// Hostname is the hostname of the site where the challenge was solved.
Hostname string `json:"hostname"`
// Credit indicates whether the response will be credited.
Credit bool `json:"credit"`
// ErrorCodes contains the error codes when verify failed.
ErrorCodes []string `json:"error-codes"`
}
Response is the response struct which hCaptcha sends back.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.