README
¶
reCAPTCHA for Go
Installation
go get -u github.com/sj14/recaptcha
Usage
The result will always return an error when any kind of failure occured, thus only checking the error is sufficient.
reCAPTCHA v2
HTML
<html>
<head>
<script src="https://www.google.com/recaptcha/api.js" async defer></script>
</head>
<body>
<form action="?" method="POST">
<div class="g-recaptcha" data-sitekey="<YOUR_SITE_KEY>"></div>
<br/>
<input type="submit" value="Submit">
</form>
</body>
</html>
Go
result, err := recaptcha.VerifyV2(recaptchaSecret, httpRequest)
if err != nil {
log.Fatalf("recaptcha failed: %v\n", err)
}
// result is not necessary to check, only required for more details
reCAPTCHA v3
HTML
<html>
<head>
<script src="https://www.google.com/recaptcha/api.js?render=<YOUR_SITE_KEY>"></script>
<script>
grecaptcha.ready(function () {
grecaptcha.execute('<YOUR_SITE_KEY>', { action: 'register' }).then(function (token) {
var recaptchaResponse = document.getElementById('g-recaptcha-response');
recaptchaResponse.value = token;
});
});
</script>
</head>
<body>
<form method="POST" action="/register">
<input type="hidden" name="g-recaptcha-response" id="g-recaptcha-response">
<input type="submit" value="Submit">
</form>
</body>
Go
Without options:
result, err := recaptcha.VerifyV3(recaptchaSecret, httpRequest)
if err != nil {
log.Fatalf("recaptcha failed: %v\n", err)
}
// result is not necessary to check, only required for more details
With options:
// The default action is empty ("") and thus not checked.
// The default minimum required score is 0.5
result, err := recaptcha.VerifyV3(recaptchaSecret, httpRequest, recaptcha.Action("register"), recaptcha.MinScore(0.7))
if err != nil {
log.Fatalf("recaptcha failed: %v\n", err)
}
// result is not necessary to check, only required for more details
Documentation
¶
Overview ¶
based on https://www.socketloop.com/tutorials/golang-recaptcha-example
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrNoCaptcha is returned when the form value 'g-recaptcha-response' is empty ErrNoCaptcha = errors.New("missing recaptcha response in request") // ErrNoSuccess is returned when the recaptcha request was not successful. ErrNoSuccess = errors.New("request was not successful") // ErrScore is returned when the calculated score is below the required score (V3 only). ErrScore = errors.New("request was below the required score") // ErrAction is returned when the action is not the required one (V3 only). ErrAction = errors.New("wrong action") )
Functions ¶
This section is empty.
Types ¶
type OptionV3 ¶
type OptionV3 func(*optionsV3)
OptionV3 are optional settings for reCAPTCHA V3 validations.
type ResponseV2 ¶
type ResponseV2 struct {
Success bool `json:"success"`
ChallengeTS time.Time `json:"challenge_ts"` // timestamp of the challenge load (ISO format yyyy-MM-dd'T'HH:mm:ssZZ)
Hostname string `json:"hostname"` // the hostname of the site where the reCAPTCHA was solved
ErrorCodes []string `json:"error-codes"` // optional
}
ResponseV2 is a reCAPTCHA v2 response.
type ResponseV3 ¶
type ResponseV3 struct {
Score float64 `json:"score"`
Action string `json:"action"`
ResponseV2
}
ResponseV3 is a reCAPTCHA v3 response.
Source Files
Click to show internal directories.
Click to hide internal directories.