oidcx

Documentation

Index

• type CallbackOutput
• type Config
• type SsoClient
  • func New(cf Config) (*SsoClient, error)
  • 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) error

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
	ClientId        string
	ClientSecret    string
	CoverAttributes bool
	SkipTlsVerify   bool
	Attributes      struct {
		Nickname string
		Username string
		Phone    string
		Email    string
	}
	DefaultRoles []string
}

type SsoClient

type SsoClient struct {
	Enable          bool
	Verifier        *oidc.IDTokenVerifier
	Config          oauth2.Config
	SsoAddr         string
	CallbackAddr    string
	CoverAttributes bool
	DisplayName     string
	Attributes      struct {
		Username string
		Nickname string
		Phone    string
		Email    string
	}
	DefaultRoles []string

	Ctx      context.Context
	Provider *oidc.Provider
	sync.RWMutex
}

func New

func New(cf Config) (*SsoClient, error)

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) error