turnstile

README

Turnstile

A simple Go utility to validate Cloudflare Turnstile tokens.

Documentation at https://pkg.go.dev/github.com/meblum/turnstile.

Basic Usage

package main

import (
	"github.com/meblum/turnstile"
)

func main() {

	verifier := turnstile.NewVerifier("my-secret", nil)

	response, err := verifier.Verify("client-token", "", "")

	if err != nil {
		// error verifying, handle error
        return
	}
    if !response.Success {
		// verification failed, loop on response.ErrorCodes for more info 
        return
	}
	// token valid
}

Licence

MIT License

Copyright (c) 2023 Meir Blumenfeld

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Documentation

Index

• type Response
• type Verifier
  • func NewVerifier(secret string, httpClient *http.Client) *Verifier
  • func (v *Verifier) Verify(token, remoteIP, idempotencyKey string) (*Response, error)

Types

type Response

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

Response is the response received from cloudflare siteverify endpoint.

type Verifier

type Verifier struct {
	// contains filtered or unexported fields
}

Verifier verifies Cloudflare issued Turnstile tokens with the siteverify endpoint as described here https://developers.cloudflare.com/turnstile/get-started/server-side-validation/.

A verifier is safe for concurrent use by multiple goroutines.

func NewVerifier

func NewVerifier(secret string, httpClient *http.Client) *Verifier

NewVerifier returns an initialized Verifier. `secret` is the key obtained from cloudflare when creating the turnstile site. `httpClient` is used to post verification requests to the cloudflare endpoint, if nil, `http.DefaultClient` is used.

func (*Verifier) Verify

func (v *Verifier) Verify(token, remoteIP, idempotencyKey string) (*Response, error)

Verify verifies token with cloudflare. `remoteIP` and `idempotencyKey` are optional and omitted if empty.