captcha

Documentation

Overview

Copyright 2016 Wenhui Shen <www.webx.top>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• func Captcha(opts ...*Options) func(echo.Context) error
• type IDGenerator
• type Options
  • func New(prefix string) *Options
  • func (o *Options) SetAudioLangs(audioLangs ...string) *Options
  • func (o *Options) SetCookieName(name string) *Options
  • func (o *Options) SetEnableAudio(enable bool) *Options
  • func (o *Options) SetEnableDownload(enable bool) *Options
  • func (o *Options) SetEnableImage(enable bool) *Options
  • func (o *Options) SetHeaderName(name string) *Options
  • func (o *Options) SetIDGenerator(h IDGenerator) *Options
  • func (o *Options) SetPrefix(prefix string) *Options
  • func (o Options) Wrapper(e echo.RouteRegister)

Variables

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
	},
}

Functions

func Captcha

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

Types

type IDGenerator

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
	IDGenerator    IDGenerator
}

func New

func New(prefix string) *Options

func (*Options) SetAudioLangs

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

func (*Options) SetCookieName

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

func (*Options) SetEnableAudio

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

func (*Options) SetEnableDownload

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

func (*Options) SetEnableImage

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

func (*Options) SetHeaderName

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

func (*Options) SetIDGenerator

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

func (*Options) SetPrefix

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

func (Options) Wrapper

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