apisign

README

apisign

An APIBox middleware to implement API signature verification.

Documentation

Index

• Variables
• func CheckSign(values url.Values, key string, sign []byte) bool
• func EncodeValues(v url.Values) string
• func MakeSign(values url.Values, key string) []byte
• func MakeSignString(values url.Values, key string) string
• type Sign
  • func NewSign(app *api.App) *Sign
  • func (s *Sign) Disable()
  • func (s *Sign) Enable()
  • func (s *Sign) GetSignKey() string
  • func (s *Sign) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)
  • func (s *Sign) SetSignKey(signKey string)

Variables

var ErrorDefines = map[api.ErrorType]*api.ErrorDefine{
	// contains filtered or unexported fields
}

Functions

func CheckSign

func CheckSign(values url.Values, key string, sign []byte) bool

CheckSign return true if specified sign is the signature of url values.

func EncodeValues

func EncodeValues(v url.Values) string

EncodeValues encodes the values into "URL encoded" form ("bar=baz&foo=quux") sorted by key and values. Changed from url.Values.Encode()

func MakeSign

func MakeSign(values url.Values, key string) []byte

MakeSign return the signature of url values signed by hmac/md5 with specified sign key.

func MakeSignString

func MakeSignString(values url.Values, key string) string

MakeSignString return the signature of url values as string signed by hmac/md5 with specified sign key.

Types

type Sign

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

func NewSign

func NewSign(app *api.App) *Sign

func (*Sign) Disable

func (s *Sign) Disable()

Disable disable the middle ware.

func (*Sign) Enable

func (s *Sign) Enable()

Enable enable the middle ware.

func (*Sign) GetSignKey

func (s *Sign) GetSignKey() string

GetSignKey return current sign key as string.

func (*Sign) ServeHTTP

func (s *Sign) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)

func (*Sign) SetSignKey

func (s *Sign) SetSignKey(signKey string)

SetSignKey allow you update sign key dynamically.