Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions internal/apiform/encoder.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,27 @@ func (e *encoder) encodeValue(key string, val reflect.Value, writer *multipart.W

t := val.Type()

// Encode nil pointers and nil interfaces as empty fields before any other
// type detection. A typed nil pointer whose type implements io.Reader must
// not be routed into encodeReader, which would invoke Read on a nil
// receiver via io.Copy and panic.
switch t.Kind() {
case reflect.Pointer:
if val.IsNil() {
return writer.WriteField(key, "")
}
case reflect.Interface:
if val.IsNil() {
return writer.WriteField(key, "")
}
}

if t.Implements(reflect.TypeOf((*io.Reader)(nil)).Elem()) {
return e.encodeReader(key, val, writer)
}

switch t.Kind() {
case reflect.Pointer:
if val.IsNil() || !val.IsValid() {
return writer.WriteField(key, "")
}
return e.encodeValue(key, val.Elem(), writer)

case reflect.Slice, reflect.Array:
Expand All @@ -69,9 +81,6 @@ func (e *encoder) encodeValue(key string, val reflect.Value, writer *multipart.W
return e.encodeMap(key, val, writer)

case reflect.Interface:
if val.IsNil() {
return writer.WriteField(key, "")
}
return e.encodeValue(key, val.Elem(), writer)

case reflect.String:
Expand Down
46 changes: 46 additions & 0 deletions internal/apiform/form_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package apiform

import (
"bytes"
"io"
"mime/multipart"
"testing"
)
Expand Down Expand Up @@ -116,3 +117,48 @@ func TestEncode(t *testing.T) {
})
}
}

// panicReader panics if its Read method is invoked. It is used to assert that
// a typed nil pointer implementing io.Reader is never dereferenced during
// multipart encoding.
type panicReader struct{}

func (*panicReader) Read([]byte) (int, error) {
panic("Read called on nil receiver")
}

func TestEncodeTypedNilReader(t *testing.T) {
t.Parallel()

var reader *panicReader

buf := bytes.NewBuffer(nil)
writer := multipart.NewWriter(buf)
writer.SetBoundary("xxx")

// A typed nil pointer that implements io.Reader must follow the same
// empty-field semantics as any other nil value, without invoking Read.
form := map[string]any{"foo": reader}
if err := MarshalWithSettings(form, writer, FormatRepeat); err != nil {
t.Fatalf("serialization of typed nil reader failed with error %v", err)
}
if err := writer.Close(); err != nil {
t.Fatalf("closing writer failed with error %v", err)
}

parts := multipart.NewReader(bytes.NewReader(buf.Bytes()), writer.Boundary())
part, err := parts.NextPart()
if err != nil {
t.Fatalf("reading encoded field failed with error %v", err)
}
if part.FormName() != "foo" {
t.Errorf("encoded field name = %q, want %q", part.FormName(), "foo")
}
contents, err := io.ReadAll(part)
if err != nil {
t.Fatalf("reading encoded field contents failed with error %v", err)
}
if len(contents) != 0 {
t.Errorf("encoded typed nil reader contents = %q, want empty", contents)
}
}