github

Documentation

Index

• func New(c *config.Auth) auth.Provider
• type Config
  • func (c *Config) Exchange(code string) (*oauth2.Token, error)
  • func (c *Config) Name() string
  • func (c *Config) Revoke(token *oauth2.Token) error
  • func (c *Config) StartSession(state string) *auth.Session
  • func (c *Config) Username(token *oauth2.Token) string
  • func (c *Config) Valid(token *oauth2.Token) bool

Functions

func New

func New(c *config.Auth) auth.Provider

New creates a new Github provider from a configuration.

Types

type Config

type Config struct {
	// contains filtered or unexported fields
}

Config is an implementation of `auth.Provider` for authenticating using a Github account.

func (*Config) Exchange

func (c *Config) Exchange(code string) (*oauth2.Token, error)

Exchange authorizes the session and returns an access token.

func (*Config) Name

func (c *Config) Name() string

Name returns the name of the provider.

func (*Config) Revoke

func (c *Config) Revoke(token *oauth2.Token) error

GitHub doesn't seem to allow token revocation - tokens are indefinite and there are no refresh options etc. Returns nil to satisfy the Provider interface.

func (*Config) StartSession

func (c *Config) StartSession(state string) *auth.Session

StartSession retrieves an authentication endpoint from Github.

func (*Config) Username

func (c *Config) Username(token *oauth2.Token) string

Username retrieves the username portion of the user's email address.

func (*Config) Valid

func (c *Config) Valid(token *oauth2.Token) bool

Valid validates the oauth token.