botswat

Documentation

Index

• Variables
• func New(withOptions ...Option) (oakhttp.Middleware, error)
• func NewErrorFromCodes(codes ...string) error
• type Botswat
• type Cache
• type CacheAdaptor
• type Error
  • func (err Error) Error() string
• type Option
  • func WithCache(c Cache) Option
  • func WithCacheAdaptor(adaptor CacheAdaptor) Option
  • func WithCookieResponseExtractor(name string) Option
  • func WithDefaultOptions() Option
  • func WithResponseExtractor(e ResponseExtractor) Option
  • func WithVerifier(v Verifier) Option
• type ResponseExtractor
• type Verifier

Variables

var ErrNotHuman = errors.New("robot detected")

Functions

func New

func New(withOptions ...Option) (oakhttp.Middleware, error)

func NewErrorFromCodes

func NewErrorFromCodes(codes ...string) error

Types

type Botswat

type Botswat interface {
	ResponseTokenPrompt() []byte

	// VerifyResponseToken should return `nil` for valid tokens, [ErrNotHuman] for rejected tokens, or an [Error] for any other condition.
	//
	// A response may only be validated once. If the same response is presented twice, the second and each subsequent request will generate an error stating that the response has already been consumed.
	VerifyResponseToken(
		ctx context.Context,
		clientToken string,
		clientIPAddress string,
	) error
}

type Cache

type Cache func(Verifier) Verifier

type CacheAdaptor

type CacheAdaptor interface {
	Get(context.Context, []byte) ([]byte, error)
	Set(context.Context, []byte, []byte) error
}

type Error

type Error string

const (
	ErrMissingInputSecret   Error = "missing-input-secret"
	ErrInvalidInputSecret   Error = "invalid-input-secret"
	ErrMissingInputResponse Error = "missing-input-response"
	ErrInvalidInputResponse Error = "invalid-input-response"
	ErrBadRequest           Error = "bad-request"
	ErrTimeoutOrDuplicate   Error = "timeout-or-duplicate"
	ErrInternalError        Error = "internal-error"
)

func (Error) Error

func (err Error) Error() string

type Option

type Option func(*options) error

func WithCache

func WithCache(c Cache) Option

func WithCacheAdaptor

func WithCacheAdaptor(adaptor CacheAdaptor) Option

func WithCookieResponseExtractor

func WithCookieResponseExtractor(name string) Option

func WithDefaultOptions

func WithDefaultOptions() Option

func WithResponseExtractor

func WithResponseExtractor(e ResponseExtractor) Option

func WithVerifier

func WithVerifier(v Verifier) Option

type ResponseExtractor

type ResponseExtractor func(
	r *http.Request,
) (
	clientResponseToken string,
	err error,
)

type Verifier

type Verifier func(
	ctx context.Context,
	clientResponseToken string,
	clientIPAddress string,
) (
	userData string,
	err error,
)

Verifier returns ErrNotHuman if client response was not recognized as valid.

A response may only be validated once. If the same response is presented twice, the second and each subsequent request will generate an error stating that the response has already been consumed.