iris

Documentation

Index

• func FromHeader(ctx *context.Context) string
• func FromQuery(ctx *context.Context) string
• func Get(ctx *context.Context) *multi.MultiClaims
• func GetAuthorityId(ctx *context.Context) []string
• func GetAuthorityType(ctx *context.Context) int
• func GetCreationDate(ctx *context.Context) int64
• func GetExpiresIn(ctx *context.Context) int64
• func GetTenancyId(ctx *context.Context) uint
• func GetTenancyName(ctx *context.Context) string
• func GetUserId(ctx *context.Context) uint
• func GetUsername(ctx *context.Context) string
• func GetVerifiedToken(ctx *context.Context) []byte
• func IsAdmin(ctx *context.Context) bool
• func IsGeneral(ctx *context.Context) bool
• func IsTenancy(ctx *context.Context) bool
• type TokenExtractor
  • func FromJSON(jsonKey string) TokenExtractor
• type Verifier
  • func NewVerifier(validators ...multi.TokenValidator) *Verifier
  • func (v *Verifier) RequestToken(ctx *context.Context) (token string)
  • func (v *Verifier) Verify(validators ...multi.TokenValidator) context.Handler
  • func (v *Verifier) VerifyToken(token []byte, validators ...multi.TokenValidator) ([]byte, *multi.MultiClaims, error)

Functions

func FromHeader

func FromHeader(ctx *context.Context) string

FromHeader is a token extractor. It reads the token from the Authorization request header of form: Authorization: "Bearer {token}".

func FromQuery

func FromQuery(ctx *context.Context) string

FromQuery is a token extractor. It reads the token from the "token" url query parameter.

func Get

func Get(ctx *context.Context) *multi.MultiClaims

Get returns the claims decoded by a verifier.

func GetAuthorityId

func GetAuthorityId(ctx *context.Context) []string

GetAuthorityId 角色id

func GetAuthorityType

func GetAuthorityType(ctx *context.Context) int

GetAuthorityType 角色类型

func GetCreationDate

func GetCreationDate(ctx *context.Context) int64

GetCreationDate 登录时间

func GetExpiresIn

func GetExpiresIn(ctx *context.Context) int64

GetExpiresIn 有效期

func GetTenancyId

func GetTenancyId(ctx *context.Context) uint

GetTenancyId 商户id

func GetTenancyName

func GetTenancyName(ctx *context.Context) string

GetTenancyName 商户名称

func GetUserId

func GetUserId(ctx *context.Context) uint

GetUserId 用户id

func GetUsername

func GetUsername(ctx *context.Context) string

GetUsername 用户名

func GetVerifiedToken

func GetVerifiedToken(ctx *context.Context) []byte

func IsAdmin

func IsAdmin(ctx *context.Context) bool

func IsGeneral

func IsGeneral(ctx *context.Context) bool

func IsTenancy

func IsTenancy(ctx *context.Context) bool

Types

type TokenExtractor

type TokenExtractor func(*context.Context) string

TokenExtractor is a function that takes a context as input and returns a token. An empty string should be returned if no token found without additional information.

func FromJSON

func FromJSON(jsonKey string) TokenExtractor

FromJSON is a token extractor. Reads a json request body and extracts the json based on the given field. The request content-type should contain the: application/json header value, otherwise this method will not try to read and consume the body.

type Verifier

type Verifier struct {
	Extractors   []TokenExtractor
	Validators   []multi.TokenValidator
	ErrorHandler func(ctx *context.Context, err error)
}

func NewVerifier

func NewVerifier(validators ...multi.TokenValidator) *Verifier

func (*Verifier) RequestToken

func (v *Verifier) RequestToken(ctx *context.Context) (token string)

RequestToken extracts the token from the

func (*Verifier) Verify

func (v *Verifier) Verify(validators ...multi.TokenValidator) context.Handler

func (*Verifier) VerifyToken

func (v *Verifier) VerifyToken(token []byte, validators ...multi.TokenValidator) ([]byte, *multi.MultiClaims, error)