apiauth

package
v1.12.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 7, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package apiauth provides handlers to enable apiauth support.

Simple Usage:

import(
	"github.com/astaxie/beego"
	"github.com/astaxie/beego/plugins/apiauth"
)

func main(){
	// apiauth every request
	beego.InsertFilter("*", beego.BeforeRouter,apiauth.APIBaiscAuth("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

Constants

This section is empty.

Variables

This section is empty.

Functions

func APIBaiscAuth

func APIBaiscAuth(appid, appkey string) beego.FilterFunc

APIBaiscAuth calls APIBasicAuth for previous callers

func APIBasicAuth added in v1.12.5

func APIBasicAuth(appid, appkey string) beego.FilterFunc

APIBasicAuth use the basic appid/appkey as the AppIdToAppSecret

func APISecretAuth added in v1.6.0

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

APISecretAuth use AppIdToAppSecret verify and

func Signature

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

Signature used to generate signature with the appsecret/method/params/RequestURI

Types

type AppIDToAppSecret added in v1.6.0

type AppIDToAppSecret func(string) string

AppIDToAppSecret is used to get appsecret throw appid

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL