oakbotswat

Documentation

Index

• Constants
• Variables
• func NewErrorFromCodes(codes ...string) error
• type Cache
• type Error
  • func (err Error) Error() string
• type HumanityTokenExtractor
• type MapCache
  • func NewMapCache(d time.Duration, recordLimit int) *MapCache
  • func (m *MapCache) GetToken(ctx context.Context, key string) (string, bool, error)
  • func (m *MapCache) SetToken(ctx context.Context, key, value string) error
• type OakBotSWAT
  • func New(withOptions ...Option) (b *OakBotSWAT, err error)
  • func (b *OakBotSWAT) Gate(onError oakhttp.Encoder) oakhttp.Middleware
  • func (b *OakBotSWAT) IsHuman(r *http.Request) error
  • func (b *OakBotSWAT) Middleware() oakhttp.Middleware
• type Option
  • func WithCache(c Cache) Option
  • func WithCookieHumanityTokenExtractor(name string) Option
  • func WithDefaultCookieHumanityTokenExtractor() Option
  • func WithDefaultHeaderHumanityTokenExtractor() Option
  • func WithHeaderHumanityTokenExtractor(name string) Option
  • func WithHumanityTokenExtractor(e HumanityTokenExtractor) Option
  • func WithVerifier(v Verifier) Option
• type TemplateOption
  • func WithCookieDuration(d time.Duration) TemplateOption
  • func WithCookieName(name string) TemplateOption
  • func WithDescription(description string) TemplateOption
  • func WithErrorURL(URL string) TemplateOption
  • func WithLocale(key string) TemplateOption
  • func WithTitle(title string) TemplateOption
• type TemplateOptions
  • func NewTemplateOptions(all ...TemplateOption) (*TemplateOptions, error)
• type UserData
• type Verifier

Constants

const (
	DefaultCookieName = "HumanityToken"
	DefaultHeaderName = "HumanityToken"
)

Variables

var ErrCacheFull = errors.New("there are too many cache records")

var ErrTokenEmpty = errors.New("cannot recover request token proving humanity: token is empty")

var Template string

Functions

func NewErrorFromCodes

func NewErrorFromCodes(codes ...string) error

Types

type Cache

type Cache interface {
	GetToken(ctx context.Context, key string) (string, bool, error)
	SetToken(ctx context.Context, key, value string) 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 HumanityTokenExtractor

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

type MapCache

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

func NewMapCache

func NewMapCache(d time.Duration, recordLimit int) *MapCache

func (*MapCache) GetToken

func (m *MapCache) GetToken(ctx context.Context, key string) (string, bool, error)

func (*MapCache) SetToken

func (m *MapCache) SetToken(ctx context.Context, key, value string) error

type OakBotSWAT

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

func New

func New(withOptions ...Option) (b *OakBotSWAT, err error)

func (*OakBotSWAT) Gate

func (b *OakBotSWAT) Gate(onError oakhttp.Encoder) oakhttp.Middleware

func (*OakBotSWAT) IsHuman

func (b *OakBotSWAT) IsHuman(r *http.Request) error

IsHuman returns `nil` for human agents, an Error if humanity Verifier was not passed, or an [error] for any other condition. In rare cases when you need access to user data proven by the UI library, such as the Turnstile implementation, use that Verifier directly.

func (*OakBotSWAT) Middleware

func (b *OakBotSWAT) Middleware() oakhttp.Middleware

type Option

type Option func(*options) error

func WithCache

func WithCache(c Cache) Option

func WithCookieHumanityTokenExtractor

func WithCookieHumanityTokenExtractor(name string) Option

func WithDefaultCookieHumanityTokenExtractor

func WithDefaultCookieHumanityTokenExtractor() Option

func WithDefaultHeaderHumanityTokenExtractor

func WithDefaultHeaderHumanityTokenExtractor() Option

func WithHeaderHumanityTokenExtractor

func WithHeaderHumanityTokenExtractor(name string) Option

func WithHumanityTokenExtractor

func WithHumanityTokenExtractor(e HumanityTokenExtractor) Option

func WithVerifier

func WithVerifier(v Verifier) Option

type TemplateOption

type TemplateOption func(*TemplateOptions) error

func WithCookieDuration

func WithCookieDuration(d time.Duration) TemplateOption

func WithCookieName

func WithCookieName(name string) TemplateOption

func WithDescription

func WithDescription(description string) TemplateOption

func WithErrorURL

func WithErrorURL(URL string) TemplateOption

func WithLocale

func WithLocale(key string) TemplateOption

func WithTitle

func WithTitle(title string) TemplateOption

type TemplateOptions

type TemplateOptions struct {
	Locale         string
	Title          string
	Description    string
	ErrorURL       string
	CookieName     string
	CookieDuration time.Duration
}

func NewTemplateOptions

func NewTemplateOptions(all ...TemplateOption) (*TemplateOptions, error)

type UserData

type UserData struct {
	Data    string
	Expires time.Time
}

type Verifier

type Verifier interface {
	VerifyHumanityToken(
		ctx context.Context,
		clientResponseToken string,
		clientIPAddress string,
	) (
		userData string,
		err error,
	)
}

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