Skip to content

Commit 5eec56b

Browse files
djaglowskimichael-burt
authored andcommitted
[receiver/windowseventlog] Fix panic when rendering excessively long offset (open-telemetry#36179)
A user observed a panic in the receiver after updating to v0.112.0, where rendering info is expanded by default: ``` goroutine 69 [running]: github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/input/windows.(*Buffer).ReadBytes(0x37?, 0x19?) C:/Users/runneradmin/go/pkg/mod/github.com/open-telemetry/opentelemetry-collector-contrib/pkg/[email protected]/operator/input/windows/buffer.go:26 +0x165 github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/input/windows.(*Buffer).ReadWideChars(...) C:/Users/runneradmin/go/pkg/mod/github.com/open-telemetry/opentelemetry-collector-contrib/pkg/[email protected]/operator/input/windows/buffer.go:37 github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/input/windows.(*Event).RenderDeep(0xc002aaf998, {{0xc003120000, 0x4000, 0x4000}}, {0x8c1b918?}) C:/Users/runneradmin/go/pkg/mod/github.com/open-telemetry/opentelemetry-collector-contrib/pkg/[email protected]/operator/input/windows/event.go:117 +0x155 github.com/open-telemetry/opentelemetry-collector-contrib/pkg/stanza/operator/input/windows.(*Input).renderDeepAndSend(0xc001ee3dc0, {0x9977160, 0xc00312c460}, {0x19}, {0x13b480ccd58?}) ``` @pjanotti This is a quick fix to avoid the panic by reading the full buffer, but not trying to read more. There may be a better behavior than this but I am not familiar with how the buffer size is established so am proposing to just read the full content for now.
1 parent d4a23bf commit 5eec56b

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed

.chloggen/fix-panic-wel.yaml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Use this changelog template to create an entry for release notes.
2+
3+
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
4+
change_type: bug_fix
5+
6+
# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
7+
component: receiver/windowseventlog
8+
9+
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
10+
note: Fix panic when rendering long event messages.
11+
12+
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
13+
issues: [36179]
14+
15+
# (Optional) One or more lines of additional information to render under the primary note.
16+
# These lines will be padded with 2 spaces and then inserted directly into the document.
17+
# Use pipe (|) for multiline entries.
18+
subtext:
19+
20+
# If your change doesn't affect end users or the exported elements of any package,
21+
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
22+
# Optional: The change log or logs in which this entry should be included.
23+
# e.g. '[user]' or '[user, api]'
24+
# Include 'user' if the change is relevant to end users.
25+
# Include 'api' if there is a change to a library API.
26+
# Default: '[user]'
27+
change_logs: []

pkg/stanza/operator/input/windows/buffer.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ type Buffer struct {
2323

2424
// ReadBytes will read UTF-8 bytes from the buffer, where offset is the number of bytes to be read
2525
func (b *Buffer) ReadBytes(offset uint32) ([]byte, error) {
26+
if offset > uint32(len(b.buffer)) {
27+
offset = uint32(len(b.buffer))
28+
}
2629
utf16 := b.buffer[:offset]
2730
utf8, err := unicode.UTF16(unicode.LittleEndian, unicode.UseBOM).NewDecoder().Bytes(utf16)
2831
if err != nil {

pkg/stanza/operator/input/windows/buffer_test.go

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,17 @@ func TestBufferReadBytes(t *testing.T) {
2121
require.Equal(t, utf8, bytes)
2222
}
2323

24+
func TestBufferReadBytesOverflow(t *testing.T) {
25+
buffer := NewBuffer()
26+
utf8 := []byte("test")
27+
utf16, _ := unicode.UTF16(unicode.LittleEndian, unicode.UseBOM).NewEncoder().Bytes(utf8)
28+
copy(buffer.buffer, utf16)
29+
offset := uint32(len(utf16))
30+
bytes, err := buffer.ReadBytes(offset * 2)
31+
require.NoError(t, err)
32+
require.Equal(t, utf8, bytes)
33+
}
34+
2435
func TestBufferReadWideBytes(t *testing.T) {
2536
buffer := NewBuffer()
2637
utf8 := []byte("test")

0 commit comments

Comments
 (0)