server

Documentation

Index

• Constants
• func NewError(code int, err error, op string) error
• func PrettyStruct(data interface{}) (string, error)
• func WrapHandler(handler HandlerFunc) gin.HandlerFunc
• type AuthMiddlewareHeaderRequest
• type AuthMiddlewareURIRequest
• type Error
  • func (e *Error) Error() string
• type HandlerFunc
• type Opt
• type Server
  • func New(opt Opt) (*Server, error)
  • func (s *Server) AuthMiddleware() gin.HandlerFunc
  • func (s *Server) BindHandlers()
  • func (s *Server) NoAuthMiddleware() gin.HandlerFunc
  • func (s Server) OnConfig(c *gin.Context) error
  • func (s Server) OnPubKey(c *gin.Context) error
  • func (s *Server) Run() error

Constants

const (
	ContextLoginName = "login-name"
)

Functions

func NewError

func NewError(code int, err error, op string) error

func PrettyStruct

func PrettyStruct(data interface{}) (string, error)

func WrapHandler

func WrapHandler(handler HandlerFunc) gin.HandlerFunc

Types

type AuthMiddlewareHeaderRequest

type AuthMiddlewareHeaderRequest struct {
	JWTToken string `header:"Authorization"`
}

type AuthMiddlewareURIRequest

type AuthMiddlewareURIRequest struct {
	LoginName string `uri:"login_name" example:"alice"`
}

type Error

type Error struct {
	// Machine-readable error code.
	HTTPStatusCode int `json:"http_status_code,omitempty"`

	// Human-readable message.
	Message string `json:"message,omitempty"`
	Request string `json:"request,omitempty"`

	// Logical operation and nested error.
	Op  string `json:"op,omitempty"`
	Err error  `json:"error,omitempty"`
}

Error defines a standard application error.

func (*Error) Error

func (e *Error) Error() string

Error returns the string representation of the error message.

type HandlerFunc

type HandlerFunc func(c *gin.Context) error

type Opt

type Opt struct {
	Debug       bool
	KubeConfig  string
	HostKeyPath string
	DBURL       string

	NoAuth               bool
	JWTSecret            string
	JWTExpirationTimeout time.Duration
}

type Server

type Server struct {
	Router      *gin.Engine
	AdminRouter *gin.Engine
	Queries     *query.Queries
	Runtime     runtime.Provisioner

	// Auth shows if the auth is enabled.
	Auth bool

	UserService user.Service
	// contains filtered or unexported fields
}

func New

func New(opt Opt) (*Server, error)

func (*Server) AuthMiddleware

func (s *Server) AuthMiddleware() gin.HandlerFunc

func (*Server) BindHandlers

func (s *Server) BindHandlers()

func (*Server) NoAuthMiddleware

func (s *Server) NoAuthMiddleware() gin.HandlerFunc

NoAuthMiddleware is a middleware that does not auth the user.

func (Server) OnConfig

func (s Server) OnConfig(c *gin.Context) error

@Summary Update the config of containerssh. @Description It is called by the containerssh webhook. and is not expected to be used externally. @Tags ssh-internal @Accept json @Produce json @Param request body config.Request true "query params" @Success 200 @Router /config [post]

func (Server) OnPubKey

func (s Server) OnPubKey(c *gin.Context) error

@Summary authenticate the public key. @Description It is called by the containerssh webhook. and is not expected to be used externally. @Tags ssh-internal @Accept json @Produce json @Param request body auth.PublicKeyAuthRequest true "query params" @Success 200 {object} auth.ResponseBody @Router /pubkey [post]

func (*Server) Run

func (s *Server) Run() error