echoauth

Documentation

Index

• Constants
• Variables
• type Client
  • func (cli *Client) Begin(ctx echo.Context) error
  • func (cli *Client) Callback(fnk func(user goth.User, err error, ctx echo.Context) error) echo.HandlerFunc
  • func (cli *Client) GetAuthURL(ctx echo.Context) (string, error)
  • func (cli *Client) GetUser(ctx echo.Context) (goth.User, error)
• type Session
• type SessionStore

Constants

const SessionName = "_gothic_session"

SessionName is the key used to access the session store.

Variables

var (
	ErrUndefinedProvider = errors.New("Undefined provider name")
)

Errors list

Types

type Client

type Client struct {
	DefaultProvider string
	Store           SessionStore
}

Client OAuth authorize

func (*Client) Begin

func (cli *Client) Begin(ctx echo.Context) error

Begin auth session

func (*Client) Callback

func (cli *Client) Callback(fnk func(user goth.User, err error, ctx echo.Context) error) echo.HandlerFunc

Callback from oauth server

func (*Client) GetAuthURL

func (cli *Client) GetAuthURL(ctx echo.Context) (string, error)

GetAuthURL starts the authentication process with the requested provided. It will return a URL that should be used to send users to.

It expects to be able to get the name of the provider from the query parameters as either "provider" or ":provider".

I would recommend using the BeginAuthHandler instead of doing all of these steps yourself, but that's entirely up to you.

func (*Client) GetUser

func (cli *Client) GetUser(ctx echo.Context) (goth.User, error)

GetUser object for oauth response

type Session

type Session interface {
	Get(key string) (interface{}, error)
	Set(key string, value interface{}) error
	Delete(key string) error
	Save(ctx echo.Context) error
}

Session interface

type SessionStore

type SessionStore interface {
	Get(ctx echo.Context) (Session, error)
}

SessionStore session accessor