diff --git a/shortcuts/common/helpers.go b/shortcuts/common/helpers.go index 1a15da436..2aff5a4d5 100644 --- a/shortcuts/common/helpers.go +++ b/shortcuts/common/helpers.go @@ -7,10 +7,13 @@ import ( "encoding/json" "io" "mime/multipart" - "net/textproto" ) -// MultipartWriter wraps multipart.Writer for file uploads. +// MultipartWriter wraps multipart.Writer for file uploads. CreateFormFile is +// promoted from the embedded *multipart.Writer, which escapes special +// characters in the field name and filename — a filename like +// `report "draft".pdf` therefore round-trips through the Content-Disposition +// header instead of being truncated at the first unescaped quote. type MultipartWriter struct { *multipart.Writer } @@ -20,14 +23,6 @@ func NewMultipartWriter(w io.Writer) *MultipartWriter { return &MultipartWriter{multipart.NewWriter(w)} } -// CreateFormFile creates a form file with the given field name and file name. -func (mw *MultipartWriter) CreateFormFile(fieldname, filename string) (io.Writer, error) { - h := make(textproto.MIMEHeader) - h.Set("Content-Disposition", `form-data; name="`+fieldname+`"; filename="`+filename+`"`) - h.Set("Content-Type", "application/octet-stream") - return mw.Writer.CreatePart(h) -} - // ParseJSON unmarshals JSON data into v. func ParseJSON(data []byte, v interface{}) error { return json.Unmarshal(data, v) diff --git a/shortcuts/common/helpers_test.go b/shortcuts/common/helpers_test.go new file mode 100644 index 000000000..51f9eff34 --- /dev/null +++ b/shortcuts/common/helpers_test.go @@ -0,0 +1,121 @@ +// Copyright (c) 2026 Lark Technologies Pte. Ltd. +// SPDX-License-Identifier: MIT + +package common + +import ( + "bytes" + "io" + "mime" + "mime/multipart" + "strings" + "testing" +) + +// TestMultipartWriter_CreateFormFile_EscapesFilename verifies that filenames +// containing characters that require escaping in a Content-Disposition header +// are properly encoded on the wire. +// +// Regression test: an earlier custom CreateFormFile concatenated raw strings +// without escaping, so a filename like `report "draft".pdf` produced a +// malformed header that servers parsed as `filename="report "` (truncated at +// the first internal quote). +// +// The stdlib applies two different schemes when serializing a filename: +// - backslash and double-quote use backslash escaping (quoted-pair), which +// mime.ParseMediaType reverses on read, so they round-trip exactly. +// - CR and LF use percent encoding to prevent header injection (a literal +// CRLF would break the header). mime.ParseMediaType does NOT decode +// percent escapes, so on read the filename param contains the literal +// "%0D"/"%0A" — server-side code is expected to URL-decode it. +// +// Filename parameters are read via mime.ParseMediaType on the raw +// Content-Disposition header — Part.FileName runs the result through +// filepath.Base which is platform-dependent for backslash on Windows. +func TestMultipartWriter_CreateFormFile_EscapesFilename(t *testing.T) { + t.Parallel() + + cases := []struct { + name string + filename string + wantEncoded string // expected escaped form embedded in the header + wantParsed string // what mime.ParseMediaType returns; differs from filename only when percent-encoded + }{ + // happy path: no characters need escaping + {"plain ASCII", "report.pdf", "report.pdf", "report.pdf"}, + {"unicode", "报告 v2.pdf", "报告 v2.pdf", "报告 v2.pdf"}, + + // backslash escaping: round-trips exactly through mime.ParseMediaType + {"double quote", `report "draft" v2.pdf`, `report \"draft\" v2.pdf`, `report "draft" v2.pdf`}, + {"backslash", `report\draft.pdf`, `report\\draft.pdf`, `report\draft.pdf`}, + {"backslash and quote", `path\to "weird" file.bin`, `path\\to \"weird\" file.bin`, `path\to "weird" file.bin`}, + + // percent encoding: on-wire %0D/%0A is not decoded by mime.ParseMediaType + {"carriage return", "file\rname.pdf", "file%0Dname.pdf", "file%0Dname.pdf"}, + {"line feed", "file\nname.pdf", "file%0Aname.pdf", "file%0Aname.pdf"}, + {"CRLF", "file\r\nname.pdf", "file%0D%0Aname.pdf", "file%0D%0Aname.pdf"}, + } + + for _, tc := range cases { + t.Run(tc.name, func(t *testing.T) { + var buf bytes.Buffer + mw := NewMultipartWriter(&buf) + w, err := mw.CreateFormFile("file", tc.filename) + if err != nil { + t.Fatalf("CreateFormFile error: %v", err) + } + if _, err := io.WriteString(w, "body-bytes"); err != nil { + t.Fatalf("write body: %v", err) + } + if err := mw.Close(); err != nil { + t.Fatalf("close writer: %v", err) + } + + body := buf.String() + wantHeader := `filename="` + tc.wantEncoded + `"` + if !strings.Contains(body, wantHeader) { + t.Errorf("Content-Disposition does not contain %q\nbody:\n%s", wantHeader, body) + } + + r := multipart.NewReader(strings.NewReader(body), mw.Boundary()) + part, err := r.NextPart() + if err != nil { + t.Fatalf("read part: %v", err) + } + _, params, err := mime.ParseMediaType(part.Header.Get("Content-Disposition")) + if err != nil { + t.Fatalf("ParseMediaType on Content-Disposition: %v", err) + } + if got := params["filename"]; got != tc.wantParsed { + t.Errorf("filename round-trip: got %q, want %q", got, tc.wantParsed) + } + if got := params["name"]; got != "file" { + t.Errorf("name: got %q, want %q", got, "file") + } + }) + } +} + +// TestMultipartWriter_CreateFormFile_ContentType verifies that the file part +// carries the expected Content-Type for binary uploads. +func TestMultipartWriter_CreateFormFile_ContentType(t *testing.T) { + t.Parallel() + + var buf bytes.Buffer + mw := NewMultipartWriter(&buf) + if _, err := mw.CreateFormFile("file", "x.bin"); err != nil { + t.Fatalf("CreateFormFile: %v", err) + } + if err := mw.Close(); err != nil { + t.Fatalf("close: %v", err) + } + + r := multipart.NewReader(&buf, mw.Boundary()) + part, err := r.NextPart() + if err != nil { + t.Fatalf("read part: %v", err) + } + if got := part.Header.Get("Content-Type"); got != "application/octet-stream" { + t.Errorf("Content-Type: got %q, want application/octet-stream", got) + } +}