goath

README

goath

This package is an attempt to provide nice OAuth2 / OpenID Connect (OIDC) interface.

OAuth2 integration is provided in the "x" package. For OpenID Connect (OIDC) providers, please have a look at the other subpackages.

Documentation

Overview

package goath is an attempt to provide nice OAuth2 / OpenID Connect (OIDC) interface.

OAuth2 integration is provided in the "x" package. For OpenID Connect (OIDC) providers, please have a look at the other subpackages.

Index

• func AuthCodeURLWithPKCE(authCodeURL func(state string, opts ...oauth2.AuthCodeOption) string, ...) (url, pkceVerifier string, err error)
• func SetStateCookie(w http.ResponseWriter, intendedURL, prefix string)
• type CallbackResult
• type CookieEncrypter
• type ExchangeHandler
  • func (s ExchangeHandler) HandleCallback(w http.ResponseWriter, r *http.Request, provider Provider) (cr CallbackResult, clearCookies func(), err error)
  • func (s ExchangeHandler) RedirectToAuthCodeURL(w http.ResponseWriter, r *http.Request, provider Provider) error
• type JWT
• type Provider

Functions

func AuthCodeURLWithPKCE

func AuthCodeURLWithPKCE(authCodeURL func(state string, opts ...oauth2.AuthCodeOption) string, state string) (url, pkceVerifier string, err error)

AuthCodeURLWithPKCE is a helper method to generate PKCE codes and send the challenge to the provider (and returning the verifier for later user).

func SetStateCookie

func SetStateCookie(w http.ResponseWriter, intendedURL, prefix string)

SetStateCookie is used to set the state cookie, which stores the intended URL of the user before authentication.

Types

type CallbackResult

type CallbackResult struct {
	// UnmarshalUser will unmarshal the JSON user returned by the provider
	//      var user struct {
	//      	ID    string `json:"sub"`
	//      	Email string `json:"email"`
	//      	Name  string `json:"name"`
	//      }
	//      err = UnmarshalUser(&user)
	UnmarshalUser func(interface{}) error
	Token         *oauth2.Token
	IntendedPath  string
}

type CookieEncrypter

type CookieEncrypter interface {
	Seal(name, cleartext string) string
	Open(name, cyphertext string) (string, error)
}

type ExchangeHandler

type ExchangeHandler struct {
	CookiePrefix    string
	CookieEncrypter CookieEncrypter
}

ExchangeHandler implements the exchange-code flow (including PKCE challenge).

func (ExchangeHandler) HandleCallback

func (s ExchangeHandler) HandleCallback(w http.ResponseWriter, r *http.Request, provider Provider) (cr CallbackResult, clearCookies func(), err error)

HandleCallback should be called after the user logged in at the provider.

func (ExchangeHandler) RedirectToAuthCodeURL

func (s ExchangeHandler) RedirectToAuthCodeURL(w http.ResponseWriter, r *http.Request, provider Provider) error

RedirectToAuthCodeURL should be called to redirect the user to the provider for login.

type JWT

type JWT interface {
	AssertionType() string
	Assertion(aud string) (string, error)
}

type Provider

type Provider interface {
	// SetRedirectURL sets the local callback URL.
	SetRedirectURL(url string)

	// AuthCodeURL returns the Provider URL to redirect the user to.
	AuthCodeURL(state string) (url, pkceVerifier string, err error)

	// Exchange exchanges the code and provides a way to unmarshal the user info.
	//
	//      var user struct {
	//      	ID    string `json:"sub"`
	//      	Email string `json:"email"`
	//      	Name  string `json:"name"`
	//      }
	//      err = unmarshalUser(&user)
	Exchange(code, pkceVerifier string) (token *oauth2.Token, unmarshalUser func(interface{}) error, err error)
}

Provider is an interface suitable for OAuth2 and OIDC flows.