69 lines
2.2 KiB
Markdown
69 lines
2.2 KiB
Markdown
# captcha
|
|
|
|
[](https://github.com/flamego/captcha/actions?query=workflow%3AGo)
|
|
[](https://app.codecov.io/gh/flamego/captcha)
|
|
[](https://pkg.go.dev/github.com/flamego/captcha?tab=doc)
|
|
[](https://sourcegraph.com/github.com/flamego/captcha)
|
|
|
|
Package captcha is a middleware that provides captcha service for [Flamego](https://github.com/flamego/flamego).
|
|
|
|
## Installation
|
|
|
|
The minimum requirement of Go is **1.16**.
|
|
|
|
go get github.com/flamego/captcha
|
|
|
|
## Getting started
|
|
|
|
```html
|
|
<!-- templates/home.tmpl -->
|
|
<form method="POST">
|
|
{{.CaptchaHTML}} <br>
|
|
<input name="captcha">
|
|
<button>Submit</button>
|
|
</form>
|
|
```
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/flamego/captcha"
|
|
"github.com/flamego/flamego"
|
|
"github.com/flamego/session"
|
|
"github.com/flamego/template"
|
|
)
|
|
|
|
func main() {
|
|
f := flamego.Classic()
|
|
f.Use(session.Sessioner())
|
|
f.Use(captcha.Captchaer())
|
|
f.Use(template.Templater())
|
|
|
|
f.Get("/", func(t template.Template, data template.Data, captcha captcha.Captcha) {
|
|
data["CaptchaHTML"] = captcha.HTML()
|
|
t.HTML(http.StatusOK, "home")
|
|
})
|
|
f.Post("/", func(c flamego.Context, captcha captcha.Captcha) {
|
|
if !captcha.ValidText(c.Request().FormValue("captcha")) {
|
|
c.ResponseWriter().WriteHeader(http.StatusBadRequest)
|
|
_, _ = c.ResponseWriter().Write([]byte(http.StatusText(http.StatusBadRequest)))
|
|
} else {
|
|
c.ResponseWriter().WriteHeader(http.StatusOK)
|
|
_, _ = c.ResponseWriter().Write([]byte(http.StatusText(http.StatusOK)))
|
|
}
|
|
})
|
|
|
|
f.Run()
|
|
}
|
|
```
|
|
|
|
## Getting help
|
|
|
|
- Please [file an issue](https://github.com/flamego/flamego/issues) or [start a discussion](https://github.com/flamego/flamego/discussions) on the [flamego/flamego](https://github.com/flamego/flamego) repository.
|
|
|
|
## License
|
|
|
|
This project is under the MIT License. See the [LICENSE](LICENSE) file for the full license text.
|