auth

Documentation

Overview

Package auth 登录凭证的验证

Index

• Constants
• func BasicToken(token string) string
• func BearerToken(token string) string
• func BuildToken(prefix, token string) string
• func GetBasicToken(ctx *web.Context, header string) string
• func GetBearerToken(ctx *web.Context, header string) string
• func GetToken(ctx *web.Context, prefix, header string) string
• type Auth

Constants

const (
	Bearer = "bearer " // bearer 验证类型的前缀，属部带空格。
	Basic  = "basic "  // basic 验证类型的前缀，属部带空格。
)

Functions

func BasicToken

func BasicToken(token string) string

BasicToken 生成 Basic 的令牌

等同于 BuildToken(Basic, token)

func BearerToken

func BearerToken(token string) string

BearerToken 生成 Bearer 的令牌

等同于 BuildToken(Bearer, token)

func BuildToken

func BuildToken(prefix, token string) string

BuildToken 生成一个完整的令牌

func GetBasicToken

func GetBasicToken(ctx *web.Context, header string) string

func GetBearerToken

func GetBearerToken(ctx *web.Context, header string) string

func GetToken

func GetToken(ctx *web.Context, prefix, header string) string

GetToken 获取客户端提交的令牌

header 表示报头的名称； prefix 表示报头内容的前缀；

Types

type Auth

type Auth[T any] interface {
	web.Middleware

	// Logout 退出
	Logout(*web.Context) error

	// GetInfo 获取用户数据
	//
	// 当验证通过之后，验证接口同时会将用户信息写入到 [web.Context]
	// 可通过当前方法获取写入的数据。
	GetInfo(*web.Context) (T, bool)
}

Auth 登录凭证的验证接口

T 表示每次验证后，附加在 web.Context 上的数据。