captcha

README

captcha

slide captcha

Documentation

Index

• Constants
• Variables
• type Captcha
  • func NewWithOptions(tp uint8, opts ...Option) Captcha
• type Dot
• type Option
  • func WithDriver(driver *captcha.Captcha) Option
  • func WithQuality(quality int) Option
  • func WithSlideBackDir(backDir string) Option
  • func WithSlideMaskDir(maskDir string) Option
  • func WithWordsZhBackImgList(backImgList []string) Option
  • func WithWordsZhCnChars(chars []string) Option
  • func WithWordsZhCnImgSize(size captcha.Size) Option
  • func WithWordsZhCnThumbSize(size captcha.Size) Option
• type Slide
  • func NewSlide(backDir, maskDir string, quality int) *Slide
  • func SlideWithBack(backDir string) *Slide
  • func SlideWithMask(maskDir string) *Slide
  • func (s *Slide) Check(dots string, dct map[int]Dot, span int) bool
  • func (s *Slide) Create() (dots map[int]Dot, b64 string, thumb64 string, key string, err error)
  • func (s *Slide) CreateCustom(r, quality int) (dots map[int]Dot, b64 string, thumb64 string, key string, err error)
  • func (s *Slide) CreateShape(img *image.RGBA, point image.Point, r int) *image.RGBA
• type WordsZhCn
  • func NewWordsZhCn(driver *captcha.Captcha) *WordsZhCn
  • func (wzc *WordsZhCn) Check(dots string, dct map[int]Dot, span int) bool
  • func (wzc *WordsZhCn) Create() (dots map[int]Dot, b64 string, thumb64 string, key string, err error)
  • func (wzc *WordsZhCn) Driver() *captcha.Captcha

Constants

const (
	TypeSlide     = 1
	TypeWordsZhCn = 2
)

const (
	MimePng  = `image/png`
	MimeJpg  = `image/jpg`
	MimeJpeg = `image/jpeg`
)

Variables

var (
	// DefaultSlide default slide driver object
	DefaultSlide = NewSlide("", "", 70)
)

var (
	ErrFormat = errors.New("mime format unsupported")
)

Types

type Captcha

type Captcha interface {
	Check(dots string, dct map[int]Dot, span int) bool
	Create() (dots map[int]Dot, b64 string, thumb64 string, key string, err error)
}

func NewWithOptions

func NewWithOptions(tp uint8, opts ...Option) Captcha

type Dot

type Dot struct {
	Index  int `json:"index,omitempty"`
	Dx     int `json:"dx,omitempty"`
	Dy     int `json:"dy,omitempty"`
	Width  int `json:"width,omitempty"`
	Height int `json:"height,omitempty"`
}

type Option

type Option func(opt *options)

func WithDriver

func WithDriver(driver *captcha.Captcha) Option

func WithQuality

func WithQuality(quality int) Option

func WithSlideBackDir

func WithSlideBackDir(backDir string) Option

func WithSlideMaskDir

func WithSlideMaskDir(maskDir string) Option

func WithWordsZhBackImgList

func WithWordsZhBackImgList(backImgList []string) Option

func WithWordsZhCnChars

func WithWordsZhCnChars(chars []string) Option

func WithWordsZhCnImgSize

func WithWordsZhCnImgSize(size captcha.Size) Option

func WithWordsZhCnThumbSize

func WithWordsZhCnThumbSize(size captcha.Size) Option

type Slide

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

Slide _

func NewSlide

func NewSlide(backDir, maskDir string, quality int) *Slide

NewSlide new slide with background and mask image list

func SlideWithBack

func SlideWithBack(backDir string) *Slide

SlideWithBack new slide with background image list

func SlideWithMask

func SlideWithMask(maskDir string) *Slide

SlideWithMask new slide with mask image list

func (*Slide) Check

func (s *Slide) Check(dots string, dct map[int]Dot, span int) bool

func (*Slide) Create

func (s *Slide) Create() (dots map[int]Dot, b64 string, thumb64 string, key string, err error)

Create generate slide key, x, y, and pictures.

func (*Slide) CreateCustom

func (s *Slide) CreateCustom(r, quality int) (dots map[int]Dot, b64 string, thumb64 string, key string, err error)

CreateCustom generate slide key, x, y, and pictures by custom.

This method is only used for custom background and masks images

func (*Slide) CreateShape

func (s *Slide) CreateShape(img *image.RGBA, point image.Point, r int) *image.RGBA

CreateShape create shape mask.

type WordsZhCn

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

func NewWordsZhCn

func NewWordsZhCn(driver *captcha.Captcha) *WordsZhCn

func (*WordsZhCn) Check

func (wzc *WordsZhCn) Check(dots string, dct map[int]Dot, span int) bool

func (*WordsZhCn) Create

func (wzc *WordsZhCn) Create() (dots map[int]Dot, b64 string, thumb64 string, key string, err error)

func (*WordsZhCn) Driver

func (wzc *WordsZhCn) Driver() *captcha.Captcha