apiauth

Documentation

Overview

Package apiauth provides handlers to enable apiauth support.

Simple Usage:

import(
	"github.com/beego/beego/v2"
	"github.com/beego/beego/v2/server/web/filter/apiauth"
)

func main(){
	// apiauth every request
	beego.InsertFilter("*", beego.BeforeRouter,apiauth.APIBasicAuth("appid","appkey"))
	beego.Run()
}

Advanced Usage:

func getAppSecret(appid string) string {
	// get appsecret by appid
	// maybe store in configure, maybe in database
}

beego.InsertFilter("*", beego.BeforeRouter,apiauth.APISecretAuth(getAppSecret, 360))

Information:

In the request user should include these params in the query

1. appid

appid is assigned to the application

2. signature

get the signature use apiauth.Signature()

when you send to server remember use url.QueryEscape()

3. timestamp:

send the request time, the format is yyyy-mm-dd HH:ii:ss

Index

• func APIBasicAuth(appid, appkey string) web.FilterFunc
• func APISecretAuth(f AppIDToAppSecret, timeout int) web.FilterFunc
• func Signature(appsecret, method string, params url.Values, RequestURL string) (result string)
• type AppIDToAppSecret

Functions

func APIBasicAuth

func APIBasicAuth(appid, appkey string) web.FilterFunc

APIBasicAuth uses the basic appid/appkey as the AppIdToAppSecret

func APISecretAuth

func APISecretAuth(f AppIDToAppSecret, timeout int) web.FilterFunc

APISecretAuth uses AppIdToAppSecret verify and

func Signature

func Signature(appsecret, method string, params url.Values, RequestURL string) (result string)

Signature generates signature with appsecret/method/params/RequestURI

Types

type AppIDToAppSecret

type AppIDToAppSecret func(string) string

AppIDToAppSecret gets appsecret through appid