signer.go

package sign

import (
	"fmt"
	"net/url"
	"sort"
	"strings"
	"strconv"
)

//
// Author: 陈哈哈 chenyongjia@parkingwang.com, yoojiachen@gmail.com
// API签名
//

// 签名加密函数
type CryptoFunc func(secretKey string, args string) []byte

type GoSigner struct {
	*DefaultKeyName

	body       url.Values // 签名参数体
	bodyPrefix string     // 参数体前缀
	bodySuffix string     // 参数体后缀
	splitChar  string     // 前缀、后缀分隔符号

	secretKey  string // 签名密钥
	cryptoFunc CryptoFunc
}

func NewGoSigner(cryptoFunc CryptoFunc) *GoSigner {
	return &GoSigner{
		DefaultKeyName: newDefaultKeyName(),
		body:           make(url.Values),
		bodyPrefix:     "",
		bodySuffix:     "",
		splitChar:      "",
		cryptoFunc:     cryptoFunc,
	}
}

func NewGoSignerMd5() *GoSigner {
	return NewGoSigner(Md5Sign)
}

func NewGoSignerHmac() *GoSigner {
	return NewGoSigner(Hmac5Sign)
}

// SetBody 设置整个参数体Body对象。
func (slf *GoSigner) SetBody(body url.Values) {
	for k, v := range body {
		slf.body[k] = v
	}
}

// GetBody 返回Body内容
func (slf *GoSigner) GetBody() url.Values {
	return slf.body
}

// AddBody 添加签名体字段和值
func (slf *GoSigner) AddBody(key string, value string) *GoSigner {
	return slf.AddBodies(key, []string{value})
}

func (slf *GoSigner) AddBodies(key string, value []string) *GoSigner {
	slf.body[key] = value
	return slf
}

// SetTimeStamp 设置时间戳参数
func (slf *GoSigner) SetTimeStamp(ts int64) *GoSigner {
	return slf.AddBody(slf.keyNameTimestamp, strconv.FormatInt(ts, 10))
}

// GetTimeStamp 获取TimeStamp
func (slf *GoSigner) GetTimeStamp() string {
	return slf.body.Get(slf.keyNameTimestamp)
}

// SetNonceStr 设置随机字符串参数
func (slf *GoSigner) SetNonceStr(nonce string) *GoSigner {
	return slf.AddBody(slf.keyNameNonceStr, nonce)
}

// GetNonceStr 返回NonceStr字符串
func (slf *GoSigner) GetNonceStr() string {
	return slf.body.Get(slf.keyNameNonceStr)
}

// SetAppId 设置AppId参数
func (slf *GoSigner) SetAppId(appId string) *GoSigner {
	return slf.AddBody(slf.keyNameAppId, appId)
}

func (slf *GoSigner) GetAppId() string {
	return slf.body.Get(slf.keyNameAppId)
}

// RandNonceStr 自动生成16位随机字符串参数
func (slf *GoSigner) RandNonceStr() *GoSigner {
	return slf.SetNonceStr(RandString(16))
}

// SetSignBodyPrefix 设置签名字符串的前缀字符串
func (slf *GoSigner) SetSignBodyPrefix(prefix string) *GoSigner {
	slf.bodyPrefix = prefix
	return slf
}

// SetSignBodySuffix 设置签名字符串的后缀字符串
func (slf *GoSigner) SetSignBodySuffix(suffix string) *GoSigner {
	slf.bodySuffix = suffix
	return slf
}

// SetSplitChar设置前缀、后缀与签名体之间的分隔符号。默认为空字符串
func (slf *GoSigner) SetSplitChar(split string) *GoSigner {
	slf.splitChar = split
	return slf
}

// SetAppSecret 设置签名密钥
func (slf *GoSigner) SetAppSecret(appSecret string) *GoSigner {
	slf.secretKey = appSecret
	return slf
}

// SetAppSecretWrapBody 在签名参数体的首部和尾部，拼接AppSecret字符串。
func (slf *GoSigner) SetAppSecretWrapBody(appSecret string) *GoSigner {
	slf.SetSignBodyPrefix(appSecret)
	slf.SetSignBodySuffix(appSecret)
	return slf.SetAppSecret(appSecret)
}

// GetSignBodyString 获取用于签名的原始字符串
func (slf *GoSigner) GetSignBodyString() string {
	return slf.MakeRawBodyString()
}

// MakeRawBodyString 获取用于签名的原始字符串
func (slf *GoSigner) MakeRawBodyString() string {
	return slf.bodyPrefix + slf.splitChar + slf.getSortedBodyString() + slf.splitChar + slf.bodySuffix
}

// GetSignedQuery 获取带签名参数的字符串
func (slf *GoSigner) GetSignedQuery() string {
	return slf.MakeSignedQuery()
}

// GetSignedQuery 获取带签名参数的字符串
func (slf *GoSigner) MakeSignedQuery() string {
	body := slf.getSortedBodyString()
	sign := slf.GetSignature()
	return body + "&" + slf.keyNameSign + "=" + sign
}

// GetSignature 获取签名
func (slf *GoSigner) GetSignature() string {
	return slf.MakeSign()
}

// GetSignature 获取签名
func (slf *GoSigner) MakeSign() string {
	sign := fmt.Sprintf("%x", slf.cryptoFunc(slf.secretKey, slf.GetSignBodyString()))
	return sign
}

func (slf *GoSigner) getSortedBodyString() string {
	return SortKVPairs(slf.body)
}

////

// SortKVPairs 将Map的键值对，按字典顺序拼接成字符串
func SortKVPairs(m url.Values) string {
	size := len(m)
	if size == 0 {
		return ""
	}
	keys := make([]string, size)
	idx := 0
	for k := range m {
		keys[idx] = k
		idx++
	}
	sort.Strings(keys)
	pairs := make([]string, size)
	for i, key := range keys {
		pairs[i] = key + "=" + strings.Join(m[key], ",")
	}
	return strings.Join(pairs, "&")
}