package httpapi import ( "bytes" "context" "database/sql" "encoding/json" "errors" "flag" "fmt" "net/http" "reflect" "strings" "time" "github.com/go-playground/validator/v10" "golang.org/x/xerrors" "github.com/coder/coder/v2/coderd/httpapi/httpapiconstraints" "github.com/coder/coder/v2/coderd/tracing" "github.com/coder/coder/v2/codersdk" ) var Validate *validator.Validate // This init is used to create a validator and register validation-specific // functionality for the HTTP API. // // A single validator instance is used, because it caches struct parsing. func init() { Validate = validator.New() Validate.RegisterTagNameFunc(func(fld reflect.StructField) string { name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0] if name == "-" { return "" } return name }) nameValidator := func(fl validator.FieldLevel) bool { f := fl.Field().Interface() str, ok := f.(string) if !ok { return false } valid := NameValid(str) return valid == nil } for _, tag := range []string{"username", "template_name", "workspace_name", "oauth2_app_name"} { err := Validate.RegisterValidation(tag, nameValidator) if err != nil { panic(err) } } templateDisplayNameValidator := func(fl validator.FieldLevel) bool { f := fl.Field().Interface() str, ok := f.(string) if !ok { return false } valid := TemplateDisplayNameValid(str) return valid == nil } err := Validate.RegisterValidation("template_display_name", templateDisplayNameValidator) if err != nil { panic(err) } templateVersionNameValidator := func(fl validator.FieldLevel) bool { f := fl.Field().Interface() str, ok := f.(string) if !ok { return false } valid := TemplateVersionNameValid(str) return valid == nil } err = Validate.RegisterValidation("template_version_name", templateVersionNameValidator) if err != nil { panic(err) } userRealNameValidator := func(fl validator.FieldLevel) bool { f := fl.Field().Interface() str, ok := f.(string) if !ok { return false } valid := UserRealNameValid(str) return valid == nil } err = Validate.RegisterValidation("user_real_name", userRealNameValidator) if err != nil { panic(err) } } // Is404Error returns true if the given error should return a 404 status code. // Both actual 404s and unauthorized errors should return 404s to not leak // information about the existence of resources. func Is404Error(err error) bool { if err == nil { return false } // This tests for dbauthz.IsNotAuthorizedError and rbac.IsUnauthorizedError. var unauthorized httpapiconstraints.IsUnauthorizedError if errors.As(err, &unauthorized) && unauthorized.IsUnauthorized() { return true } return xerrors.Is(err, sql.ErrNoRows) } // Convenience error functions don't take contexts since their responses are // static, it doesn't make much sense to trace them. var ResourceNotFoundResponse = codersdk.Response{Message: "Resource not found or you do not have access to this resource"} // ResourceNotFound is intentionally vague. All 404 responses should be identical // to prevent leaking existence of resources. func ResourceNotFound(rw http.ResponseWriter) { Write(context.Background(), rw, http.StatusNotFound, ResourceNotFoundResponse) } func Forbidden(rw http.ResponseWriter) { Write(context.Background(), rw, http.StatusForbidden, codersdk.Response{ Message: "Forbidden.", }) } func InternalServerError(rw http.ResponseWriter, err error) { var details string if err != nil { details = err.Error() } Write(context.Background(), rw, http.StatusInternalServerError, codersdk.Response{ Message: "An internal server error occurred.", Detail: details, }) } func RouteNotFound(rw http.ResponseWriter) { Write(context.Background(), rw, http.StatusNotFound, codersdk.Response{ Message: "Route not found.", }) } // Write outputs a standardized format to an HTTP response body. ctx is used for // tracing and can be nil for tracing to be disabled. Tracing this function is // helpful because JSON marshaling can sometimes take a non-insignificant amount // of time, and could help us catch outliers. Additionally, we can enrich span // data a bit more since we have access to the actual interface{} we're // marshaling, such as the number of elements in an array, which could help us // spot routes that need to be paginated. func Write(ctx context.Context, rw http.ResponseWriter, status int, response interface{}) { // Pretty up JSON when testing. if flag.Lookup("test.v") != nil { WriteIndent(ctx, rw, status, response) return } _, span := tracing.StartSpan(ctx) defer span.End() rw.Header().Set("Content-Type", "application/json; charset=utf-8") rw.WriteHeader(status) enc := json.NewEncoder(rw) enc.SetEscapeHTML(true) // We can't really do much about these errors, it's probably due to a // dropped connection. _ = enc.Encode(response) } func WriteIndent(ctx context.Context, rw http.ResponseWriter, status int, response interface{}) { _, span := tracing.StartSpan(ctx) defer span.End() rw.Header().Set("Content-Type", "application/json; charset=utf-8") rw.WriteHeader(status) enc := json.NewEncoder(rw) enc.SetEscapeHTML(true) enc.SetIndent("", "\t") // We can't really do much about these errors, it's probably due to a // dropped connection. _ = enc.Encode(response) } // Read decodes JSON from the HTTP request into the value provided. It uses // go-validator to validate the incoming request body. ctx is used for tracing // and can be nil. Although tracing this function isn't likely too helpful, it // was done to be consistent with Write. func Read(ctx context.Context, rw http.ResponseWriter, r *http.Request, value interface{}) bool { ctx, span := tracing.StartSpan(ctx) defer span.End() err := json.NewDecoder(r.Body).Decode(value) if err != nil { Write(ctx, rw, http.StatusBadRequest, codersdk.Response{ Message: "Request body must be valid JSON.", Detail: err.Error(), }) return false } err = Validate.Struct(value) var validationErrors validator.ValidationErrors if errors.As(err, &validationErrors) { apiErrors := make([]codersdk.ValidationError, 0, len(validationErrors)) for _, validationError := range validationErrors { apiErrors = append(apiErrors, codersdk.ValidationError{ Field: validationError.Field(), Detail: fmt.Sprintf("Validation failed for tag %q with value: \"%v\"", validationError.Tag(), validationError.Value()), }) } Write(ctx, rw, http.StatusBadRequest, codersdk.Response{ Message: "Validation failed.", Validations: apiErrors, }) return false } if err != nil { Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{ Message: "Internal error validating request body payload.", Detail: err.Error(), }) return false } return true } const websocketCloseMaxLen = 123 // WebsocketCloseSprintf formats a websocket close message and ensures it is // truncated to the maximum allowed length. func WebsocketCloseSprintf(format string, vars ...any) string { msg := fmt.Sprintf(format, vars...) // Cap msg length at 123 bytes. nhooyr/websocket only allows close messages // of this length. if len(msg) > websocketCloseMaxLen { // Trim the string to 123 bytes. If we accidentally cut in the middle of // a UTF-8 character, remove it from the string. return strings.ToValidUTF8(msg[:websocketCloseMaxLen], "") } return msg } func ServerSentEventSender(rw http.ResponseWriter, r *http.Request) (sendEvent func(ctx context.Context, sse codersdk.ServerSentEvent) error, closed chan struct{}, err error) { h := rw.Header() h.Set("Content-Type", "text/event-stream") h.Set("Cache-Control", "no-cache") h.Set("Connection", "keep-alive") h.Set("X-Accel-Buffering", "no") f, ok := rw.(http.Flusher) if !ok { panic("http.ResponseWriter is not http.Flusher") } closed = make(chan struct{}) type sseEvent struct { payload []byte errC chan error } eventC := make(chan sseEvent) // Synchronized handling of events (no guarantee of order). go func() { defer close(closed) // Send a heartbeat every 15 seconds to avoid the connection being killed. ticker := time.NewTicker(time.Second * 15) defer ticker.Stop() for { var event sseEvent select { case <-r.Context().Done(): return case event = <-eventC: case <-ticker.C: event = sseEvent{ payload: []byte(fmt.Sprintf("event: %s\n\n", codersdk.ServerSentEventTypePing)), } } _, err := rw.Write(event.payload) if event.errC != nil { event.errC <- err } if err != nil { return } f.Flush() } }() sendEvent = func(ctx context.Context, sse codersdk.ServerSentEvent) error { buf := &bytes.Buffer{} enc := json.NewEncoder(buf) _, err := buf.WriteString(fmt.Sprintf("event: %s\n", sse.Type)) if err != nil { return err } if sse.Data != nil { _, err = buf.WriteString("data: ") if err != nil { return err } err = enc.Encode(sse.Data) if err != nil { return err } } err = buf.WriteByte('\n') if err != nil { return err } event := sseEvent{ payload: buf.Bytes(), errC: make(chan error, 1), // Buffered to prevent deadlock. } select { case <-r.Context().Done(): return r.Context().Err() case <-ctx.Done(): return ctx.Err() case <-closed: return xerrors.New("server sent event sender closed") case eventC <- event: // Re-check closure signals after sending the event to allow // for early exit. We don't check closed here because it // can't happen while processing the event. select { case <-r.Context().Done(): return r.Context().Err() case <-ctx.Done(): return ctx.Err() case err := <-event.errC: return err } } } return sendEvent, closed, nil }