oauth

Documentation

Index

• type BaseHandler
• type GitHubHandler
  • func NewGitHubHandler(clientID, clientSecret, authURL string, logger *slog.Logger) *GitHubHandler
  • func (h GitHubHandler) GetUserEmailAddress(code string) (string, error)
• type GoogleHandler
  • func NewGoogleHandler(clientID, clientSecret, authURL string, logger *slog.Logger) *GoogleHandler
  • func (h GoogleHandler) GetUserEmailAddress(code string) (string, error)
• type Handler
  • func NewHandler(provider, clientID, clientSecret, authURL string, logger *slog.Logger) (Handler, error)

Types

type BaseHandler

type BaseHandler struct {
	oauth2.Config
	HTTPClient *http.Client
	Logger     *slog.Logger
}

BaseHandler implements the generic part of a Handler.

type GitHubHandler

type GitHubHandler struct {
	BaseHandler
}

GitHubHandler performs the OAuth handshake using GitHub as authenticator and get the email address for the authenticated user.

func NewGitHubHandler

func NewGitHubHandler(clientID, clientSecret, authURL string, logger *slog.Logger) *GitHubHandler

NewGitHubHandler returns a new Handler for GitHub.

func (GitHubHandler) GetUserEmailAddress

func (h GitHubHandler) GetUserEmailAddress(code string) (string, error)

GetUserEmailAddress returns the authenticated user's email address

type GoogleHandler

type GoogleHandler struct {
	BaseHandler
}

GoogleHandler performs the OAuth handshake using Google as authenticator and get the email address for the authenticated user.

func NewGoogleHandler

func NewGoogleHandler(clientID, clientSecret, authURL string, logger *slog.Logger) *GoogleHandler

NewGoogleHandler returns a new Handler for Google.

func (GoogleHandler) GetUserEmailAddress

func (h GoogleHandler) GetUserEmailAddress(code string) (string, error)

GetUserEmailAddress returns the authenticated user's email address

type Handler

type Handler interface {
	AuthCodeURL(state string, opts ...oauth2.AuthCodeOption) string
	GetUserEmailAddress(code string) (string, error)
}

A Handler performs the OAuth handshake and get the email address for the authenticated user.

func NewHandler

func NewHandler(provider, clientID, clientSecret, authURL string, logger *slog.Logger) (Handler, error)

NewHandler returns a new Handler for the selected provider. Currently, google and github are supported.