Documentation
¶
Overview ¶
Package ginaksk 基于ak, sk实现的服务认证中间件
Example (Aksk) ¶
package main import ( "crypto/md5" "encoding/base64" "errors" "fmt" "net/http" "github.com/antlinker/ginaksk" "github.com/gin-gonic/gin" ) type store map[string]string var keyStore = store{"ak": "sk"} // GetKeyFunc 返回aksk.KeyFunc func GetKeyFunc() ginaksk.KeyFunc { return func(ak string) string { return keyStore[ak] } } type logger struct{} var testLogger = &logger{} func (l *logger) Printf(format string, args ...interface{}) { fmt.Printf(format, args...) } func handlError(c *gin.Context, err error) { if err == nil { return } var aErr *ginaksk.Error if errors.As(err, &aErr) { c.AbortWithStatusJSON(http.StatusUnauthorized, map[string]interface{}{ "err_code": 1, "err_msg": err.Error(), }) return } testLogger.Printf("aksk error: %s", err) c.AbortWithStatusJSON(http.StatusInternalServerError, map[string]interface{}{ "err_code": -1, "err_msg": err.Error(), }) } type base64Encoder struct { enc *base64.Encoding } func (b64 *base64Encoder) EncodeToString(b []byte) string { return b64.enc.EncodeToString(b) } func (b64 *base64Encoder) DecodeString(s string) (b []byte, err error) { return b64.enc.DecodeString(s) } func main() { ginaksk.SetLogger(testLogger) // 可选 ginaksk.SetHash(md5.New) // 可选 ginaksk.SetEncoder(&base64Encoder{enc: base64.RawStdEncoding}) // 可选 e := gin.New() // 验证请求签名, 并验证请求内容, 自定义错误处理 e.Use(ginaksk.Validate(GetKeyFunc(), false, handlError)) // ginaksk.SetHash(sha1.New) // [Bad!] 取消注释会触发panic }
Output:
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrTimestampExpired 时间戳过期 ErrTimestampExpired = newError("请求时间戳过期") // ErrTimestampInvalid 时间戳无效 ErrTimestampInvalid = newError("请求时间戳无效") // ErrTimestampEmpty 缺少时间戳 ErrTimestampEmpty = newError("请求缺少时间戳") // ErrSignatueEmpty 请求签名为空 ErrSignatueEmpty = newError("请求缺少签名") // ErrSignatureInvalid 请求签名无效 ErrSignatureInvalid = newError("请求签名无效") // ErrBodyInvalid 请求内容无效 ErrBodyInvalid = newError("请求内容无效") // ErrBodyHashInvalid 请求内容哈希值无效 ErrBodyHashInvalid = newError("请求内容哈希值无效") )
View Source
var ( // ErrAccessKeyEmpty ak为空 ErrAccessKeyEmpty = newError("accesskey为空") // ErrSecretKeyEmpty sk为空 ErrSecretKeyEmpty = newError("accesskey无效") )
Functions ¶
func Validate ¶
func Validate(keyFn KeyFunc, skipBody bool, fn ErrorHandler) gin.HandlerFunc
Validate 返回一个验证请求的gin中间件, keyFn指定了查询SecretKey的函数,如果等于nil,将panic; 如果skipBody为true, 跳过检查body的hash值是否一致; fn不为nil时,使用自定义的错误处理函数
Types ¶
type Encoder ¶
type Encoder interface { // EncodeToString 编码成字符串 EncodeToString(b []byte) string // DecodeString 将字符串解码成字节切片 DecodeString(s string) ([]byte, error) }
Encoder 编码方法接口
type RequestFunc ¶
RequestFunc aksk的请求构造函数
func NewRequestFunc ¶
func NewRequestFunc(ak, sk string) (RequestFunc, error)
NewRequestFunc 返回一个RequestFunc
Click to show internal directories.
Click to hide internal directories.