google

Documentation

Overview

Package google implements the OAuth2 protocol for authenticating users through Google.

Index

• Variables
• type Provider
  • func New(clientKey, secret, callbackURL string, scopes ...string) *Provider
  • func (p *Provider) BeginAuth(state string) (rmxOAuth.Session, error)
  • func (p *Provider) Client() *http.Client
  • func (p *Provider) Debug(debug bool)
  • func (p *Provider) FetchUser(session rmxOAuth.Session) (rmxOAuth.User, error)
  • func (p *Provider) Name() string
  • func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)
  • func (p *Provider) RefreshTokenAvailable() bool
  • func (p *Provider) SetAccessType(at string)
  • func (p *Provider) SetHostedDomain(hd string)
  • func (p *Provider) SetLoginHint(loginHint string)
  • func (p *Provider) SetName(name string)
  • func (p *Provider) SetPrompt(prompt ...string)
  • func (p *Provider) UnmarshalSession(data string) (rmxOAuth.Session, error)
• type Session
  • func (s *Session) Authorize(provider rmxOAuth.Provider, params rmxOAuth.Params) (string, error)
  • func (s Session) GetAuthURL() (string, error)
  • func (s Session) Marshal() (string, error)

Variables

var Endpoint = goog.Endpoint

Endpoint is Google's OAuth 2.0 endpoint.

Types

type Provider

type Provider struct {
	ClientKey   string
	Secret      string
	CallbackURL string
	HTTPClient  *http.Client
	// contains filtered or unexported fields
}

Provider is the implementation of `goth.Provider` for accessing Google.

func New

func New(clientKey, secret, callbackURL string, scopes ...string) *Provider

New creates a new Google provider, and sets up important connection details. You should always call `google.New` to get a new Provider. Never try to create one manually.

func (*Provider) BeginAuth

func (p *Provider) BeginAuth(state string) (rmxOAuth.Session, error)

BeginAuth asks Google for an authentication endpoint.

func (*Provider) Client

func (p *Provider) Client() *http.Client

Client returns an HTTP client to be used in all fetch operations.

func (*Provider) Debug

func (p *Provider) Debug(debug bool)

Debug is a no-op for the google package.

func (*Provider) FetchUser

func (p *Provider) FetchUser(session rmxOAuth.Session) (rmxOAuth.User, error)

FetchUser will go to Google and access basic information about the user.

func (*Provider) Name

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshToken

func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)

RefreshToken get new access token based on the refresh token

func (*Provider) RefreshTokenAvailable

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is provided by auth provider or not

func (*Provider) SetAccessType

func (p *Provider) SetAccessType(at string)

SetAccessType sets the access_type parameter for the Google OAuth call. If an access token is being requested, the client does not receive a refresh token unless a value of offline is specified. See https://developers.google.com/identity/protocols/oauth2/openid-connect#access-type-param

func (*Provider) SetHostedDomain

func (p *Provider) SetHostedDomain(hd string)

SetHostedDomain sets the hd parameter for google OAuth call. Use this to force user to pick user from specific hosted domain. See https://developers.google.com/identity/protocols/oauth2/openid-connect#hd-param

func (*Provider) SetLoginHint

func (p *Provider) SetLoginHint(loginHint string)

SetLoginHint sets the login_hint parameter for the Google OAuth call. Use this to prompt the user to log in with a specific account. See https://developers.google.com/identity/protocols/oauth2/openid-connect#login-hint

func (*Provider) SetName

func (p *Provider) SetName(name string)

SetName is to update the name of the provider (needed in case of multiple providers of 1 type)

func (*Provider) SetPrompt

func (p *Provider) SetPrompt(prompt ...string)

SetPrompt sets the prompt values for the google OAuth call. Use this to force users to choose and account every time by passing "select_account", for example. See https://developers.google.com/identity/protocols/OpenIDConnect#authenticationuriparameters

func (*Provider) UnmarshalSession

func (p *Provider) UnmarshalSession(data string) (rmxOAuth.Session, error)

UnmarshalSession will unmarshal a JSON string into a session.

type Session

type Session struct {
	AuthURL      string
	AccessToken  string
	RefreshToken string
	ExpiresAt    time.Time
	IDToken      string
}

Session stores data during the auth process with Google.

func (*Session) Authorize

func (s *Session) Authorize(provider rmxOAuth.Provider, params rmxOAuth.Params) (string, error)

Authorize the session with Google and return the access token to be stored for future use.

func (Session) GetAuthURL

func (s Session) GetAuthURL() (string, error)

GetAuthURL will return the URL set by calling the `BeginAuth` function on the Google provider.

func (Session) Marshal

func (s Session) Marshal() (string, error)

Marshal the session into a string