Documentation
¶
Index ¶
Constants ¶
const (
ContextLoginName = "login-name"
)
Variables ¶
This section is empty.
Functions ¶
func WrapHandler ¶ added in v0.0.15
func WrapHandler(handler HandlerFunc) gin.HandlerFunc
Types ¶
type AuthMiddlewareHeaderRequest ¶ added in v0.0.13
type AuthMiddlewareHeaderRequest struct {
JWTToken string `header:"Authorization"`
}
type AuthMiddlewareURIRequest ¶ added in v0.0.13
type AuthMiddlewareURIRequest struct {
LoginName string `uri:"login_name" example:"alice"`
}
type Error ¶ added in v0.0.15
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.
type HandlerFunc ¶ added in v0.0.15
type Server ¶
type Server struct {
Router *gin.Engine
AdminRouter *gin.Engine
Runtime runtime.Provisioner
// Auth shows if the auth is enabled.
Auth bool
UserService user.Service
ImageService image.Service
// contains filtered or unexported fields
}
func (*Server) AuthMiddleware ¶ added in v0.0.4
func (s *Server) AuthMiddleware() gin.HandlerFunc
func (*Server) BindHandlers ¶ added in v0.0.10
func (s *Server) BindHandlers()
func (*Server) NoAuthMiddleware ¶ added in v0.0.10
func (s *Server) NoAuthMiddleware() gin.HandlerFunc
NoAuthMiddleware is a middleware that does not auth the user.
func (Server) OnConfig ¶
@Summary Update the config of containerssh. @Description It is called by the containerssh webhook. It 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 ¶
@Summary authenticate the public key. @Description It is called by the containerssh webhook. It 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]
Source Files