api

Documentation

Index

• Variables
• func Logger(logger *logrus.Logger) func(next http.Handler) http.Handler
• func Router(logger *logrus.Logger) *chi.Mux
• func Serve(startconfig Config)
• type Config
• type Login
  • func (l *Login) Validate() error
• type StatusRecorder
  • func (r *StatusRecorder) WriteHeader(status int)

Variables

var RequestLoggerKey = contextKey("logger")

RequestLoggerKey is the key that holds the logger instance in a request context

Functions

func Logger

func Logger(logger *logrus.Logger) func(next http.Handler) http.Handler

Logger is a middleware for http logging of server/api requests

func Router

func Router(logger *logrus.Logger) *chi.Mux

Router returns *chi.Mux config

func Serve

func Serve(startconfig Config)

Serve the API webserver and register all handlers

Types

type Config

type Config struct {
	Addr       string
	TLSDisable bool
	TLSCert    string
	TLSKey     string

	Logger *logrus.Logger

	Auth   authenticator.Authenticator
	Princs principals.Principals
	Signer signer.Signer
}

Config represents the config of the API webserver.

type Login

type Login struct {
	User     string `json:"user" binding:"required"`
	Password string `json:"password" binding:"required"`
	PubKey   string `json:"public_key" binding:"required"`
}

Login represents credentials expected by SMK server

func (*Login) Validate

func (l *Login) Validate() error

Validate fields of login struct

type StatusRecorder

type StatusRecorder struct {
	http.ResponseWriter
	Status int
}

StatusRecorder is an object allowing http response status code to be logger

func (*StatusRecorder) WriteHeader

func (r *StatusRecorder) WriteHeader(status int)

WriteHeader set StatusRecorder Status field with http response status code