web

README

Go Incremental - Web

General purpose web interface library for use by goincremental projects, loosely wrapping best in class go web libraries

Documentation

Overview

Package oauth2 contains Negroni middleware to provide user login via an OAuth 2.0 backend.

Index

• Variables
• func Facebook(opts *oauth2.Options) http.Handler
• func GetDb(r *http.Request) dal.Database
• func Github(opts *oauth2.Options) http.Handler
• func Google(opts *oauth2.Options) http.Handler
• func LinkedIn(opts *oauth2.Options) http.Handler
• func LoadEnv()
• func NewOAuth2Provider(opts *oauth2.Options, authUrl, tokenUrl string) http.HandlerFunc
• func Params(req *http.Request) map[string]string
• func SetDb(r *http.Request, val dal.Database)
• func SetRenderer(r *http.Request, val Renderer)
• func SetSession(r *http.Request, val *Session)
• func SetSessionStore(r *http.Request, val SessionStore)
• type Environment
• type Middleware
  • func LoginRequired() Middleware
• type MiddlewareFunc
  • func (h MiddlewareFunc) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
• type Options
• type Renderer
  • func GetRenderer(r *http.Request) Renderer
  • func NewRenderer() Renderer
• type Route
• type Router
  • func NewRouter() Router
• type Server
  • func NewServer() Server
• type Session
  • func GetSession(r *http.Request) *Session
  • func (s *Session) Delete(key interface{})
  • func (s *Session) Get(key interface{}) interface{}
  • func (s *Session) Set(key interface{}, val interface{})
• type SessionStore
  • func GetSessionStore(r *http.Request) SessionStore
  • func NewSessionStore(c dal.Collection, maxAge int, ensureTTL bool, keyPairs ...[]byte) SessionStore
• type Tokens

Variables

var (
	// Path to handle OAuth 2.0 logins.
	PathLogin = "/login"
	// Path to handle OAuth 2.0 logouts.
	PathLogout = "/logout"
	// Path to handle callback from OAuth 2.0 backend
	// to exchange credentials.
	PathCallback = "/oauth2callback"
	// Path to handle error cases.
	PathError = "/oauth2error"
)

var (
	ErrInvalidId       = errors.New("session: invalid session id")
	ErrInvalidModified = errors.New("mongostore: invalid modified value")
)

Functions

func Facebook

func Facebook(opts *oauth2.Options) http.Handler

func GetDb

func GetDb(r *http.Request) dal.Database

func Github

func Github(opts *oauth2.Options) http.Handler

Returns a new Github OAuth 2.0 backend endpoint.

func Google

func Google(opts *oauth2.Options) http.Handler

Returns a new Google OAuth 2.0 backend endpoint.

func LinkedIn

func LinkedIn(opts *oauth2.Options) http.Handler

func LoadEnv

func LoadEnv()

func NewOAuth2Provider

func NewOAuth2Provider(opts *oauth2.Options, authUrl, tokenUrl string) http.HandlerFunc

Returns a generic OAuth 2.0 backend endpoint.

func Params

func Params(req *http.Request) map[string]string

func SetDb

func SetDb(r *http.Request, val dal.Database)

func SetRenderer

func SetRenderer(r *http.Request, val Renderer)

func SetSession

func SetSession(r *http.Request, val *Session)

func SetSessionStore

func SetSessionStore(r *http.Request, val SessionStore)

Types

type Environment

type Environment interface {
	Load(filenames ...string) error
}

type Middleware

type Middleware interface {
	ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)
}

func LoginRequired

func LoginRequired() Middleware

Handler that redirects user to the login page if user is not logged in.

type MiddlewareFunc

type MiddlewareFunc func(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)

func (MiddlewareFunc) ServeHTTP

func (h MiddlewareFunc) ServeHTTP(rw http.ResponseWriter, r *http.Request, next http.HandlerFunc)

type Options

type Options struct {
	Path   string
	Domain string
	// MaxAge=0 means no 'Max-Age' attribute specified.
	// MaxAge<0 means delete cookie now, equivalently 'Max-Age: 0'.
	// MaxAge>0 means Max-Age attribute present and given in seconds.
	MaxAge   int
	Secure   bool
	HttpOnly bool
}

type Renderer

type Renderer interface {
	XML(w http.ResponseWriter, status int, v interface{})
	HTML(w http.ResponseWriter, status int, name string, binding interface{})
}

func GetRenderer

func GetRenderer(r *http.Request) Renderer

func NewRenderer

func NewRenderer() Renderer

type Route

type Route interface {
	Methods(s ...string) Route
}

type Router

type Router interface {
	http.Handler
	HandleFunc(s string, f func(http.ResponseWriter, *http.Request)) Route
	Handle(path string, handler http.Handler) Route
}

func NewRouter

func NewRouter() Router

type Server

type Server interface {
	Run(port string)
	Use(handler Middleware)
	UseHandler(http.Handler)
	ServeHTTP(rw http.ResponseWriter, r *http.Request)
}

func NewServer

func NewServer() Server

type Session

type Session struct {
	ID      string
	Values  map[interface{}]interface{}
	Options *Options
	IsNew   bool
	// contains filtered or unexported fields
}

func GetSession

func GetSession(r *http.Request) *Session

func (*Session) Delete

func (s *Session) Delete(key interface{})

func (*Session) Get

func (s *Session) Get(key interface{}) interface{}

func (*Session) Set

func (s *Session) Set(key interface{}, val interface{})

type SessionStore

type SessionStore interface {
	GetSession(r *http.Request, name string) (s *Session, err error)
	SaveSession(r *http.Request, w http.ResponseWriter, session *Session) error
}

func GetSessionStore

func GetSessionStore(r *http.Request) SessionStore

func NewSessionStore

func NewSessionStore(c dal.Collection, maxAge int, ensureTTL bool, keyPairs ...[]byte) SessionStore

NewSessionStore returns a new SessionStore (currently uses default dal implementation) Set ensureTTL to true let the database auto-remove expired object by maxAge.

type Tokens

type Tokens interface {
	Access() string
	Refresh() string
	IsExpired() bool
	ExpiryTime() time.Time
	ExtraData() map[string]string
}

Represents a container that contains user's OAuth 2.0 access and refresh tokens.