captcha

README

Captcha

Mode 模式

• String 字符串
• Equation 算式 +,-,*

Disturb 干扰项

• Point 点
• Line 直线
• Arc 弧线
• Rotate 旋转
• Distort 扭曲

Documentation

Index

• Variables
• func BoundString(content string, fontFace font.Face) (width, height int)
• func Check(id, code string) (bool, error)
• func CheckOk(id, code string) bool
• func Create() (id string, result string, img image.Image)
• func CreateB64() (id string, result string, data string, err error)
• func CreateBytes() (id string, result string, buf []byte, err error)
• func Debug()
• func RandomBytes(n int) []byte
• func RandomBytesHex(n int) string
• func RandomCode() string
• func RandomString(n int) string
• func SetCaptcha(m Captcha)
• type Captcha
  • func DefaultCaptchaEquation() Captcha
  • func NewCaptchaEquation(bit int, opts ...Option) Captcha
• type CaptchaBase
  • func New(opts ...Option) *CaptchaBase
  • func (c *CaptchaBase) Draw() (image.Image, *CaptchaData)
  • func (c *CaptchaBase) Options(opts ...Option) *CaptchaBase
• type CaptchaData
• type CaptchaEquation
  • func (c *CaptchaEquation) Draw() (image.Image, *CaptchaData)
• type CaptchaErr
  • func (e CaptchaErr) Error() string
• type Option
  • func WithBackground(color color.Color) Option
  • func WithExpire(t int64) Option
  • func WithFont(fontFace font.Face, size float64) Option
  • func WithFontByte(buf []byte, fontSize float64, dpi ...float64) Option
  • func WithFontName(fontName string, fontSize float64, dpi ...float64) Option
  • func WithFontSize(size float64) Option
  • func WithFront(color color.Color) Option
  • func WithLine(n int) Option
  • func WithPoint(n int) Option
  • func WithSize(width, hight int) Option

Examples

• CreateB64

Variables

var (
	ErrCodeExpired = CaptchaErr{ErrCode: 301001, /* contains filtered or unexported fields */}
	ErrCodeInvalid = CaptchaErr{ErrCode: 301002, /* contains filtered or unexported fields */}
)

var Equation = DefaultCaptchaEquation()

Functions

func BoundString

func BoundString(content string, fontFace font.Face) (width, height int)

BoundString 根据内容、字体，返回图像大小

func Check

func Check(id, code string) (bool, error)

Check 验证验证码是否正确,返回错误类型

func CheckOk

func CheckOk(id, code string) bool

Check 验证验证码是否正确

func Create

func Create() (id string, result string, img image.Image)

Create 创建验证码，返回图片对象image.Image

func CreateB64

func CreateB64() (id string, result string, data string, err error)

CreateB64 创建验证码，返回图片base64

Example

package main

import (
	"fmt"

	"github.com/virzz/captcha"
)

func main() {
	id, result, data, err := captcha.CreateB64()
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(id)
	fmt.Println(data)
	if captcha.CheckOk(id, "xxxx") {
		fmt.Println("test check")
	} else if captcha.CheckOk(id, result) {
		fmt.Println("ok")
	} else {
		fmt.Println("fail")
	}
}

func CreateBytes

func CreateBytes() (id string, result string, buf []byte, err error)

CreateBytes 创建验证码，返回图片数据[]byte

func Debug

func Debug()

func RandomBytes

func RandomBytes(n int) []byte

func RandomBytesHex

func RandomBytesHex(n int) string

func RandomCode

func RandomCode() string

func RandomString

func RandomString(n int) string

func SetCaptcha

func SetCaptcha(m Captcha)

Types

type Captcha

type Captcha interface {
	Draw() (image.Image, *CaptchaData) // 验证码生成逻辑并绘制图片
}

func DefaultCaptchaEquation

func DefaultCaptchaEquation() Captcha

func NewCaptchaEquation

func NewCaptchaEquation(bit int, opts ...Option) Captcha

type CaptchaBase

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

func New

func New(opts ...Option) *CaptchaBase

func (*CaptchaBase) Draw

func (c *CaptchaBase) Draw() (image.Image, *CaptchaData)

func (*CaptchaBase) Options

func (c *CaptchaBase) Options(opts ...Option) *CaptchaBase

type CaptchaData

type CaptchaData struct {
	Content string
	Result  string
	Expire  int64
}

type CaptchaEquation

type CaptchaEquation struct {
	*CaptchaBase
	// contains filtered or unexported fields
}

func (*CaptchaEquation) Draw

func (c *CaptchaEquation) Draw() (image.Image, *CaptchaData)

type CaptchaErr

type CaptchaErr struct {
	ErrCode int
	// contains filtered or unexported fields
}

func (CaptchaErr) Error

func (e CaptchaErr) Error() string

type Option

type Option func(cb *CaptchaBase)

func WithBackground

func WithBackground(color color.Color) Option

func WithExpire

func WithExpire(t int64) Option

func WithFont

func WithFont(fontFace font.Face, size float64) Option

func WithFontByte

func WithFontByte(buf []byte, fontSize float64, dpi ...float64) Option

func WithFontName

func WithFontName(fontName string, fontSize float64, dpi ...float64) Option

func WithFontSize

func WithFontSize(size float64) Option

func WithFront

func WithFront(color color.Color) Option

func WithLine

func WithLine(n int) Option

func WithPoint

func WithPoint(n int) Option

func WithSize

func WithSize(width, hight int) Option