dpapathanasiou / go-recaptcha

A package for handling reCaptcha (http://www.google.com/recaptcha) form submissions in Go (http://golang.org/).

go-recaptcha

https://godoc.org/github.com/dpapathanasiou/go-recaptcha

About

This package handles reCaptcha (API versions 2 and 3) form submissions in Go.

Usage

Install the package in your environment:

go get github.com/dpapathanasiou/go-recaptcha

To use it within your own code, import github.com/dpapathanasiou/go-recaptcha and call:

recaptcha.Init (recaptchaPrivateKey)

once, to set the reCaptcha private key for your domain, then:

recaptcha.Confirm (clientIpAddress, recaptchaResponse)

reCAPTCHA v2

For each reCaptcha form input you need to check, using the values obtained by reading the form's POST parameters (the recaptchaResponse in the above corresponds to the value of g-recaptcha-response sent by the reCaptcha server.)

The recaptcha.Confirm() function returns either true (i.e., the captcha was completed correctly) or false, along with any errors (from the HTTP io read or the attempt to unmarshal the JSON reply).

reCAPTCHA v3

Version 3 works differently: instead of interrupting page visitors with a prompt, it runs in the background, computing a score.

This repo has been updated to handle the score and action in the response, but the usage example is still in terms of version 2.

Usage Example

Included with this repo is example.go, a simple HTTP server which creates the reCaptcha form and tests the input.

See the instructions for running the example for more details.

Donate

If you find this work useful, please consider making a donation:

Bitcoin Donate 14TM4ADKJbaGEi8Qr8dh4KfPBQmjTshkZ2

go-recaptcha's Issues

Feature: documentation

Hello,

It would be great if go-recaptcha had godocs that showed the available structs and options. Some documentation would help determine what types to use, for instance.

Thanks for considering!

Missing returns in func check()

https://github.com/dpapathanasiou/go-recaptcha/blob/master/recaptcha.go#L33. If you don't return after errors in this function you're going to have a bad day.

public Check function

I think it will be nice to have the check function public. Because checking succcess is not enough and sometimes you need read error-codes, action and especially score for detailed validation.

so.. just merge pull request #13 please.

Go vet warnings

.../vendor/github.com/dpapathanasiou/go-recaptcha/recaptcha.go recaptcha.go:42: possible formatting directive in Println call recaptcha.go:46: possible formatting directive in Println call exit status 1

ErrorCodes are now a list of strings

Was trying out this recaptcha library but got into some errors that needed troubleshooting.

Read error: got invalid JSON: json: cannot unmarshal string into Go struct field 
RecaptchaResponse.error-codes of type int

According to reCAPTCHA documentation on Verifying the user's response, error-codes are now a list of strings.

Changing RecaptchaResponse should avoid the error.

type RecaptchaResponse struct {
	Success     bool      `json:"success"`
	ChallengeTS time.Time `json:"challenge_ts"`
	Hostname    string    `json:"hostname"`
	ErrorCodes  []string  `json:"error-codes"`
}

Thought this information might be helpful :)

Can remote-ip parameter leave blanked?

This is my first time using recaptcha, and it is said that the remote-ip parameter is optional, could you fix it?