Skip to content

Commit

Permalink
net/textproto: reject HTTP requests with empty header keys
Browse files Browse the repository at this point in the history
According to RFC 7230, empty field names in HTTP header are invalid.
However, there are no specific instructions for developers to deal
with that kind of case in the specification. CL 11242 chose to skip
it and do nothing about it, which now seems like a bad idea because
it has led `net/http` to behave inconsistently with the most widely-used
HTTP implementations: Apache, Nginx, Node with llhttp, H2O, Lighttpd, etc.
in the case of empty header keys.

There is a very small chance that this CL will break a few existing HTTP clients.

Fixes #65244

Change-Id: Ie01e9a6693d27caea4d81d1539345cf42b225535
Reviewed-on: https://go-review.googlesource.com/c/go/+/558095
Reviewed-by: Bryan Mills <bcmills@google.com>
Reviewed-by: Damien Neil <dneil@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
  • Loading branch information
panjf2000 authored and neild committed Jan 30, 2024
1 parent 41d6687 commit ae457e8
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 9 deletions.
4 changes: 4 additions & 0 deletions src/net/http/serve_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4799,6 +4799,10 @@ func TestServerValidatesHeaders(t *testing.T) {
{"Foo : bar\r\n", 400},
{"Foo\t: bar\r\n", 400},

// Empty header keys are invalid.
// See RFC 7230, Section 3.2.
{": empty key\r\n", 400},

{"foo: foo foo\r\n", 200}, // LWS space is okay
{"foo: foo\tfoo\r\n", 200}, // LWS tab is okay
{"foo: foo\x00foo\r\n", 400}, // CTL 0x00 in value is bad
Expand Down
11 changes: 4 additions & 7 deletions src/net/textproto/reader.go
Original file line number Diff line number Diff line change
Expand Up @@ -535,13 +535,6 @@ func readMIMEHeader(r *Reader, maxMemory, maxHeaders int64) (MIMEHeader, error)
}
}

// As per RFC 7230 field-name is a token, tokens consist of one or more chars.
// We could return a ProtocolError here, but better to be liberal in what we
// accept, so if we get an empty key, skip it.
if key == "" {
continue
}

maxHeaders--
if maxHeaders < 0 {
return nil, errors.New("message too large")
Expand Down Expand Up @@ -725,6 +718,10 @@ func validHeaderValueByte(c byte) bool {
// ReadMIMEHeader accepts header keys containing spaces, but does not
// canonicalize them.
func canonicalMIMEHeaderKey(a []byte) (_ string, ok bool) {
if len(a) == 0 {
return "", false
}

// See if a looks like a header key. If not, return it unchanged.
noCanon := false
for _, c := range a {
Expand Down
5 changes: 3 additions & 2 deletions src/net/textproto/reader_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,8 @@ func TestReaderUpcomingHeaderKeys(t *testing.T) {
func TestReadMIMEHeaderNoKey(t *testing.T) {
r := reader(": bar\ntest-1: 1\n\n")
m, err := r.ReadMIMEHeader()
want := MIMEHeader{"Test-1": {"1"}}
if !reflect.DeepEqual(m, want) || err != nil {
want := MIMEHeader{}
if !reflect.DeepEqual(m, want) || err == nil {
t.Fatalf("ReadMIMEHeader: %v, %v; want %v", m, err, want)
}
}
Expand Down Expand Up @@ -227,6 +227,7 @@ func TestReadMIMEHeaderMalformed(t *testing.T) {
"Foo\r\n\t: foo\r\n\r\n",
"Foo-\n\tBar",
"Foo \tBar: foo\r\n\r\n",
": empty key\r\n\r\n",
}
for _, input := range inputs {
r := reader(input)
Expand Down

0 comments on commit ae457e8

Please sign in to comment.