captcha

Documentation

Index

• func MustNewOriginalRedisCaptcha(c Conf, r redis.UniversalClient) *base64Captcha.Captcha
• func MustNewRedisCaptcha(c Conf, r *redis2.Redis) *base64Captcha.Captcha
• func NewDriver(c Conf) base64Captcha.Driver
• type Conf
• type OriginalRedisStore
  • func NewOriginalRedisStore(r redis.UniversalClient) *OriginalRedisStore
  • func (r *OriginalRedisStore) Get(key string, clear bool) string
  • func (r *OriginalRedisStore) Set(id string, value string) error
  • func (r *OriginalRedisStore) UseWithCtx(ctx context.Context) base64Captcha.Store
  • func (r *OriginalRedisStore) Verify(id, answer string, clear bool) bool
• type RedisStore
  • func NewRedisStore(r *redis.Redis) *RedisStore
  • func (r *RedisStore) Get(key string, clear bool) string
  • func (r *RedisStore) Set(id string, value string) error
  • func (r *RedisStore) UseWithCtx(ctx context.Context) base64Captcha.Store
  • func (r *RedisStore) Verify(id, answer string, clear bool) bool

Functions

func MustNewOriginalRedisCaptcha

func MustNewOriginalRedisCaptcha(c Conf, r redis.UniversalClient) *base64Captcha.Captcha

MustNewOriginalRedisCaptcha returns the captcha using original go redis, it will exit when error occur

func MustNewRedisCaptcha

func MustNewRedisCaptcha(c Conf, r *redis2.Redis) *base64Captcha.Captcha

MustNewRedisCaptcha returns the captcha using redis, it will exit when error occur

func NewDriver

func NewDriver(c Conf) base64Captcha.Driver

Types

type Conf

type Conf struct {
	KeyLong   int    `json:",optional,default=5,env=CAPTCHA_KEY_LONG"`                                       // captcha length
	ImgWidth  int    `json:",optional,default=240,env=CAPTCHA_IMG_WIDTH"`                                    // captcha width
	ImgHeight int    `json:",optional,default=80,env=CAPTCHA_IMG_HEIGHT"`                                    // captcha height
	Driver    string `json:",optional,default=digit,options=[digit,string,math,chinese],env=CAPTCHA_DRIVER"` // captcha type
}

Conf is the captcha configuration structure

type OriginalRedisStore

type OriginalRedisStore struct {
	Expiration time.Duration
	PreKey     string
	Context    context.Context
	Redis      redis.UniversalClient
}

OriginalRedisStore stores captcha data.

func NewOriginalRedisStore

func NewOriginalRedisStore(r redis.UniversalClient) *OriginalRedisStore

NewOriginalRedisStore returns a redis store for captcha.

func (*OriginalRedisStore) Get

func (r *OriginalRedisStore) Get(key string, clear bool) string

Get gets the captcha KV from redis.

func (*OriginalRedisStore) Set

func (r *OriginalRedisStore) Set(id string, value string) error

Set sets the captcha KV to redis.

func (*OriginalRedisStore) UseWithCtx

func (r *OriginalRedisStore) UseWithCtx(ctx context.Context) base64Captcha.Store

UseWithCtx add context for captcha.

func (*OriginalRedisStore) Verify

func (r *OriginalRedisStore) Verify(id, answer string, clear bool) bool

Verify verifies the captcha whether it is correct.

type RedisStore

type RedisStore struct {
	Expiration time.Duration
	PreKey     string
	Context    context.Context
	Redis      *redis.Redis
}

RedisStore stores captcha data.

func NewRedisStore

func NewRedisStore(r *redis.Redis) *RedisStore

NewRedisStore returns a redis store for captcha.

func (*RedisStore) Get

func (r *RedisStore) Get(key string, clear bool) string

Get gets the captcha KV from redis.

func (*RedisStore) Set

func (r *RedisStore) Set(id string, value string) error

Set sets the captcha KV to redis.

func (*RedisStore) UseWithCtx

func (r *RedisStore) UseWithCtx(ctx context.Context) base64Captcha.Store

UseWithCtx add context for captcha.

func (*RedisStore) Verify

func (r *RedisStore) Verify(id, answer string, clear bool) bool

Verify verifies the captcha whether it is correct.