token

Documentation

Index

• Constants
• func IsBase64Enabled(opts ...Option) bool
• type Authenticate
• type Engine
• type Factory
• type Key
• type Option
• type Route
• type Secret
• type Session
  • func CreateSession(uid, session string) Session
• type Source
• type Token

Constants

const (
	KSource  = "source"
	KSession = "session"
	KExtend  = "extend"
	KUid     = "uid"
)

Functions

func IsBase64Enabled

func IsBase64Enabled(opts ...Option) bool

Types

type Authenticate

type Authenticate interface {
	Type() string
	Create(source Source, expireSeconds int64, opts ...Option) (Token, error)
	Decode(source Source, tk string, opts ...Option) (Token, error)
	Check(source Source, tk string, opts ...Option) (Token, error)
	// EnableFlag return 0= disable, 1=enable, 2=not exist
	EnableFlag(source Source) int
	SetEnabled(source Source, enable bool)
}

type Engine

type Engine interface {
	Client() Route
	Server() Route
}

type Factory

type Factory interface {
	Create(key Key, opts ...Option) (Token, error)
	Decode(tk string, opts ...Option) (Token, error)
	Check(tk string, key Key, opts ...Option) (Token, error)
}

type Key

type Key secret.Key

type Option

type Option struct {
	Base64 bool //是否使用base64编码
}

type Route

type Route interface {
	HasAuth(method string) bool
	Auth() Authenticate
	Use(a Authenticate) Route
}

type Secret

type Secret interface {
	GetSecret(source Source) secret.Secret
	SetEnabled(source Source, enable bool)
	// EnableFlag return 0= disable, 1=enable, 2=not exist
	EnableFlag(source Source) int
}

type Session

type Session struct {
	Uid       string `json:"uid"`
	UserToken string `json:"-"` //for server and server
}

func CreateSession

func CreateSession(uid, session string) Session

type Source

type Source struct {
	AppId     string      `json:"appid"`
	Source    string      `json:"source"`
	SecretKey string      `json:"-"`
	Method    string      `json:"-"` //认证方式 "jwt
	Custom    interface{} `json:"-"` //自定义数据
}

type Token

type Token interface {
	// WithVar key= "source" value= token.Source
	//         key= "session" value= token.Session
	//         key= "extend" value= string
	WithVar(key string, value interface{}) Token
	GetVar(key string) interface{}
	GetToken() string
	Update() (string, error)
}