Documentation
¶
Overview ¶
Package gplus implements the OAuth2 protocol for authenticating users through Google+. This package can be used as a reference implementation of an OAuth2 provider for Goth.
Index ¶
- type Provider
- func (p *Provider) BeginAuth(state string) (goth.Session, error)
- func (p *Provider) BeginAuthCtx(ctx context.Context, state string) (goth.Session, error)
- func (p *Provider) Debug(debug bool)
- func (p *Provider) FetchUser(session goth.Session) (goth.User, error)
- func (p *Provider) FetchUserCtx(ctx context.Context, session goth.Session) (goth.User, error)
- func (p *Provider) Name() string
- func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)
- func (p *Provider) RefreshTokenAvailable() bool
- func (p *Provider) RefreshTokenCtx(ctx context.Context, refreshToken string) (*oauth2.Token, error)
- func (p *Provider) SetPrompt(prompt ...string)
- func (p *Provider) UnmarshalSession(data string) (goth.Session, error)
- type Session
- func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)
- func (s *Session) AuthorizeCtx(ctx context.Context, provider goth.Provider, params goth.Params) (string, error)
- func (s Session) GetAuthURL() (string, error)
- func (s Session) Marshal() string
- func (s Session) String() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct {
ClientKey string
Secret string
CallbackURL string
// contains filtered or unexported fields
}
Provider is the implementation of `goth.Provider` for accessing Google+.
func New ¶
New creates a new Google+ provider, and sets up important connection details. You should always call `gplus.New` to get a new Provider. Never try to create one manually.
func (*Provider) BeginAuthCtx ¶
BeginAuthCtx asks Google+ for an authentication end-point.
func (*Provider) FetchUserCtx ¶
FetchUserCtx will go to Google+ and access basic information about the user.
func (*Provider) RefreshToken ¶
func (*Provider) RefreshTokenAvailable ¶
RefreshTokenAvailable refresh token is provided by auth provider or not
func (*Provider) RefreshTokenCtx ¶
func (p *Provider) RefreshTokenCtx(ctx context.Context, refreshToken string) ( *oauth2.Token, error)
RefreshTokenCtx get new access token based on the refresh token
func (*Provider) SetPrompt ¶
SetPrompt sets the prompt values for the GPlus 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
type Session ¶
Session stores data during the auth process with Facebook.
func (*Session) AuthorizeCtx ¶
func (s *Session) AuthorizeCtx(ctx context.Context, provider goth.Provider, params goth.Params) (string, error)
AuthorizeCtx the session with Google+ and return the access token to be stored for future use.
func (Session) GetAuthURL ¶
GetAuthURL will return the URL set by calling the `BeginAuth` function on the Google+ provider.
Source Files