faygo-security

README

gin-security

Gin security middleware

Sign

介绍

用于验证接口请求完整性，对请求的所有KV（除媒体文件）以及时间戳timestamp和随机字符串nonce，进行大小写排序，用&、=相连，最后连接上key=secret,进行MD5。服务端对此进行验证。

使用

Sign需要实现ISignProvider, GetClientSecret通过clientID来获取ClientInfo

//ISignProvider sign provider
type ISignProvider interface {
	//GetClientSecret get client secret by clientID.
	GetClientSecret(clientID string) (*ClientInfo, error)
}

CheckSign用于获验证签名是否正确，Sign用于生成签名 example

//GetClientSecret get client secret by clientID.
func (SignProviderImpl) GetClientSecret(clientID string) (*sign.ClientInfo, error) {
	conn := r.GetConn()
	bytes, err := redis.Bytes(conn.Do(r.GET, joinKey(clientID)))
	if err != nil {
		return nil, err
	}
	var clientInfo = new(sign.ClientInfo)
	err = proto.Unmarshal(bytes, clientInfo)
	if err != nil {
		return nil, errors.New("clientID invalid")
	}
	return clientInfo, nil
}

captcha.GET("/", sign.NewSignMiddleware(SignProvider), handler.CaptchaFactory)

Protect

介绍

对请求中的timestamp和nonce进行验证，timestamp和nonce唯一标识一个请求，当出现请求重复时，认为是请求重放攻击，可以自行处理，如：下次发起请求时必须带有验证码。当timestamp超出了预设时间，如60s，就返回错误信息并且带上服务器当前时间(RFC 3339)，再次请求，超过指定次数就要求携带验证码。

使用

实现下面的接口，IsExist检查请求唯一性， DealWithError处理错误，如：ErrorReplayAttac请求重放,ErrorRequestExpired请求过期 等等。

//IProtectProvider protect provider
type IProtectProvider interface {
	//IsExist judge request isExist
	IsExist(timestamp, nonce string) (bool, error)

	//DealWithError deal with error
	//error : ErrorReplayAttack, ErrorTimestampFormat, ErrorRequestExpired
	DealWithError(ctx *gin.Context, err error)
}

captcha.GET("/", protect.NewProtectMiddleware(ProtectProvider), handler.CaptchaFactory)