Documentation
¶
Overview ¶
Package google provides Google OAuth2 login and callback handlers.
Index ¶
- Constants
- Variables
- func CallbackHandler(config *oauth2.Config, success, failure http.Handler) http.Handler
- func ErrorFromContext(ctx context.Context) error
- func LoginHandler(config *oauth2.Config, failure http.Handler) http.Handler
- func StateHandler(config sessions.CookieConfig, success http.Handler) http.Handler
- func UserFromContext(ctx context.Context) (*google.Userinfo, error)
- func WithError(ctx context.Context, err error) context.Context
- func WithUser(ctx context.Context, user *google.Userinfo) context.Context
Constants ¶
const (
ProviderName = "GOOGLE"
)
Variables ¶
var ( // ErrServerError returns a generic server error ErrServerError = errors.New("server error") // ErrContextMissingGoogleUser is returned when the Google user is missing from the context ErrContextMissingGoogleUser = errors.New("context missing google user") // ErrFailedConstructingEndpointURL is returned when URL is invalid and unable to be parsed ErrFailedConstructingEndpointURL = errors.New("error constructing URL") // ErrUnableToGetGoogleUser when the user cannot be retrieved from Google ErrUnableToGetGoogleUser = errors.New("unable to get google user") // ErrCannotValidateGoogleUser when the Google user is invalid ErrCannotValidateGoogleUser = errors.New("could not validate google user") // ErrContextMissingErrorValue is returned when the context does not have an error value ErrContextMissingErrorValue = fmt.Errorf("context missing error value") )
var DefaultFailureHandler = http.HandlerFunc(failureHandler)
DefaultFailureHandler responds with a 400 status code and message parsed from the context
Functions ¶
func CallbackHandler ¶
CallbackHandler handles Google redirection URI requests and adds the Google access token and Userinfo to the ctx
func ErrorFromContext ¶
ErrorFromContext returns the error value from the ctx or an error that the context was missing an error value
func LoginHandler ¶
LoginHandler handles Google login requests by reading the state value from the ctx and redirecting requests to the AuthURL with that state value
func StateHandler ¶
StateHandler checks for a state cookie, if found, adds to context; if missing, a random generated value is added to the context and to a (short-lived) state cookie issued to the requester - this implements OAuth 2 RFC 6749 10.12 CSRF Protection
func UserFromContext ¶
UserFromContext returns the Google Userinfo from the ctx
Types ¶
This section is empty.
Source Files