const (
DefaultRoute = "/api/github/auth"
)
var (
DefaultSessionKey = "oauth2.state"
)
var (
ErrInvalidState = errors.New("oauth2: invalid state value")
)
func DefaultErrorCallback(w http.ResponseWriter, r *http.Request, err error)
func DefaultLoginCallback(w http.ResponseWriter, r *http.Request, login *Login)
func GetConfig(c githubapp.Config, scopes []string) *oauth2.Config
func NewHandler(c *oauth2.Config, params ...Param) http.Handler
NewHandler returns an http.Hander that implements the 3-leg OAuth2 flow on a single endpoint. It accepts callbacks for both error and success conditions so that clients can take action after the auth flow is complete.
type ErrorCallback func(w http.ResponseWriter, r *http.Request, err error)
Login contains information about the result of a successful auth flow.
type Login struct {
Token *oauth2.Token
Client *http.Client
}
type LoginCallback func(w http.ResponseWriter, r *http.Request, login *Login)
LoginError is an error returned as a parameter by the OAuth provider.
type LoginError string
func (err LoginError) Error() string
type Param func(*handler)
func ForceTLS(forceTLS bool) Param
ForceTLS determines if generated URLs always use HTTPS. By default, the protocol of the request is used.
func OnError(c ErrorCallback) Param
OnError sets the error callback.
func OnLogin(c LoginCallback) Param
OnLogin sets the login callback.
func WithRedirectURL(uri string) Param
WithRedirectURL sets a static redirect URL. By default, the redirect URL is generated using the request path, the Host header, and the ForceTLS option.
func WithStore(ss StateStore) Param
WithStore sets the StateStore used to create and verify OAuth2 states. The default state store uses a static value, is insecure, and is not suitable for production use.
type SessionStateStore struct {
Sessions *scs.Manager
}
func (s *SessionStateStore) GenerateState(w http.ResponseWriter, r *http.Request) (string, error)
func (s *SessionStateStore) VerifyState(r *http.Request, expected string) (bool, error)
StateStore generates and verifies the state parameter for OAuth2 flows.
type StateStore interface {
// GenerateState creates a new state value, storing it in a way that can be
// retrieved by VerifyState at a later point.
GenerateState(w http.ResponseWriter, r *http.Request) (string, error)
// VerifyState checks that the state associated with the request matches
// the given state. To avoid timing attacks, implementations should use
// constant-time comparisons if possible.
VerifyState(r *http.Request, state string) (bool, error)
}