vmiddleware

Documentation

Index

• Constants
• Variables
• func BasicAuthMiddleware(accounts vapi.Accounts) vapi.HandlerFunc
• func CalSign(m vmap.M, secret string, signAlgorithm SignAlgorithm) (sign string, err error)
• func CorsMiddleware() vapi.HandlerFunc
• func ElapsedBusinessMiddleware(metric *vmetric.Metric) vapi.HandlerFunc
• func ElapsedMiddleware(metric *vmetric.Metric) vapi.HandlerFunc
• func ExpiredMiddleware[T any](expired *Expired) vapi.HandlerFunc
• func GetExpired(c *vapi.Context, s *Expired, expiredReq int64) (expired int64)
• func GetSign(c *vapi.Context, s *Sign, signReq string) (sign string)
• func GetSignByHeader(c *vapi.Context, s *Sign, _ string) string
• func GetTraceIdVal(c *vapi.Context, t *TraceId, traceIdReq string) (traceId string)
• func GetTraceIdValByHeader(c *vapi.Context, t *TraceId, _ string) string
• func LimitMiddleware(limiter *rate.Limiter) vapi.HandlerFunc
• func ParseBasicAuthMiddleware(userNameKey string) vapi.HandlerFunc
• func SignMiddleware[T any](sign *Sign) vapi.HandlerFunc
• func TraceIdMiddleware[T any](t *TraceId) vapi.HandlerFunc
• func ValidMiddleware[T any](errCode ...*vcode.Code) vapi.HandlerFunc
• type CalSignFunc
• type Expired
  • func NewExpired() (e *Expired)
  • func (e *Expired) SetExpiredKey(expiredKey string) *Expired
  • func (e *Expired) SetGetExpiredFunc(getExpiredFunc GetExpiredFunc) *Expired
• type GetExpiredFunc
• type GetSignFunc
• type GetTraceIdFunc
• type Sign
  • func NewSign() (s *Sign)
  • func (s *Sign) SetAlgorithm(algorithm SignAlgorithm) *Sign
  • func (s *Sign) SetCalSignFunc(calSignFunc CalSignFunc) *Sign
  • func (s *Sign) SetGetSignFunc(getSignFunc GetSignFunc) *Sign
  • func (s *Sign) SetSecret(secret string) *Sign
  • func (s *Sign) SetSignKey(signKey string) *Sign
• type SignAlgorithm
• type TraceId
  • func NewTraceId() (t *TraceId)
  • func (t *TraceId) SetGetTraceIdFunc(getTraceIdFunc GetTraceIdFunc) *TraceId
  • func (t *TraceId) SetTraceIdKey(traceIdKey string) *TraceId

Constants

const (
	SignAlgorithmMd5  = 1
	SignAlgorithmHmac = 2
)

Variables

var (
	DefaultTraceId    = NewTraceId()
	TraceIdContextKey = vtrace.GetTraceIdKey()
)

var DefaultExpired = NewExpired()

var DefaultSign = NewSign()

Functions

func BasicAuthMiddleware

func BasicAuthMiddleware(accounts vapi.Accounts) vapi.HandlerFunc

BasicAuthMiddleware basic auth middleware

func CalSign

func CalSign(m vmap.M, secret string, signAlgorithm SignAlgorithm) (sign string, err error)

CalSign calculate sign

func CorsMiddleware

func CorsMiddleware() vapi.HandlerFunc

CorsMiddleware cors

func ElapsedBusinessMiddleware

func ElapsedBusinessMiddleware(metric *vmetric.Metric) vapi.HandlerFunc

ElapsedBusinessMiddleware elapsed time

func ElapsedMiddleware

func ElapsedMiddleware(metric *vmetric.Metric) vapi.HandlerFunc

ElapsedMiddleware elapsed time

func ExpiredMiddleware

func ExpiredMiddleware[T any](expired *Expired) vapi.HandlerFunc

ExpiredMiddleware check expired

func GetExpired

func GetExpired(c *vapi.Context, s *Expired, expiredReq int64) (expired int64)

GetExpired get expired

func GetSign

func GetSign(c *vapi.Context, s *Sign, signReq string) (sign string)

GetSign get sign

func GetSignByHeader

func GetSignByHeader(c *vapi.Context, s *Sign, _ string) string

GetSignByHeader get sign by header

func GetTraceIdVal

func GetTraceIdVal(c *vapi.Context, t *TraceId, traceIdReq string) (traceId string)

GetTraceIdVal get trace id

func GetTraceIdValByHeader

func GetTraceIdValByHeader(c *vapi.Context, t *TraceId, _ string) string

GetTraceIdValByHeader get trace id by header

func LimitMiddleware

func LimitMiddleware(limiter *rate.Limiter) vapi.HandlerFunc

LimitMiddleware rate limit

func ParseBasicAuthMiddleware

func ParseBasicAuthMiddleware(userNameKey string) vapi.HandlerFunc

func SignMiddleware

func SignMiddleware[T any](sign *Sign) vapi.HandlerFunc

SignMiddleware sign

func TraceIdMiddleware

func TraceIdMiddleware[T any](t *TraceId) vapi.HandlerFunc

TraceIdMiddleware trace id

func ValidMiddleware

func ValidMiddleware[T any](errCode ...*vcode.Code) vapi.HandlerFunc

ValidMiddleware valid params

Types

type CalSignFunc

type CalSignFunc func(m vmap.M, secret string, signAlgorithm SignAlgorithm) (sign string, err error)

type Expired

type Expired struct {
	ExpiredSecond  int64
	ExpiredKey     string
	GetExpiredFunc GetExpiredFunc
}

func NewExpired

func NewExpired() (e *Expired)

NewExpired create expired object

func (*Expired) SetExpiredKey

func (e *Expired) SetExpiredKey(expiredKey string) *Expired

SetExpiredKey set secret

func (*Expired) SetGetExpiredFunc

func (e *Expired) SetGetExpiredFunc(getExpiredFunc GetExpiredFunc) *Expired

SetGetExpiredFunc set GetExpiredFunc

type GetExpiredFunc

type GetExpiredFunc func(c *vapi.Context, s *Expired, expiredReq int64) int64

type GetSignFunc

type GetSignFunc func(c *vapi.Context, s *Sign, signReq string) string

type GetTraceIdFunc

type GetTraceIdFunc func(c *vapi.Context, traceId *TraceId, traceIdReq string) string

type Sign

type Sign struct {
	Algorithm   SignAlgorithm
	CalSignFunc CalSignFunc
	GetSignFunc GetSignFunc
	Secret      string
	SignKey     string
}

func NewSign

func NewSign() (s *Sign)

NewSign create sign object

func (*Sign) SetAlgorithm

func (s *Sign) SetAlgorithm(algorithm SignAlgorithm) *Sign

SetAlgorithm set CalSignFunc

func (*Sign) SetCalSignFunc

func (s *Sign) SetCalSignFunc(calSignFunc CalSignFunc) *Sign

SetCalSignFunc set CalSignFunc

func (*Sign) SetGetSignFunc

func (s *Sign) SetGetSignFunc(getSignFunc GetSignFunc) *Sign

SetGetSignFunc set GetSignFunc

func (*Sign) SetSecret

func (s *Sign) SetSecret(secret string) *Sign

SetSecret set secret

func (*Sign) SetSignKey

func (s *Sign) SetSignKey(signKey string) *Sign

SetSignKey set secret

type SignAlgorithm

type SignAlgorithm int

type TraceId

type TraceId struct {
	GetTraceIdFunc    GetTraceIdFunc
	TraceIdContextKey string
	TraceIdKey        string
}

func NewTraceId

func NewTraceId() (t *TraceId)

NewTraceId create traceId object

func (*TraceId) SetGetTraceIdFunc

func (t *TraceId) SetGetTraceIdFunc(getTraceIdFunc GetTraceIdFunc) *TraceId

SetGetTraceIdFunc set GetTraceIdFunc

func (*TraceId) SetTraceIdKey

func (t *TraceId) SetTraceIdKey(traceIdKey string) *TraceId

SetTraceIdKey set traceIdKey