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 (
	CSource  = "source"
	CSession = "session"
	CExtend  = "extend"
	CUid     = "uid"
	CBase64  = "base64"
	CCustom  = "custom"
)

Functions

func IsBase64Enabled

func IsBase64Enabled(opts ...Option) bool

Types

type Authenticate

type Authenticate interface {
	Type() string
	// Create secretKey不是那个密钥，而是 Secret interface 的key,通过这个key值，获取到真实的密钥
	Create(secretKey string, expireSeconds int64, opts ...Option) (Token, error)
	// Check secretKey不是那个密钥，而是 Secret interface 的key,通过这个key值，获取到真实的密钥
	Check(secretKey string, tk string, opts ...Option) (Token, error)
	// Decode not need sign, only parse
	Decode(tk string, opts ...Option) (Token, error)
	// EnableFlag return 0= disable, 1=enable, 2=not exist
	// secretKey不是那个密钥，而是 Secret interface 的key, 通过这个key值，获取到真实的密钥
	EnableFlag(secretKey string) int
	// SetEnabled secretKey不是那个密钥，而是 Secret interface 的key, 通过这个key值，获取到真实的密钥
	SetEnabled(secretKey string, 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 {
	Use(a Authenticate) Route
	HasAuth(method string) bool
	Auth(method string) (Authenticate, error)
}

type Secret

type Secret interface {
	GetSecret(key string) secret.Secret
	SetEnabled(key string, enable bool)
	// EnableFlag return 0= disable, 1=enable, 2=not exist
	EnableFlag(key string) 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"`
}

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)
	// ExpireIn 根据配置，产生一个过期时间
	ExpireIn() timer.Expire
}