utils

Documentation

Index

• func CopyStructByJson(src, dst interface{})
• func CopyStructToMap(src interface{}) map[string]interface{}
• func EncryptPassword(password string) (string, error)
• func InArray(k string, arr []string) bool
• func Keys[K comparable, V any](m map[K]V) []K
• func Md5(str string) string
• func RandomString(n int) string
• func SafeGo(f interface{}, params ...interface{})
• func StringConcat(strs ...string) string
• func Values[K comparable, V any](m map[K]V) []V
• func VerifyPassword(hash, input string) (bool, string, error)
• type B64MathCaptchaProvider
  • func (p B64MathCaptchaProvider) Draw(content string) (string, error)
  • func (p B64MathCaptchaProvider) Expiration() time.Duration
  • func (p B64MathCaptchaProvider) Generate() (string, string, string, error)
• type B64StringCaptchaProvider
  • func (p B64StringCaptchaProvider) Draw(content string) (string, error)
  • func (p B64StringCaptchaProvider) Expiration() time.Duration
  • func (p B64StringCaptchaProvider) Generate() (string, string, string, error)
• type BanRecord
• type CaptchaMeta
• type CaptchaProvider
• type LoginLimiter
  • func NewLoginLimiter(policy SecurityPolicy) *LoginLimiter
  • func (ll *LoginLimiter) CheckSecurityStatus(ip string) (banned bool, captchaRequired bool)
  • func (ll *LoginLimiter) DrawCaptcha(content string) (err error, str string)
  • func (ll *LoginLimiter) RecordFailedAttempt(ip string)
  • func (ll *LoginLimiter) RegisterProvider(p CaptchaProvider)
  • func (ll *LoginLimiter) RemoveAttempts(ip string)
  • func (ll *LoginLimiter) RequireCaptcha() (error, CaptchaMeta)
  • func (ll *LoginLimiter) VerifyCaptcha(id, answer string) bool
• type SecurityPolicy

Functions

func CopyStructByJson

func CopyStructByJson(src, dst interface{})

func CopyStructToMap

func CopyStructToMap(src interface{}) map[string]interface{}

CopyStructToMap 结构体转map

func EncryptPassword

func EncryptPassword(password string) (string, error)

EncryptPassword hashes the input password using bcrypt. An error is returned if hashing fails.

func InArray

func InArray(k string, arr []string) bool

func Keys

func Keys[K comparable, V any](m map[K]V) []K

Keys 泛型函数，K 是键类型，V 是值类型

func Md5

func Md5(str string) string

func RandomString

func RandomString(n int) string

RandomString 生成随机字符串

func SafeGo

func SafeGo(f interface{}, params ...interface{})

SafeGo is a common function to recover panic for goroutines

func StringConcat

func StringConcat(strs ...string) string

func Values

func Values[K comparable, V any](m map[K]V) []V

Values 泛型函数，K 是键类型，V 是值类型

func VerifyPassword

func VerifyPassword(hash, input string) (bool, string, error)

VerifyPassword checks the input password against the stored hash. When a legacy MD5 hash is provided, the password is rehashed with bcrypt and the new hash is returned. Any internal bcrypt error is returned.

Types

type B64MathCaptchaProvider

type B64MathCaptchaProvider struct{}

func (B64MathCaptchaProvider) Draw

func (p B64MathCaptchaProvider) Draw(content string) (string, error)

func (B64MathCaptchaProvider) Expiration

func (p B64MathCaptchaProvider) Expiration() time.Duration

func (B64MathCaptchaProvider) Generate

func (p B64MathCaptchaProvider) Generate() (string, string, string, error)

type B64StringCaptchaProvider

type B64StringCaptchaProvider struct{}

func (B64StringCaptchaProvider) Draw

func (p B64StringCaptchaProvider) Draw(content string) (string, error)

func (B64StringCaptchaProvider) Expiration

func (p B64StringCaptchaProvider) Expiration() time.Duration

func (B64StringCaptchaProvider) Generate

func (p B64StringCaptchaProvider) Generate() (string, string, string, error)

type BanRecord

type BanRecord struct {
	ExpiresAt time.Time
	Reason    string
}

IP封禁记录

type CaptchaMeta

type CaptchaMeta struct {
	Id        string
	Content   string
	Answer    string
	ExpiresAt time.Time
}

验证码元数据

type CaptchaProvider

type CaptchaProvider interface {
	Generate() (id string, content string, answer string, err error)
	//Validate(ip, code string) bool
	Expiration() time.Duration           // 验证码过期时间, 应该小于 AttemptsWindow
	Draw(content string) (string, error) // 绘制验证码
}

验证码提供者接口

type LoginLimiter

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

登录限制器

func NewLoginLimiter

func NewLoginLimiter(policy SecurityPolicy) *LoginLimiter

func (*LoginLimiter) CheckSecurityStatus

func (ll *LoginLimiter) CheckSecurityStatus(ip string) (banned bool, captchaRequired bool)

CheckSecurityStatus 检查安全状态

func (*LoginLimiter) DrawCaptcha

func (ll *LoginLimiter) DrawCaptcha(content string) (err error, str string)

func (*LoginLimiter) RecordFailedAttempt

func (ll *LoginLimiter) RecordFailedAttempt(ip string)

记录登录失败尝试

func (*LoginLimiter) RegisterProvider

func (ll *LoginLimiter) RegisterProvider(p CaptchaProvider)

注册验证码提供者

func (*LoginLimiter) RemoveAttempts

func (ll *LoginLimiter) RemoveAttempts(ip string)

清除记录窗口

func (*LoginLimiter) RequireCaptcha

func (ll *LoginLimiter) RequireCaptcha() (error, CaptchaMeta)

生成验证码

func (*LoginLimiter) VerifyCaptcha

func (ll *LoginLimiter) VerifyCaptcha(id, answer string) bool

验证验证码

type SecurityPolicy

type SecurityPolicy struct {
	CaptchaThreshold int // 尝试失败次数达到验证码阈值，小于0表示不启用, 0表示强制启用
	BanThreshold     int // 尝试失败次数达到封禁阈值，为0表示不启用
	AttemptsWindow   time.Duration
	BanDuration      time.Duration
}

安全策略配置