server

Documentation

Index

• func AddRoutes(s *Server, e *echo.Echo)
• func ErrBadRequest(c echo.Context, err error) error
• func ErrConflict(c echo.Context, err error) error
• func ErrEntityTooLarge(c echo.Context, err error) error
• func ErrForbidden(c echo.Context, err error) error
• func ErrNotFound(c echo.Context, err error) error
• func ErrResponse(c echo.Context, status int, msg string) error
• func ErrUnauthorized(c echo.Context, err error) error
• func ErrorHandler(err error, c echo.Context)
• func JSON(c echo.Context, status int, i interface{}) error
• func NewHandler(s *Server) http.Handler
• func SetContextLogger(l ContextLogger)
• type Access
  • func AccessAllow() Access
  • func AccessDeny(msg string) Access
  • func AccessDenyErrored(err error) Access
  • func AccessDenyTooManyRequests(msg string) Access
• type AccessAction
• type AccessContext
• type AccessFn
• type AccessResource
• type AuthResult
  • func CheckAuthorization(ctx context.Context, method string, urs string, auth string, mc MemCache, ...) (*AuthResult, error)
• type ContextLogger
  • func NewContextLogger(lev LogLevel) ContextLogger
• type Fire
• type LogLevel
• type Logger
  • func NewLogger(lev LogLevel) Logger
• type MemCache
  • func NewMemTestCache(nowFn func() time.Time) MemCache
• type Server
  • func NewServer(fi Fire, mc MemCache) *Server
  • func (s *Server) SetAccessFn(fn AccessFn)
  • func (s *Server) SetInternalAuth(internalAuth string)
  • func (s *Server) SetNowFn(nowFn func() time.Time)
  • func (s *Server) SetRequestor(req keyup.Requestor)
  • func (s *Server) SetTasks(tasks Tasks)
• type Tasks
  • func NewTestTasks(svr *Server) Tasks

Functions

func AddRoutes

func AddRoutes(s *Server, e *echo.Echo)

AddRoutes adds routes to an Echo instance.

func ErrBadRequest

func ErrBadRequest(c echo.Context, err error) error

ErrBadRequest response.

func ErrConflict

func ErrConflict(c echo.Context, err error) error

ErrConflict response.

func ErrEntityTooLarge

func ErrEntityTooLarge(c echo.Context, err error) error

ErrEntityTooLarge response.

func ErrForbidden

func ErrForbidden(c echo.Context, err error) error

ErrForbidden response.

func ErrNotFound

func ErrNotFound(c echo.Context, err error) error

ErrNotFound response.

func ErrResponse

func ErrResponse(c echo.Context, status int, msg string) error

ErrResponse is a generate error response.

func ErrUnauthorized

func ErrUnauthorized(c echo.Context, err error) error

ErrUnauthorized response.

func ErrorHandler

func ErrorHandler(err error, c echo.Context)

ErrorHandler returns error handler that returns in the format: {"error": {"message": "error message", status: 500}}".

func JSON

func JSON(c echo.Context, status int, i interface{}) error

JSON response.

func NewHandler

func NewHandler(s *Server) http.Handler

NewHandler returns http.Handler for Server.

func SetContextLogger

func SetContextLogger(l ContextLogger)

SetContextLogger sets logger for the package.

Types

type Access

type Access struct {
	Allow   bool
	Message string
	// StatusCode (optional) for custom HTTP status (if denied)
	StatusCode int
}

Access returns whether to allow or deny.

func AccessAllow

func AccessAllow() Access

AccessAllow allow access.

func AccessDeny

func AccessDeny(msg string) Access

AccessDeny deny access (bad request).

func AccessDenyErrored

func AccessDenyErrored(err error) Access

AccessDenyErrored deny access (an error occurred trying to determine access).

func AccessDenyTooManyRequests

func AccessDenyTooManyRequests(msg string) Access

AccessDenyTooManyRequests deny access (too many requests).

type AccessAction

type AccessAction string

AccessAction is action for access control.

const (
	// Put action.
	Put AccessAction = "put"
	// Post action.
	Post AccessAction = "post"
)

type AccessContext

type AccessContext interface {
	RealIP() string
	Request() *http.Request
}

AccessContext is context for request.

type AccessFn

type AccessFn func(c AccessContext, resource AccessResource, action AccessAction) Access

AccessFn returns access to resource. If error message begins with an integer, it will use that as the http status code. For example, "429: too many requests".

type AccessResource

type AccessResource string

AccessResource is resource for access control.

const (
	// UserPublicKeyResource for a user public key.
	UserPublicKeyResource AccessResource = "user-public-key"
	// SigchainResource for sigchain.
	SigchainResource AccessResource = "sigchain"
)

type AuthResult

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

AuthResult is the authorized result.

func CheckAuthorization

func CheckAuthorization(ctx context.Context, method string, urs string, auth string, mc MemCache, now time.Time) (*AuthResult, error)

CheckAuthorization returns error if authorization fails. The auth is of the form: <PKID>:<SIG> The <SIG> is the detached signature of <METHOD>,<URL>.

type ContextLogger

type ContextLogger interface {
	Debugf(ctx context.Context, format string, args ...interface{})
	Infof(ctx context.Context, format string, args ...interface{})
	Warningf(ctx context.Context, format string, args ...interface{})
	Errorf(ctx context.Context, format string, args ...interface{})
}

ContextLogger interface used in this package with request context.

func NewContextLogger

func NewContextLogger(lev LogLevel) ContextLogger

NewContextLogger ...

type Fire

type Fire interface {
	keyup.DocumentStore
	keyup.Changes
}

Fire defines interface for remote store (like Firestore).

type LogLevel

type LogLevel int

LogLevel ...

const (
	// DebugLevel ...
	DebugLevel LogLevel = 3
	// InfoLevel ...
	InfoLevel LogLevel = 2
	// WarnLevel ...
	WarnLevel LogLevel = 1
	// ErrLevel ...
	ErrLevel LogLevel = 0
)

type Logger

type Logger interface {
	Debugf(format string, args ...interface{})
	Infof(format string, args ...interface{})
	Warningf(format string, args ...interface{})
	Errorf(format string, args ...interface{})
}

Logger interface used in this package.

func NewLogger

func NewLogger(lev LogLevel) Logger

NewLogger ...

type MemCache

type MemCache interface {
	// Get returns value at key.
	Get(ctx context.Context, k string) (string, error)
	// Put puts a value at key.
	Set(ctx context.Context, k string, v string) error
	// Expire key.
	Expire(ctx context.Context, k string, dt time.Duration) error
}

MemCache defines interface for memcache. Used to prevent nonce re-use for authenticated requests.

func NewMemTestCache

func NewMemTestCache(nowFn func() time.Time) MemCache

NewMemTestCache returns in memory MemCache (for testing).

type Server

type Server struct {

	// URL (base) of form http://host:port with no trailing slash to help
	// authorization checks in testing where the host is ambiguous.
	URL string
	// contains filtered or unexported fields
}

Server ...

func NewServer

func NewServer(fi Fire, mc MemCache) *Server

NewServer creates a Server.

func (*Server) SetAccessFn

func (s *Server) SetAccessFn(fn AccessFn)

SetAccessFn sets access control.

func (*Server) SetInternalAuth

func (s *Server) SetInternalAuth(internalAuth string)

SetInternalAuth for authorizing internal requests, like tasks.

func (*Server) SetNowFn

func (s *Server) SetNowFn(nowFn func() time.Time)

SetNowFn sets clock Now function.

func (*Server) SetRequestor

func (s *Server) SetRequestor(req keyup.Requestor)

SetRequestor ...

func (*Server) SetTasks

func (s *Server) SetTasks(tasks Tasks)

SetTasks ...

type Tasks

type Tasks interface {
	// CreateTask ...
	CreateTask(ctx context.Context, method string, url string, authToken string) error
}

Tasks ..

func NewTestTasks

func NewTestTasks(svr *Server) Tasks

NewTestTasks returns Tasks for use in tests.