github

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 New(clientKey, secret, callbackURL string, scopes ...string) *Provider
  • func NewCustomisedURL(clientKey, secret, callbackURL, authURL, tokenURL, profileURL, emailURL string, ...) *Provider
  • func (p *Provider) BeginAuth(state string) (goth.Session, error)
  • func (p *Provider) Client() *http.Client
  • 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) SetName(name 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) GetAuthURL() (string, error)
  • func (s Session) Marshal() string
  • func (s Session) String() string

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

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 Github.

func New

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

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 NewCustomisedURL

func NewCustomisedURL(clientKey, secret, callbackURL, authURL, tokenURL, profileURL, emailURL string, scopes ...string) *Provider

NewCustomisedURL is similar to New(...) but can be used to set custom URLs to connect to

func (*Provider) BeginAuth

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

BeginAuth asks Github for an authentication end-point.

func (*Provider) Client

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

func (*Provider) Debug

func (p *Provider) Debug(debug bool)

Debug is a no-op for the github package.

func (*Provider) FetchUser

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

FetchUser will go to Github 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 refresh token is not provided by github

func (*Provider) RefreshTokenAvailable

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is not provided by github

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) UnmarshalSession

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

UnmarshalSession will unmarshal a JSON string into a session.

type Session

type Session struct {
	AuthURL     string
	AccessToken string
}

Session stores data during the auth process with GitHub.

func (*Session) Authorize

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

Authorize the session with GitHub 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 GitHub provider.

func (Session) Marshal

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String

func (s Session) String() string