captcha

package

v1.6.7 Latest Latest Go to latest Published: Apr 26, 2024 License: Apache-2.0 Imports: 5 Imported by: 13

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/webx-top/echo

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Captcha(opts ...*Options) func(echo.Context) error
type ICaptchaID
type IDExists
type IDGenerator
type Options
- func New(prefix string) *Options

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultOptions = &Options{
	EnableImage:    true,
	EnableAudio:    true,
	EnableDownload: true,
	AudioLangs:     []string{`zh`, `ru`, `en`},
	Prefix:         `/captcha`,
	CookieName:     `captchaId`,
	HeaderName:     `X-Captcha-Id`,
	idGenerator: func(_ echo.Context, _ *Options) (string, error) {
		return captcha.New(), nil
	},
	idExists: func(_ echo.Context, _ *Options, id string) bool {
		return captcha.Exists(id)
	},
}

Functions ¶

func Captcha ¶ added in v1.1.1

func Captcha(opts ...*Options) func(echo.Context) error

Types ¶

type ICaptchaID ¶ added in v1.6.0

type ICaptchaID interface {
	IDGenerate(echo.Context) (string, error)
	IDExists(echo.Context, string) bool
}

type IDExists ¶ added in v1.6.0

type IDExists func(echo.Context, *Options, string) bool

type IDGenerator ¶ added in v1.6.0

type IDGenerator func(echo.Context, *Options) (string, error)

type Options ¶

type Options struct {
	EnableImage    bool
	EnableAudio    bool
	EnableDownload bool
	AudioLangs     []string
	Prefix         string
	CookieName     string
	HeaderName     string
	// contains filtered or unexported fields
}

func New ¶ added in v1.6.0

func New(prefix string) *Options

func (*Options) IDExists ¶ added in v1.6.0

func (o *Options) IDExists(c echo.Context, id string) bool

func (*Options) IDGenerate ¶ added in v1.6.0

func (o *Options) IDGenerate(c echo.Context) (string, error)

func (*Options) SetAudioLangs ¶ added in v1.6.0

func (o *Options) SetAudioLangs(audioLangs ...string) *Options

func (*Options) SetCookieName ¶ added in v1.6.0

func (o *Options) SetCookieName(name string) *Options

func (*Options) SetEnableAudio ¶ added in v1.6.0

func (o *Options) SetEnableAudio(enable bool) *Options

func (*Options) SetEnableDownload ¶ added in v1.6.0

func (o *Options) SetEnableDownload(enable bool) *Options

func (*Options) SetEnableImage ¶ added in v1.6.0

func (o *Options) SetEnableImage(enable bool) *Options

func (*Options) SetHeaderName ¶ added in v1.6.0

func (o *Options) SetHeaderName(name string) *Options

func (*Options) SetIDExists ¶ added in v1.6.0

func (o *Options) SetIDExists(h IDExists) *Options

func (*Options) SetIDGenerator ¶ added in v1.6.0

func (o *Options) SetIDGenerator(h IDGenerator) *Options

func (*Options) SetPrefix ¶ added in v1.6.0

func (o *Options) SetPrefix(prefix string) *Options

func (Options) Wrapper ¶

func (o Options) Wrapper(e echo.RouteRegister) echo.IRouter

Source Files ¶

View all Source files

captcha.go

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