oauth2

Documentation

Index

• Variables
• func NewGoogleProvider(clientID, clientSecret, redirectURL string) *googleProvider
• func NewOidcProvider(ctx context.Context, ...) (*oidcProvider, error)
• type Authorization
  • func GenerateAuthorization(config *oauth2.Config) *Authorization
  • func (u *Authorization) CodeVerifier() string
  • func (u *Authorization) RedirectURL() string
  • func (u *Authorization) State() string
• type Manager
  • func NewManager(ctx context.Context, ...) *Manager
  • func (m *Manager) AddProvider(name string, provider Provider)
  • func (m *Manager) FindProvider(name string) (Provider, error)
• type Profile
  • func (p Profile) String() string
• type Provider

Variables

var (
	ErrEmptyUsername = errors.New("oidc: username is empty")
)

Functions

func NewGoogleProvider

func NewGoogleProvider(clientID, clientSecret, redirectURL string) *googleProvider

func NewOidcProvider

func NewOidcProvider(ctx context.Context, clientID, clientSecret, redirectURL, discoveryEndpoint string) (*oidcProvider, error)

Types

type Authorization

type Authorization struct {
	// contains filtered or unexported fields
}

func GenerateAuthorization

func GenerateAuthorization(config *oauth2.Config) *Authorization

func (*Authorization) CodeVerifier

func (u *Authorization) CodeVerifier() string

func (*Authorization) RedirectURL

func (u *Authorization) RedirectURL() string

func (*Authorization) State

func (u *Authorization) State() string

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

func NewManager

func NewManager(ctx context.Context, clientID, clientSecret, redirectURL, oidcDiscoveryEndpoint string) *Manager

func (*Manager) AddProvider

func (m *Manager) AddProvider(name string, provider Provider)

func (*Manager) FindProvider

func (m *Manager) FindProvider(name string) (Provider, error)

type Profile

type Profile struct {
	Key      string
	ID       string
	Username string
}

Profile is the OAuth2 user profile.

func (Profile) String

func (p Profile) String() string

type Provider

type Provider interface {
	GetConfig() *oauth2.Config
	GetUserExtraKey() string
	GetProfile(ctx context.Context, code, codeVerifier string) (*Profile, error)
	PopulateUserCreationWithProfileID(user *model.UserCreationRequest, profile *Profile)
	PopulateUserWithProfileID(user *model.User, profile *Profile)
	UnsetUserProfileID(user *model.User)
}

Provider is an interface for OAuth2 providers.