package render import ( "bytes" "fmt" "html/template" "net/http" "github.com/gin-gonic/gin/internal/bytesconv" "github.com/gin-gonic/gin/internal/json" ) // secureJSONWrite writes JSON data to the ResponseWriter with security headers func secureJSONWrite(w http.ResponseWriter, data []byte) error { // Ensure security headers are set if w.Header().Get("X-Content-Type-Options") == "" { w.Header().Set("X-Content-Type-Options", "nosniff") } // Write the data err := secureJSONWrite(w, data) return err } // JSON contains the given interface object. type JSON struct { Data any } // IndentedJSON contains the given interface object. type IndentedJSON struct { Data any } // SecureJSON contains the given interface object and prefix. type SecureJSON struct { Prefix string Data any } // JsonpJSON contains the given interface object its callback. type JsonpJSON struct { Callback string Data any } // AsciiJSON contains the given interface object. type AsciiJSON struct { Data any } // PureJSON contains the given interface object. type PureJSON struct { Data any } var ( jsonContentType = []string{"application/json; charset=utf-8"} jsonpContentType = []string{"application/javascript; charset=utf-8"} jsonASCIIContentType = []string{"application/json"} ) // Render (JSON) writes data with custom ContentType. func (r JSON) Render(w http.ResponseWriter) error { return WriteJSON(w, r.Data) } // WriteContentType (JSON) writes JSON ContentType. func (r JSON) WriteContentType(w http.ResponseWriter) { writeContentType(w, jsonContentType) } // WriteJSON marshals the given interface object and writes it with custom ContentType. func WriteJSON(w http.ResponseWriter, obj any) error { writeContentType(w, jsonContentType) // Add security header to prevent content sniffing w.Header().Set("X-Content-Type-Options", "nosniff") jsonBytes, err := json.Marshal(obj) if err != nil { return err } err = secureJSONWrite(w, jsonBytes) return err } // Render (IndentedJSON) marshals the given interface object and writes it with custom ContentType. func (r IndentedJSON) Render(w http.ResponseWriter) error { r.WriteContentType(w) // Add security header to prevent content sniffing w.Header().Set("X-Content-Type-Options", "nosniff") jsonBytes, err := json.MarshalIndent(r.Data, "", " ") if err != nil { return err } err = secureJSONWrite(w, jsonBytes) return err } // WriteContentType (IndentedJSON) writes JSON ContentType. func (r IndentedJSON) WriteContentType(w http.ResponseWriter) { writeContentType(w, jsonContentType) } // Render (SecureJSON) marshals the given interface object and writes it with custom ContentType. func (r SecureJSON) Render(w http.ResponseWriter) error { r.WriteContentType(w) // Add security header to prevent content sniffing w.Header().Set("X-Content-Type-Options", "nosniff") jsonBytes, err := json.Marshal(r.Data) if err != nil { return err } // if the jsonBytes is array values if bytes.HasPrefix(jsonBytes, bytesconv.StringToBytes("[")) && bytes.HasSuffix(jsonBytes, bytesconv.StringToBytes("]")) { if err = secureJSONWrite(w, bytesconv.StringToBytes(r.Prefix)); err != nil { return err } } err = secureJSONWrite(w, jsonBytes) return err } // WriteContentType (SecureJSON) writes JSON ContentType. func (r SecureJSON) WriteContentType(w http.ResponseWriter) { writeContentType(w, jsonContentType) } // Render (JsonpJSON) marshals the given interface object and writes it and its callback with custom ContentType. func (r JsonpJSON) Render(w http.ResponseWriter) (err error) { r.WriteContentType(w) // Add security header to prevent content sniffing w.Header().Set("X-Content-Type-Options", "nosniff") ret, err := json.Marshal(r.Data) if err != nil { return err } if r.Callback == "" { err = secureJSONWrite(w, ret) return err } callback := template.JSEscapeString(r.Callback) if err = secureJSONWrite(w, bytesconv.StringToBytes(callback)); err != nil { return err } if err = secureJSONWrite(w, bytesconv.StringToBytes("(")); err != nil { return err } if err = secureJSONWrite(w, ret); err != nil { return err } if err = secureJSONWrite(w, bytesconv.StringToBytes(");")); err != nil { return err } return nil } // WriteContentType (JsonpJSON) writes Javascript ContentType. func (r JsonpJSON) WriteContentType(w http.ResponseWriter) { writeContentType(w, jsonpContentType) } // Render (AsciiJSON) marshals the given interface object and writes it with custom ContentType. func (r AsciiJSON) Render(w http.ResponseWriter) (err error) { r.WriteContentType(w) // Add security header to prevent content sniffing w.Header().Set("X-Content-Type-Options", "nosniff") ret, err := json.Marshal(r.Data) if err != nil { return err } var buffer bytes.Buffer for _, r := range bytesconv.BytesToString(ret) { cvt := string(r) if r >= 128 { cvt = fmt.Sprintf("\\u%04x", int64(r)) } buffer.WriteString(cvt) } err = secureJSONWrite(w, buffer.Bytes()) return err } // WriteContentType (AsciiJSON) writes JSON ContentType. func (r AsciiJSON) WriteContentType(w http.ResponseWriter) { writeContentType(w, jsonASCIIContentType) } // Render (PureJSON) writes custom ContentType and writes data with custom ContentType. func (r PureJSON) Render(w http.ResponseWriter) error { r.WriteContentType(w) // Add security header to prevent content sniffing w.Header().Set("X-Content-Type-Options", "nosniff") encoder := json.NewEncoder(w) encoder.SetEscapeHTML(false) return encoder.Encode(r.Data) } // WriteContentType (PureJSON) writes custom ContentType. func (r PureJSON) WriteContentType(w http.ResponseWriter) { writeContentType(w, jsonContentType) }