sso

Documentation

Index

• Constants
• func Initialize(sso *config.SSO) error
• func NextState() string
• func Register(name Vendor, p Provider)
• type Link
  • func AuthCodeLinks(redirect string, client string) []Link
• type Provider
  • func WithName(name Vendor) Provider
• type Token
• type Vendor
  • func (v Vendor) String() string

Constants

const URIAuthCodeCallback = "/login/auth/callback"

Functions

func Initialize

func Initialize(sso *config.SSO) error

Initialize init the provider(s) successfully, if not, crash it

func NextState

func NextState() string

NextState generate a new oauth2's state code

func Register

func Register(name Vendor, p Provider)

Register register a provider with the name

Types

type Link

type Link struct {
	Name string
	Link string
}

Link represents a sso vendor name &　the auth code link pair

func AuthCodeLinks

func AuthCodeLinks(redirect string, client string) []Link

AuthCodeLinks generates the all sso vendor name &　the auth code link pairs If the node port equals `0`, which means the login request is not started from the PairMesh node.

type Provider

type Provider interface {
	Setup(cfg *config.SSO) error
	AuthCodeURL(redirect, client string) string
	AccessToken(code string) (*Token, error)
	UserInfo(token *Token) (*models.User, bool, error)
}

Provider represents the sso vendor

func WithName

func WithName(name Vendor) Provider

WithName returns the provider with the name

type Token

type Token struct {
	AccessToken string
	Raw         map[string]string //extra data for diff platform
}

type Vendor

type Vendor int

Vendor represents the current sso provider (github, ...)

const (
	GitHub Vendor = iota
)

func (Vendor) String

func (v Vendor) String() string

String implements the fmt.Stringer interface