github

Documentation

Overview

Package github provides OKs and tokens for GitHub authentication.

Index

• func Context(ctx context.Context, r *http.Request) context.Context
• func Show(ctx context.Context) (string, bool)
• func VerifyLogin(ok okay.OK, logins ...string) okay.OK
• type Config
  • func (c *Config) RegisterHandlers(path string) error

Functions

func Context

func Context(ctx context.Context, r *http.Request) context.Context

Context returns a context that is updated with a GitHub authentication token from the given HTTP request, if it exists.

func Show

func Show(ctx context.Context) (string, bool)

Show reports the value of the verified credentials, if any.

func VerifyLogin

func VerifyLogin(ok okay.OK, logins ...string) okay.OK

VerifyLogin returns an OK that will verify users by their GitHub login.

Types

type Config

type Config struct {
	ClientID     string
	ClientSecret string
	RedirectURI  string
	LogoutPath   string
}

func (*Config) RegisterHandlers

func (c *Config) RegisterHandlers(path string) error

RegisterHandlers registers GitHub authentication handlers. The given path is the landing URL to begin the sign-in flow, and the return handler is registered at the URL listed in the config.