oauth2x

Documentation

Index

• type CallbackOutput
• type Config
• type SsoClient
  • func New(cf Config) *SsoClient
  • func (s *SsoClient) Authorize(redis storage.Redis, redirect string) (string, error)
  • func (s *SsoClient) Callback(redis storage.Redis, ctx context.Context, code, state string) (*CallbackOutput, error)
  • func (s *SsoClient) GetDisplayName() string
  • func (s *SsoClient) Reload(cf Config)

Types

type CallbackOutput

type CallbackOutput struct {
	Redirect    string `json:"redirect"`
	Msg         string `json:"msg"`
	AccessToken string `json:"accessToken"`
	Username    string `json:"Username"`
	Nickname    string `json:"Nickname"`
	Phone       string `yaml:"Phone"`
	Email       string `yaml:"Email"`
}

type Config

type Config struct {
	Enable          bool
	DisplayName     string
	RedirectURL     string
	SsoAddr         string
	TokenAddr       string
	UserInfoAddr    string
	TranTokenMethod string
	ClientId        string
	ClientSecret    string
	CoverAttributes bool
	Attributes      struct {
		Username string
		Nickname string
		Phone    string
		Email    string
	}
	DefaultRoles    []string
	UserinfoIsArray bool
	UserinfoPrefix  string
	Scopes          []string
}

type SsoClient

type SsoClient struct {
	Enable          bool
	Config          oauth2.Config
	SsoAddr         string
	UserInfoAddr    string
	TranTokenMethod string
	CallbackAddr    string
	DisplayName     string
	CoverAttributes bool
	Attributes      struct {
		Username string
		Nickname string
		Phone    string
		Email    string
	}
	UserinfoIsArray bool
	UserinfoPrefix  string
	DefaultRoles    []string

	sync.RWMutex
}

func New

func New(cf Config) *SsoClient

func (*SsoClient) Authorize

func (s *SsoClient) Authorize(redis storage.Redis, redirect string) (string, error)

Authorize return the sso authorize location with state

func (*SsoClient) Callback

func (s *SsoClient) Callback(redis storage.Redis, ctx context.Context, code, state string) (*CallbackOutput, error)

Callback 用 code 兑换 accessToken 以及 用户信息

func (*SsoClient) GetDisplayName

func (s *SsoClient) GetDisplayName() string

func (*SsoClient) Reload

func (s *SsoClient) Reload(cf Config)