github

Documentation

Overview

Package github implements OAuth2 based authentication for github

https://www.pomerium.io/docs/identity-providers/github.html

Index

• Constants
• type Provider
  • func New(ctx context.Context, o *oauth.Options) (*Provider, error)
  • func (p *Provider) Authenticate(ctx context.Context, code string) (*sessions.State, error)
  • func (p *Provider) GetSignInURL(state string) string
  • func (p *Provider) LogOut() (*url.URL, error)
  • func (p *Provider) Refresh(ctx context.Context, s *sessions.State) (*sessions.State, error)
  • func (p *Provider) Revoke(ctx context.Context, token *oauth2.Token) error

Constants

const Name = "github"

Name identifies the GitHub identity provider

Types

type Provider

type Provider struct {
	Oauth *oauth2.Config
	// contains filtered or unexported fields
}

Provider is an implementation of the OAuth Provider.

func New

func New(ctx context.Context, o *oauth.Options) (*Provider, error)

New instantiates an OAuth2 provider for Github.

func (*Provider) Authenticate

func (p *Provider) Authenticate(ctx context.Context, code string) (*sessions.State, error)

Authenticate creates an identity session with github from a authorization code, and follows up call to the user and user group endpoint with the

func (*Provider) GetSignInURL

func (p *Provider) GetSignInURL(state string) string

GetSignInURL returns a URL to OAuth 2.0 provider's consent page that asks for permissions for the required scopes explicitly.

func (*Provider) LogOut

func (p *Provider) LogOut() (*url.URL, error)

LogOut is not implemented by github.

func (*Provider) Refresh

func (p *Provider) Refresh(ctx context.Context, s *sessions.State) (*sessions.State, error)

Refresh renews a user's session by making a new userInfo request.

func (*Provider) Revoke

func (p *Provider) Revoke(ctx context.Context, token *oauth2.Token) error

Revoke method will remove all the github grants the user gave pomerium application during authorization.

https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-authorization