osinserver

Documentation

Index

• func NewDefaultServerConfig() *osin.ServerConfig
• type AccessHandler
• type AccessHandlerFunc
  • func (f AccessHandlerFunc) HandleAccess(ar *osin.AccessRequest, w http.ResponseWriter) error
• type AccessHandlers
  • func (all AccessHandlers) HandleAccess(ar *osin.AccessRequest, w http.ResponseWriter) error
• type AuthorizeHandler
• type AuthorizeHandlerFunc
  • func (f AuthorizeHandlerFunc) HandleAuthorize(ar *osin.AuthorizeRequest, resp *osin.Response, w http.ResponseWriter) (bool, error)
• type AuthorizeHandlers
  • func (all AuthorizeHandlers) HandleAuthorize(ar *osin.AuthorizeRequest, resp *osin.Response, w http.ResponseWriter) (bool, error)
• type ErrorHandler
  • func NewDefaultErrorHandler() ErrorHandler
• type Logger
  • func (l Logger) Printf(format string, v ...interface{})
• type Server
  • func New(config *osin.ServerConfig, storage osin.Storage, authorize AuthorizeHandler, ...) *Server
  • func (s *Server) Install(mux oauthserver.Mux, paths ...string)
• type TokenGen
  • func (TokenGen) GenerateAccessToken(data *osin.AccessData, generaterefresh bool) (string, string, error)
  • func (TokenGen) GenerateAuthorizeToken(data *osin.AuthorizeData) (ret string, err error)

Functions

func NewDefaultServerConfig

func NewDefaultServerConfig() *osin.ServerConfig

Types

type AccessHandler

type AccessHandler interface {
	// HandleAccess populates an AccessRequest (typically the Authorized and UserData fields)
	HandleAccess(ar *osin.AccessRequest, w http.ResponseWriter) error
}

AccessHandler populates an AccessRequest

type AccessHandlerFunc

type AccessHandlerFunc func(ar *osin.AccessRequest, w http.ResponseWriter) error

func (AccessHandlerFunc) HandleAccess

func (f AccessHandlerFunc) HandleAccess(ar *osin.AccessRequest, w http.ResponseWriter) error

type AccessHandlers

type AccessHandlers []AccessHandler

func (AccessHandlers) HandleAccess

func (all AccessHandlers) HandleAccess(ar *osin.AccessRequest, w http.ResponseWriter) error

type AuthorizeHandler

type AuthorizeHandler interface {
	// HandleAuthorize does one of the following:
	// 1. populates an AuthorizeRequest (typically the Authorized and UserData fields) and returns false
	// 2. populates the error fields of a Response object and returns false
	// 3. returns an internal server error and returns false
	// 4. writes the response itself and returns true
	HandleAuthorize(ar *osin.AuthorizeRequest, resp *osin.Response, w http.ResponseWriter) (handled bool, err error)
}

AuthorizeHandler populates an AuthorizeRequest or handles the request itself

type AuthorizeHandlerFunc

type AuthorizeHandlerFunc func(ar *osin.AuthorizeRequest, resp *osin.Response, w http.ResponseWriter) (bool, error)

func (AuthorizeHandlerFunc) HandleAuthorize

func (f AuthorizeHandlerFunc) HandleAuthorize(ar *osin.AuthorizeRequest, resp *osin.Response, w http.ResponseWriter) (bool, error)

type AuthorizeHandlers

type AuthorizeHandlers []AuthorizeHandler

func (AuthorizeHandlers) HandleAuthorize

func (all AuthorizeHandlers) HandleAuthorize(ar *osin.AuthorizeRequest, resp *osin.Response, w http.ResponseWriter) (bool, error)

type ErrorHandler

type ErrorHandler interface {
	// HandleError writes an error response
	HandleError(err error, w http.ResponseWriter, req *http.Request)
}

ErrorHandler writes an error response

func NewDefaultErrorHandler

func NewDefaultErrorHandler() ErrorHandler

NewDefaultErrorHandler returns a simple ErrorHandler

type Logger

type Logger struct{}

Logger captures additional osin server errors

func (Logger) Printf

func (l Logger) Printf(format string, v ...interface{})

type Server

type Server struct {
	// contains filtered or unexported fields
}

func New

func New(config *osin.ServerConfig, storage osin.Storage, authorize AuthorizeHandler, access AccessHandler, errorHandler ErrorHandler) *Server

func (*Server) Install

func (s *Server) Install(mux oauthserver.Mux, paths ...string)

Install registers the Server OAuth handlers into a mux. It is expected that the provided prefix will serve all operations

type TokenGen

type TokenGen struct{}

func (TokenGen) GenerateAccessToken

func (TokenGen) GenerateAccessToken(data *osin.AccessData, generaterefresh bool) (string, string, error)

func (TokenGen) GenerateAuthorizeToken

func (TokenGen) GenerateAuthorizeToken(data *osin.AuthorizeData) (ret string, err error)