Documentation
¶
Overview ¶
Package github implements the OAuth2 protocol for authenticating users through Github. This package can be used as a reference implementation of an OAuth2 provider for Goth.
Index ¶
- Variables
- type Provider
- func (p *Provider) BeginAuth(state string) (goth.Session, error)
- func (p *Provider) Debug(debug bool)
- func (p *Provider) FetchUser(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) UnmarshalSession(data string) (goth.Session, error)
- type Session
Constants ¶
This section is empty.
Variables ¶
var ( AuthURL = "https://github.com/login/oauth/authorize" TokenURL = "https://github.com/login/oauth/access_token" ProfileURL = "https://api.github.com/user" EmailURL = "https://api.github.com/user/emails" )
These vars define the Authentication, Token, and API URLS for GitHub. If using GitHub enterprise you should change these values before calling New.
Examples:
github.AuthURL = "https://github.acme.com/login/oauth/authorize github.TokenURL = "https://github.acme.com/login/oauth/access_token github.ProfileURL = "https://github.acme.com/api/v3/user github.EmailURL = "https://github.acme.com/api/v3/user/emails
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 Github.
func New ¶
New creates a new Github provider, and sets up important connection details. You should always call `github.New` to get a new Provider. Never try to create one manually.
func (*Provider) FetchUser ¶
FetchUser will go to Github and access basic information about the user.
func (*Provider) RefreshToken ¶
RefreshToken refresh token is not provided by github
func (*Provider) RefreshTokenAvailable ¶
RefreshTokenAvailable refresh token is not provided by github
type Session ¶
Session stores data during the auth process with Github.
func (*Session) Authorize ¶
Authorize the session with Github 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 Github provider.
Source Files