captcha

package
v0.1.21 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 28, 2026 License: MIT Imports: 26 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidToken     = errors.New("security captcha: invalid token")
	ErrProviderNotFound = errors.New("security captcha: provider not found")
)

Functions

This section is empty.

Types

type BackgroundSource added in v0.1.4

type BackgroundSource interface {
	Pick(ctx context.Context, width int, height int) (image.Image, error)
}

type Base64Option

type Base64Option func(*base64Options)

func WithBase64DigitSize

func WithBase64DigitSize(height, width, length int) Base64Option

func WithBase64Driver

func WithBase64Driver(driver base64Captcha.Driver) Base64Option

func WithBase64Store

func WithBase64Store(store base64Captcha.Store) Base64Option

func WithBase64TTL

func WithBase64TTL(ttl time.Duration) Base64Option

type Base64Provider

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

func NewBase64Provider

func NewBase64Provider(opts ...Base64Option) *Base64Provider

func (*Base64Provider) Generate

func (p *Base64Provider) Generate(ctx context.Context, opts GenerateOptions) (*Challenge, error)

func (*Base64Provider) Kind

func (p *Base64Provider) Kind() Kind

func (*Base64Provider) Name

func (p *Base64Provider) Name() string

func (*Base64Provider) Verify

func (p *Base64Provider) Verify(ctx context.Context, id string, answer string) error

type Base64Store added in v0.1.4

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

func NewBase64Store added in v0.1.4

func NewBase64Store(store store.Store, ttl time.Duration) *Base64Store

func (*Base64Store) Get added in v0.1.4

func (s *Base64Store) Get(id string, clear bool) string

func (*Base64Store) Set added in v0.1.4

func (s *Base64Store) Set(id string, value string) error

func (*Base64Store) Verify added in v0.1.4

func (s *Base64Store) Verify(id string, answer string, clear bool) bool

type Challenge

type Challenge struct {
	ID       string         `json:"id"`
	Kind     Kind           `json:"kind"`
	Image    string         `json:"image,omitempty"`
	Audio    string         `json:"audio,omitempty"`
	Payload  map[string]any `json:"payload,omitempty"`
	ExpireAt time.Time      `json:"expire_at,omitempty"`
}

type ClickOption added in v0.1.4

type ClickOption func(*clickOptions)

func WithClickBackgroundSource added in v0.1.4

func WithClickBackgroundSource(source BackgroundSource) ClickOption

func WithClickMaxAttempts added in v0.1.4

func WithClickMaxAttempts(maxAttempts int) ClickOption

func WithClickSize added in v0.1.4

func WithClickSize(width int, height int) ClickOption

func WithClickTargets added in v0.1.4

func WithClickTargets(targets int) ClickOption

func WithClickTolerance added in v0.1.4

func WithClickTolerance(tolerance int) ClickOption

type ClickProvider added in v0.1.4

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

func NewClickProvider added in v0.1.4

func NewClickProvider(store store.Store, ttl time.Duration, opts ...ClickOption) *ClickProvider

func (*ClickProvider) Generate added in v0.1.4

func (p *ClickProvider) Generate(ctx context.Context, opts GenerateOptions) (*Challenge, error)

func (*ClickProvider) Kind added in v0.1.4

func (p *ClickProvider) Kind() Kind

func (*ClickProvider) Name added in v0.1.4

func (p *ClickProvider) Name() string

func (*ClickProvider) Verify added in v0.1.4

func (p *ClickProvider) Verify(ctx context.Context, id string, answer string) error

type ClientTokenProvider added in v0.1.4

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

func NewClientClickProvider added in v0.1.4

func NewClientClickProvider(store store.Store, ttl time.Duration) *ClientTokenProvider

func NewClientSliderProvider added in v0.1.4

func NewClientSliderProvider(store store.Store, ttl time.Duration) *ClientTokenProvider

func (*ClientTokenProvider) Generate added in v0.1.4

func (*ClientTokenProvider) Kind added in v0.1.4

func (p *ClientTokenProvider) Kind() Kind

func (*ClientTokenProvider) Name added in v0.1.4

func (p *ClientTokenProvider) Name() string

func (*ClientTokenProvider) Verify added in v0.1.4

func (p *ClientTokenProvider) Verify(ctx context.Context, id string, answer string) error

type FileBackgroundSource added in v0.1.4

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

func NewFileBackgroundSource added in v0.1.4

func NewFileBackgroundSource(dir string) *FileBackgroundSource

func (*FileBackgroundSource) Pick added in v0.1.4

func (s *FileBackgroundSource) Pick(ctx context.Context, width int, height int) (image.Image, error)

type GenerateOptions

type GenerateOptions struct {
	TTL time.Duration
}

type Kind

type Kind string
const (
	KindImage        Kind = "image"
	KindSlider       Kind = "slider"
	KindClientSlider Kind = "client-slider"
	KindClick        Kind = "click"
	KindClientClick  Kind = "client-click"
)

type Manager

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

func NewManager

func NewManager(providers ...Provider) *Manager

func (*Manager) Generate

func (m *Manager) Generate(ctx context.Context, kind Kind, opts GenerateOptions) (*Challenge, error)

func (*Manager) ProviderName

func (m *Manager) ProviderName(kind Kind) string

func (*Manager) Register

func (m *Manager) Register(provider Provider)

func (*Manager) Verify

func (m *Manager) Verify(ctx context.Context, kind Kind, id string, answer string) error

type MemoryProvider

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

func NewMemoryProvider

func NewMemoryProvider(tokens ...string) *MemoryProvider

func (*MemoryProvider) Add

func (p *MemoryProvider) Add(token string)

func (*MemoryProvider) Generate

func (p *MemoryProvider) Generate(ctx context.Context, opts GenerateOptions) (*Challenge, error)

func (*MemoryProvider) Kind

func (p *MemoryProvider) Kind() Kind

func (*MemoryProvider) Name

func (p *MemoryProvider) Name() string

func (*MemoryProvider) Verify

func (p *MemoryProvider) Verify(ctx context.Context, id string, answer string) error

type NoopProvider

type NoopProvider struct{}

func (NoopProvider) Generate

func (NoopProvider) Generate(ctx context.Context, opts GenerateOptions) (*Challenge, error)

func (NoopProvider) Kind

func (NoopProvider) Kind() Kind

func (NoopProvider) Name

func (NoopProvider) Name() string

func (NoopProvider) Verify

func (NoopProvider) Verify(ctx context.Context, id string, answer string) error

type Provider

type Provider interface {
	Name() string
	Kind() Kind
	Generate(ctx context.Context, opts GenerateOptions) (*Challenge, error)
	Verify(ctx context.Context, id string, answer string) error
}

type SliderOption added in v0.1.4

type SliderOption func(*sliderOptions)

func WithSliderBackgroundSource added in v0.1.4

func WithSliderBackgroundSource(source BackgroundSource) SliderOption

func WithSliderMaxAttempts added in v0.1.4

func WithSliderMaxAttempts(maxAttempts int) SliderOption

func WithSliderMinDuration added in v0.1.4

func WithSliderMinDuration(duration time.Duration) SliderOption

func WithSliderPieceSize added in v0.1.4

func WithSliderPieceSize(size int) SliderOption

func WithSliderSize added in v0.1.4

func WithSliderSize(width int, height int) SliderOption

func WithSliderTolerance added in v0.1.4

func WithSliderTolerance(tolerance int) SliderOption

type SliderProvider added in v0.1.4

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

func NewSliderProvider added in v0.1.4

func NewSliderProvider(store store.Store, ttl time.Duration, opts ...SliderOption) *SliderProvider

func (*SliderProvider) Generate added in v0.1.4

func (p *SliderProvider) Generate(ctx context.Context, opts GenerateOptions) (*Challenge, error)

func (*SliderProvider) Kind added in v0.1.4

func (p *SliderProvider) Kind() Kind

func (*SliderProvider) Name added in v0.1.4

func (p *SliderProvider) Name() string

func (*SliderProvider) Verify added in v0.1.4

func (p *SliderProvider) Verify(ctx context.Context, id string, answer string) error

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL