goth: Index | Files

package github

import ""

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.


Package Files

github.go session.go


var (
    AuthURL    = ""
    TokenURL   = ""
    ProfileURL = ""
    EmailURL   = ""

These vars define the Authentication, Token, and API URLS for GitHub. If using GitHub enterprise you should change these values before calling New.


github.AuthURL = "
github.TokenURL = "
github.ProfileURL = "
github.EmailURL = "

type Provider Uses

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 Uses

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 Uses

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 Uses

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

BeginAuth asks Github for an authentication end-point.

func (*Provider) Client Uses

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

func (*Provider) Debug Uses

func (p *Provider) Debug(debug bool)

Debug is a no-op for the github package.

func (*Provider) FetchUser Uses

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 Uses

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshToken Uses

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

RefreshToken refresh token is not provided by github

func (*Provider) RefreshTokenAvailable Uses

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is not provided by github

func (*Provider) SetName Uses

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 Uses

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

UnmarshalSession will unmarshal a JSON string into a session.

type Session Uses

type Session struct {
    AuthURL     string
    AccessToken string

Session stores data during the auth process with Github.

func (*Session) Authorize Uses

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 Uses

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

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

func (Session) Marshal Uses

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String Uses

func (s Session) String() string

Package github imports 11 packages (graph) and is imported by 109 packages. Updated 2020-05-08. Refresh now. Tools for package owners.