Skip to content

Commit f02feac

Browse files
authored
Merge commit from fork
* fix(propagation): limit baggage extraction error reporting Use sync.Once when reporting malformed or oversized baggage headers so attacker-controlled extraction failures cannot repeatedly flood the global error handler/log output. * propagation: test baggage error reporting limit * add changelog entry
1 parent 36c2f1b commit f02feac

4 files changed

Lines changed: 112 additions & 16 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
9191
- Close schema files opened by `ParseFile` in `go.opentelemetry.io/otel/schema/v1.0` and `go.opentelemetry.io/otel/schema/v1.1`. ([GHSA-995v-fvrw-c78m](https://github.com/open-telemetry/opentelemetry-go/security/advisories/GHSA-995v-fvrw-c78m))
9292
- Enforce the 8192-byte baggage size limit during extraction/parsing, changing behavior when the limit is exceeded in `go.opentelemetry.io/otel/baggage` and `go.opentelemetry.io/otel/propagation`. (#8222)
9393
- Fix `go.opentelemetry.io/otel/semconv/v1.41.0` to include `Attr*` helper methods for required attributes on observable instruments. (#8361)
94+
- Limit baggage extraction error reporting in `go.opentelemetry.io/otel/propagation` to prevent malformed or oversized baggage headers from flooding logs. ([GHSA-5wrp-cwcj-q835](https://github.com/open-telemetry/opentelemetry-go/security/advisories/GHSA-5wrp-cwcj-q835))
9495

9596
<!-- Released section -->
9697
<!-- Don't change this section unless doing release -->

‎propagation/baggage.go‎

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import (
77
"context"
88
"errors"
99
"fmt"
10+
"sync"
1011

1112
"go.opentelemetry.io/otel/baggage"
1213
"go.opentelemetry.io/otel/internal/errorhandler"
@@ -23,6 +24,10 @@ const (
2324
maxBytesPerBaggageString = 8192
2425
)
2526

27+
// handleExtractErrOnce limits error reporting for attacker-controlled baggage headers
28+
// to one process-wide emission, preventing repeated extraction from flooding logs.
29+
var handleExtractErrOnce sync.Once
30+
2631
// Baggage is a propagator that supports the W3C Baggage format.
2732
//
2833
// This propagates user-defined baggage associated with a trace. The complete
@@ -62,7 +67,9 @@ func extractSingleBaggage(parent context.Context, carrier TextMapCarrier) contex
6267

6368
bag, err := baggage.Parse(bStr)
6469
if err != nil {
65-
errorhandler.GetErrorHandler().Handle(err)
70+
handleExtractErrOnce.Do(func() {
71+
errorhandler.GetErrorHandler().Handle(err)
72+
})
6673
}
6774
if bag.Len() == 0 {
6875
return parent
@@ -91,11 +98,13 @@ func extractMultiBaggage(parent context.Context, carrier ValuesGetter) context.C
9198
// individually. Mirror the single-header behavior of
9299
// reporting the error and returning the parent context
93100
// with no baggage attached.
94-
errorhandler.GetErrorHandler().Handle(fmt.Errorf(
95-
"baggage: aggregate header size %d exceeds %d byte limit",
96-
totalBytes,
97-
maxBytesPerBaggageString,
98-
))
101+
handleExtractErrOnce.Do(func() {
102+
errorhandler.GetErrorHandler().Handle(fmt.Errorf(
103+
"baggage: aggregate header size %d exceeds %d byte limit",
104+
totalBytes,
105+
maxBytesPerBaggageString,
106+
))
107+
})
99108
return parent
100109
}
101110

@@ -124,7 +133,9 @@ func extractMultiBaggage(parent context.Context, carrier ValuesGetter) context.C
124133
truncateErr = errors.Join(truncateErr, err)
125134
}
126135
if truncateErr != nil {
127-
errorhandler.GetErrorHandler().Handle(truncateErr)
136+
handleExtractErrOnce.Do(func() {
137+
errorhandler.GetErrorHandler().Handle(truncateErr)
138+
})
128139
}
129140

130141
if b.Len() == 0 {

‎propagation/baggage_test.go‎

Lines changed: 82 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -539,10 +539,29 @@ func TestExtractOversizedSingleBaggageHeader(t *testing.T) {
539539
}
540540

541541
type errHandler struct {
542-
err error
542+
err error
543+
count int
543544
}
544545

545-
func (e *errHandler) Handle(err error) { e.err = err }
546+
func (e *errHandler) Handle(err error) {
547+
e.err = err
548+
e.count++
549+
}
550+
551+
func setBaggageErrHandler(t *testing.T) *errHandler {
552+
t.Helper()
553+
554+
propagation.ResetHandleExtractErrOnce()
555+
originalErrorHandler := otel.GetErrorHandler()
556+
eh := &errHandler{}
557+
otel.SetErrorHandler(eh)
558+
t.Cleanup(func() {
559+
otel.SetErrorHandler(originalErrorHandler)
560+
propagation.ResetHandleExtractErrOnce()
561+
})
562+
563+
return eh
564+
}
546565

547566
func TestExtractManyBaggageHeader(t *testing.T) {
548567
tests := []struct {
@@ -619,10 +638,7 @@ func TestExtractManyBaggageHeader(t *testing.T) {
619638

620639
for _, tt := range tests {
621640
t.Run(tt.name, func(t *testing.T) {
622-
originalErrorHandler := otel.GetErrorHandler()
623-
eh := &errHandler{}
624-
otel.SetErrorHandler(eh)
625-
t.Cleanup(func() { otel.SetErrorHandler(originalErrorHandler) })
641+
eh := setBaggageErrHandler(t)
626642

627643
prop := propagation.Baggage{}
628644
req, _ := http.NewRequestWithContext(t.Context(), http.MethodGet, "http://example.com", http.NoBody)
@@ -634,9 +650,66 @@ func TestExtractManyBaggageHeader(t *testing.T) {
634650
got := baggage.FromContext(ctx)
635651

636652
assert.Equal(t, tt.want().Baggage(t), got)
637-
assert.Error(t, eh.err)
638-
for _, s := range tt.wantErrStr {
639-
assert.Contains(t, eh.err.Error(), s)
653+
if assert.Error(t, eh.err) {
654+
for _, s := range tt.wantErrStr {
655+
assert.Contains(t, eh.err.Error(), s)
656+
}
657+
}
658+
})
659+
}
660+
}
661+
662+
func TestExtractInvalidBaggageReportsErrorOnce(t *testing.T) {
663+
tests := []struct {
664+
name string
665+
carrier func(t *testing.T) propagation.TextMapCarrier
666+
wantErr string
667+
}{
668+
{
669+
name: "single header parse error",
670+
carrier: func(t *testing.T) propagation.TextMapCarrier {
671+
t.Helper()
672+
return propagation.MapCarrier{"baggage": "invalid"}
673+
},
674+
wantErr: "invalid baggage list-member",
675+
},
676+
{
677+
name: "multiple header parse errors",
678+
carrier: func(t *testing.T) propagation.TextMapCarrier {
679+
t.Helper()
680+
req, _ := http.NewRequestWithContext(t.Context(), http.MethodGet, "http://example.com", http.NoBody)
681+
req.Header.Add("baggage", "invalid")
682+
return propagation.HeaderCarrier(req.Header)
683+
},
684+
wantErr: "invalid baggage list-member",
685+
},
686+
{
687+
name: "aggregate header size error",
688+
carrier: func(t *testing.T) propagation.TextMapCarrier {
689+
t.Helper()
690+
req, _ := http.NewRequestWithContext(t.Context(), http.MethodGet, "http://example.com", http.NoBody)
691+
req.Header.Add("baggage", "k="+strings.Repeat("v", maxBytesPerBaggageString/2-2))
692+
req.Header.Add("baggage", "y="+strings.Repeat("v", maxBytesPerBaggageString/2-2))
693+
return propagation.HeaderCarrier(req.Header)
694+
},
695+
wantErr: "exceeds 8192 byte limit",
696+
},
697+
}
698+
699+
for _, tt := range tests {
700+
t.Run(tt.name, func(t *testing.T) {
701+
eh := setBaggageErrHandler(t)
702+
prop := propagation.Baggage{}
703+
704+
for range 10 {
705+
ctx := prop.Extract(t.Context(), tt.carrier(t))
706+
got := baggage.FromContext(ctx)
707+
assert.Equal(t, 0, got.Len(), "invalid header should result in empty baggage")
708+
}
709+
710+
assert.Equal(t, 1, eh.count, "invalid baggage extraction should report only once")
711+
if assert.Error(t, eh.err) {
712+
assert.Contains(t, eh.err.Error(), tt.wantErr)
640713
}
641714
})
642715
}

‎propagation/export_test.go‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
// Copyright The OpenTelemetry Authors
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
package propagation
5+
6+
import "sync"
7+
8+
// ResetHandleExtractErrOnce resets handleExtractErrOnce for tests.
9+
func ResetHandleExtractErrOnce() {
10+
handleExtractErrOnce = sync.Once{}
11+
}

0 commit comments

Comments
 (0)