auth

Documentation

Index

• Constants
• type Google
  • func NewGoogleProvider(clientID, clientSecret, baseURL string) Google
  • func (g Google) AccessToken(code string) (*oauth2.Token, error)
  • func (Google) Name() string
  • func (g Google) RedirectURL() string
  • func (g Google) UserInfo(token *oauth2.Token) (u ProviderUser, err error)
• type Provider
• type ProviderUser

Constants

const (
	GoogleProvider = "Google"
)

Available providers.

Types

type Google

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

Google is the provider for Google Authentication.

func NewGoogleProvider

func NewGoogleProvider(clientID, clientSecret, baseURL string) Google

NewGoogleProvider initializes the provider for Gooogle.

func (Google) AccessToken

func (g Google) AccessToken(code string) (*oauth2.Token, error)

AccessToken retrieves an access token user has returned from Google.

func (Google) Name

func (Google) Name() string

Name returns the provider's name.

func (Google) RedirectURL

func (g Google) RedirectURL() string

RedirectURL returns the redirect URL for authentication.

func (Google) UserInfo

func (g Google) UserInfo(token *oauth2.Token) (u ProviderUser, err error)

UserInfo retrieves information about the user from the provider.

type Provider

type Provider interface {
	// Returns the provider's name.
	Name() string

	// Returns the redirect URL for authentication with the provider.
	RedirectURL() string

	// Retrieves an access token user has returned from provider.
	AccessToken(code string) (*oauth2.Token, error)

	// Retrieves information about the user from the provider.
	UserInfo(token *oauth2.Token) (ProviderUser, error)
}

Provider is an authentication provider such as Facebook and Google.

type ProviderUser

type ProviderUser struct {
	UserID      string
	Email       string
	Name        string
	Lastname    string
	Fullname    string
	AccessToken string
}

ProviderUser is information about an user retrieved from provider.