captcha

Documentation

Index

• Variables
• func Init(opts *Options)
• type Captcha
  • func (c *Captcha) Get() *Value
  • func (c *Captcha) GetEnabled() bool
  • func (c *Captcha) Show(ctx *gin.Context, id string) error
  • func (c *Captcha) Verify(val *Value) bool
• type Options
• type StoreMode
• type Value

Variables

var (
	ErrNotEnabled = errors.New("captcha: not enabled")
	ErrIDEmpty    = errors.New("captcha: id is empty")
)

Functions

func Init

func Init(opts *Options)

Types

type Captcha

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

var C *Captcha

func (*Captcha) Get

func (c *Captcha) Get() *Value

Get 获取验证码

func (*Captcha) GetEnabled

func (c *Captcha) GetEnabled() bool

func (*Captcha) Show

func (c *Captcha) Show(ctx *gin.Context, id string) error

Show 展示验证码

func (*Captcha) Verify

func (c *Captcha) Verify(val *Value) bool

Verify 验证验证码

type Options

type Options struct {
	Enabled   bool
	StoreMode int8
	Len       int
	Width     int
	Height    int
	Rds       *redis.Client
}

type StoreMode

type StoreMode int8

type Value

type Value struct {
	ID   string `json:"id,omitempty"`
	Code string `json:"code,omitempty"`
	Img  string `json:"img,omitempty"`
	Len  int    `json:"len,omitempty"`
}