// Copyright 2022 Cloudbase Solutions SRL // // Licensed under the Apache License, Version 2.0 (the "License"); you may // not use this file except in compliance with the License. You may obtain // a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, WITHOUT // WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the // License for the specific language governing permissions and limitations // under the License. package controllers import ( "encoding/json" "io" "log" "net/http" "strings" gErrors "github.com/cloudbase/garm-provider-common/errors" "github.com/cloudbase/garm-provider-common/util" "github.com/cloudbase/garm/apiserver/params" "github.com/cloudbase/garm/auth" "github.com/cloudbase/garm/metrics" runnerParams "github.com/cloudbase/garm/params" "github.com/cloudbase/garm/runner" wsWriter "github.com/cloudbase/garm/websocket" "github.com/gorilla/websocket" "github.com/pkg/errors" ) func NewAPIController(r *runner.Runner, authenticator *auth.Authenticator, hub *wsWriter.Hub) (*APIController, error) { return &APIController{ r: r, auth: authenticator, hub: hub, upgrader: websocket.Upgrader{ ReadBufferSize: 1024, WriteBufferSize: 16384, }, }, nil } type APIController struct { r *runner.Runner auth *auth.Authenticator hub *wsWriter.Hub upgrader websocket.Upgrader } func handleError(w http.ResponseWriter, err error) { w.Header().Add("Content-Type", "application/json") origErr := errors.Cause(err) apiErr := params.APIErrorResponse{ Details: origErr.Error(), } switch origErr.(type) { case *gErrors.NotFoundError: w.WriteHeader(http.StatusNotFound) apiErr.Error = "Not Found" case *gErrors.UnauthorizedError: w.WriteHeader(http.StatusUnauthorized) apiErr.Error = "Not Authorized" // Don't include details on 401 errors. apiErr.Details = "" case *gErrors.BadRequestError: w.WriteHeader(http.StatusBadRequest) apiErr.Error = "Bad Request" case *gErrors.DuplicateUserError, *gErrors.ConflictError: w.WriteHeader(http.StatusConflict) apiErr.Error = "Conflict" default: w.WriteHeader(http.StatusInternalServerError) apiErr.Error = "Server error" // Don't include details on server error. apiErr.Details = "" } if err := json.NewEncoder(w).Encode(apiErr); err != nil { log.Printf("failed to encode response: %q", err) } } func (a *APIController) webhookMetricLabelValues(valid, reason string) []string { controllerInfo, err := a.r.GetControllerInfo(auth.GetAdminContext()) if err != nil { log.Printf("failed to get controller info: %s", err) // If labels are empty, not attempt will be made to record webhook. return []string{} } return []string{ valid, reason, controllerInfo.Hostname, controllerInfo.ControllerID.String(), } } func (a *APIController) handleWorkflowJobEvent(w http.ResponseWriter, r *http.Request) { defer r.Body.Close() body, err := io.ReadAll(r.Body) if err != nil { handleError(w, gErrors.NewBadRequestError("invalid post body: %s", err)) return } signature := r.Header.Get("X-Hub-Signature-256") hookType := r.Header.Get("X-Github-Hook-Installation-Target-Type") var labelValues []string defer func() { if len(labelValues) == 0 { return } if err := metrics.RecordWebhookWithLabels(labelValues...); err != nil { log.Printf("failed to record metric: %s", err) } }() if err := a.r.DispatchWorkflowJob(hookType, signature, body); err != nil { if errors.Is(err, gErrors.ErrNotFound) { labelValues = a.webhookMetricLabelValues("false", "owner_unknown") log.Printf("got not found error from DispatchWorkflowJob. webhook not meant for us?: %q", err) return } else if strings.Contains(err.Error(), "signature") { // TODO: check error type labelValues = a.webhookMetricLabelValues("false", "signature_invalid") } else { labelValues = a.webhookMetricLabelValues("false", "unknown") } handleError(w, err) return } labelValues = a.webhookMetricLabelValues("true", "") } func (a *APIController) CatchAll(w http.ResponseWriter, r *http.Request) { headers := r.Header.Clone() event := runnerParams.Event(headers.Get("X-Github-Event")) switch event { case runnerParams.WorkflowJobEvent: a.handleWorkflowJobEvent(w, r) default: log.Printf("ignoring unknown event %s", util.SanitizeLogEntry(string(event))) return } } func (a *APIController) WSHandler(writer http.ResponseWriter, req *http.Request) { ctx := req.Context() if !auth.IsAdmin(ctx) { writer.WriteHeader(http.StatusForbidden) if _, err := writer.Write([]byte("you need admin level access to view logs")); err != nil { log.Printf("failed to encode response: %q", err) } return } if a.hub == nil { handleError(writer, gErrors.NewBadRequestError("log streamer is disabled")) return } conn, err := a.upgrader.Upgrade(writer, req, nil) if err != nil { log.Printf("error upgrading to websockets: %v", err) return } // TODO (gsamfira): Handle ExpiresAt. Right now, if a client uses // a valid token to authenticate, and keeps the websocket connection // open, it will allow that client to stream logs via websockets // until the connection is broken. We need to forcefully disconnect // the client once the token expires. client, err := wsWriter.NewClient(conn, a.hub) if err != nil { log.Printf("failed to create new client: %v", err) return } if err := a.hub.Register(client); err != nil { log.Printf("failed to register new client: %v", err) return } client.Go() } // NotFoundHandler is returned when an invalid URL is acccessed func (a *APIController) NotFoundHandler(w http.ResponseWriter, r *http.Request) { apiErr := params.APIErrorResponse{ Details: "Resource not found", Error: "Not found", } w.WriteHeader(http.StatusNotFound) w.Header().Set("Content-Type", "application/json") if err := json.NewEncoder(w).Encode(apiErr); err != nil { log.Printf("failet to write response: %q", err) } } // swagger:route GET /metrics-token metrics-token GetMetricsToken // // Returns a JWT token that can be used to access the metrics endpoint. // // Responses: // 200: JWTResponse // 401: APIErrorResponse func (a *APIController) MetricsTokenHandler(w http.ResponseWriter, r *http.Request) { ctx := r.Context() if !auth.IsAdmin(ctx) { handleError(w, gErrors.ErrUnauthorized) return } token, err := a.auth.GetJWTMetricsToken(ctx) if err != nil { handleError(w, err) return } w.Header().Set("Content-Type", "application/json") err = json.NewEncoder(w).Encode(runnerParams.JWTResponse{Token: token}) if err != nil { log.Printf("failed to encode response: %q", err) } } // swagger:route POST /auth/login login Login // // Logs in a user and returns a JWT token. // // Parameters: // + name: Body // description: Login information. // type: PasswordLoginParams // in: body // required: true // // Responses: // 200: JWTResponse // 400: APIErrorResponse // // LoginHandler returns a jwt token func (a *APIController) LoginHandler(w http.ResponseWriter, r *http.Request) { var loginInfo runnerParams.PasswordLoginParams if err := json.NewDecoder(r.Body).Decode(&loginInfo); err != nil { handleError(w, gErrors.ErrBadRequest) return } if err := loginInfo.Validate(); err != nil { handleError(w, err) return } ctx := r.Context() ctx, err := a.auth.AuthenticateUser(ctx, loginInfo) if err != nil { handleError(w, err) return } tokenString, err := a.auth.GetJWTToken(ctx) if err != nil { handleError(w, err) return } w.Header().Set("Content-Type", "application/json") if err := json.NewEncoder(w).Encode(runnerParams.JWTResponse{Token: tokenString}); err != nil { log.Printf("failed to encode response: %q", err) } } // swagger:route POST /first-run first-run FirstRun // // Initialize the first run of the controller. // // Parameters: // + name: Body // description: Create a new user. // type: NewUserParams // in: body // required: true // // Responses: // 200: User // 400: APIErrorResponse func (a *APIController) FirstRunHandler(w http.ResponseWriter, r *http.Request) { if a.auth.IsInitialized() { err := gErrors.NewConflictError("already initialized") handleError(w, err) return } ctx := r.Context() var newUserParams runnerParams.NewUserParams if err := json.NewDecoder(r.Body).Decode(&newUserParams); err != nil { handleError(w, gErrors.ErrBadRequest) return } newUser, err := a.auth.InitController(ctx, newUserParams) if err != nil { handleError(w, err) return } w.Header().Set("Content-Type", "application/json") if err := json.NewEncoder(w).Encode(newUser); err != nil { log.Printf("failed to encode response: %q", err) } } // swagger:route GET /credentials credentials ListCredentials // // List all credentials. // // Responses: // 200: Credentials // 400: APIErrorResponse func (a *APIController) ListCredentials(w http.ResponseWriter, r *http.Request) { ctx := r.Context() creds, err := a.r.ListCredentials(ctx) if err != nil { handleError(w, err) return } w.Header().Set("Content-Type", "application/json") if err := json.NewEncoder(w).Encode(creds); err != nil { log.Printf("failed to encode response: %q", err) } } // swagger:route GET /providers providers ListProviders // // List all providers. // // Responses: // 200: Providers // 400: APIErrorResponse func (a *APIController) ListProviders(w http.ResponseWriter, r *http.Request) { ctx := r.Context() providers, err := a.r.ListProviders(ctx) if err != nil { handleError(w, err) return } w.Header().Set("Content-Type", "application/json") if err := json.NewEncoder(w).Encode(providers); err != nil { log.Printf("failed to encode response: %q", err) } } // swagger:route GET /jobs jobs ListJobs // // List all jobs. // // Responses: // 200: Jobs // 400: APIErrorResponse func (a *APIController) ListAllJobs(w http.ResponseWriter, r *http.Request) { ctx := r.Context() jobs, err := a.r.ListAllJobs(ctx) if err != nil { handleError(w, err) return } w.Header().Set("Content-Type", "application/json") if err := json.NewEncoder(w).Encode(jobs); err != nil { log.Printf("failed to encode response: %q", err) } } // swagger:route GET /controller-info controllerInfo ControllerInfo // // Get controller info. // // Responses: // 200: ControllerInfo // 409: APIErrorResponse func (a *APIController) ControllerInfoHandler(w http.ResponseWriter, r *http.Request) { ctx := r.Context() info, err := a.r.GetControllerInfo(ctx) if err != nil { handleError(w, err) return } w.Header().Set("Content-Type", "application/json") if err := json.NewEncoder(w).Encode(info); err != nil { log.Printf("failed to encode response: %q", err) } }