session

README

Nibbler Session

Provides a session for the server to use.

An SQL connector is available out of the box, which can be used in memory mode by not providing a DB reference.

The default MaxAge is 30 days (86400 * 30) in all cases (which is pretty long).

Documentation

Index

• type Extension
  • func (s *Extension) EnforceEmailValidated(routerFunc func(http.ResponseWriter, *http.Request)) func(http.ResponseWriter, *http.Request)
  • func (s *Extension) EnforceLoggedIn(routerFunc func(http.ResponseWriter, *http.Request)) func(http.ResponseWriter, *http.Request)
  • func (s *Extension) EnforceParamMatchesCallerID(param string, routerFunc func(http.ResponseWriter, *http.Request)) func(http.ResponseWriter, *http.Request)
  • func (s *Extension) GetAttribute(r *http.Request, attribute string) (interface{}, error)
  • func (s *Extension) GetCaller(r *http.Request) (*nibbler.User, error)
  • func (s *Extension) GetName() string
  • func (s *Extension) Init(app *nibbler.Application) error
  • func (s *Extension) SetAttribute(w http.ResponseWriter, r *http.Request, key string, value interface{}) error
  • func (s *Extension) SetCaller(w http.ResponseWriter, r *http.Request, userValue *nibbler.User) error
• type StoreConnector

Types

type Extension

type Extension struct {
	nibbler.NoOpExtension
	SessionName    string
	StoreConnector StoreConnector // creates cookie store if not provided
	// contains filtered or unexported fields
}

func (*Extension) EnforceEmailValidated

func (s *Extension) EnforceEmailValidated(routerFunc func(http.ResponseWriter, *http.Request)) func(http.ResponseWriter, *http.Request)

EnforceEmailValidated validates the user is logged in and that user's email has been validated. Note that the session extension can't validate emails, but extensions like the user-local-auth extension can

func (*Extension) EnforceLoggedIn

func (s *Extension) EnforceLoggedIn(routerFunc func(http.ResponseWriter, *http.Request)) func(http.ResponseWriter, *http.Request)

func (*Extension) EnforceParamMatchesCallerID

func (s *Extension) EnforceParamMatchesCallerID(param string, routerFunc func(http.ResponseWriter, *http.Request)) func(http.ResponseWriter, *http.Request)

EnforceParamMatchesCallerID will validate that the user is logged in and is requesting a resource that's identified by a user ID that matches the caller's ID. The param argument to this function determines which path param is checked against the caller's ID.

func (*Extension) GetAttribute

func (s *Extension) GetAttribute(r *http.Request, attribute string) (interface{}, error)

func (*Extension) GetCaller

func (s *Extension) GetCaller(r *http.Request) (*nibbler.User, error)

func (*Extension) GetName

func (s *Extension) GetName() string

func (*Extension) Init

func (s *Extension) Init(app *nibbler.Application) error

func (*Extension) SetAttribute

func (s *Extension) SetAttribute(w http.ResponseWriter, r *http.Request, key string, value interface{}) error

TODO: SetAttributes to set multiple attributes in one save

func (*Extension) SetCaller

func (s *Extension) SetCaller(w http.ResponseWriter, r *http.Request, userValue *nibbler.User) error

SetCaller puts the user into the session as the current user

type StoreConnector

type StoreConnector interface {
	Connect() (error, sessions.Store) // TODO: reverse param order
	MaxAge() int
}