Skip to content

Improve SentryTraceHeader constructor parameter validation #4604

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 8, 2025
Merged

Improve SentryTraceHeader constructor parameter validation #4604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e28c00c
Improve SentryTraceHeader constructor parameter validation
alexander-alderman-webb Aug 4, 2025
eb08701
Reject malformed header with trailing slash and add test case
alexander-alderman-webb Aug 5, 2025
1a820e6
Make sentry-header regex private and final
alexander-alderman-webb Aug 5, 2025
70cfafd
Merge branch 'main' into feat/improve-sentry-trace-header-validation
alexander-alderman-webb Aug 8, 2025
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
28 changes: 16 additions & 12 deletions sentry/src/main/java/io/sentry/SentryTraceHeader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

import io.sentry.exception.InvalidSentryTraceHeaderException;
import io.sentry.protocol.SentryId;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

Expand All @@ -13,6 +15,11 @@ public final class SentryTraceHeader {
private final @NotNull SpanId spanId;
private final @Nullable Boolean sampled;

private static final Pattern SENTRY_TRACEPARENT_HEADER_REGEX =
Pattern.compile(
"^[ \\t]*(?<traceId>[0-9a-f]{32})-(?<spanId>[0-9a-f]{16})(?<sampled>-[01])?[ \\t]*$",
Pattern.CASE_INSENSITIVE);

public SentryTraceHeader(
final @NotNull SentryId traceId,
final @NotNull SpanId spanId,
Expand All @@ -23,20 +30,17 @@ public SentryTraceHeader(
}

public SentryTraceHeader(final @NotNull String value) throws InvalidSentryTraceHeaderException {
final String[] parts = value.split("-", -1);
if (parts.length < 2) {
Matcher matcher = SENTRY_TRACEPARENT_HEADER_REGEX.matcher(value);
boolean matchesExist = matcher.matches();

if (!matchesExist || matcher.group("traceId") == null || matcher.group("spanId") == null) {
throw new InvalidSentryTraceHeaderException(value);
} else if (parts.length == 3) {
this.sampled = "1".equals(parts[2]);
} else {
this.sampled = null;
}
try {
this.traceId = new SentryId(parts[0]);
this.spanId = new SpanId(parts[1]);
} catch (Throwable e) {
throw new InvalidSentryTraceHeaderException(value, e);
}

this.traceId = new SentryId(matcher.group("traceId"));
this.spanId = new SpanId(matcher.group("spanId"));
this.sampled =
matcher.group("sampled") == null ? null : "1".equals(matcher.group("sampled").substring(1));
}

public @NotNull String getName() {
Expand Down
87 changes: 87 additions & 0 deletions sentry/src/test/java/io/sentry/SentryTraceHeaderTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFailsWith
import kotlin.test.assertNull
import kotlin.text.substring

class SentryTraceHeaderTest {
@Test
Expand All @@ -15,6 +16,92 @@ class SentryTraceHeaderTest {
assertEquals("sentry-trace header does not conform to expected format: $sentryId", ex.message)
}

@Test
fun `when there is a trailing dash without sampling decision throws exception`() {
val sentryId = SentryId()
val spanId = SpanId()
val ex =
assertFailsWith<InvalidSentryTraceHeaderException> { SentryTraceHeader("$sentryId-$spanId-") }
assertEquals(
"sentry-trace header does not conform to expected format: $sentryId-$spanId-",
ex.message,
)
}

@Test
fun `when trace-id has less than 32 characters throws exception`() {
val sentryId = SentryId().toString().substring(0, 8)
val spanId = SpanId()
val ex =
assertFailsWith<InvalidSentryTraceHeaderException> { SentryTraceHeader("$sentryId-$spanId") }
assertEquals(
"sentry-trace header does not conform to expected format: $sentryId-$spanId",
ex.message,
)
}

@Test
fun `when trace-id has more than 32 characters throws exception`() {
val sentryId = SentryId().toString() + "abc"
val spanId = SpanId()
val ex =
assertFailsWith<InvalidSentryTraceHeaderException> { SentryTraceHeader("$sentryId-$spanId") }
assertEquals(
"sentry-trace header does not conform to expected format: $sentryId-$spanId",
ex.message,
)
}

@Test
fun `when trace-id contains invalid characters throws exception`() {
var sentryId = SentryId().toString()
sentryId = sentryId.substring(0, 8) + "g" + sentryId.substring(8)
val spanId = SpanId()
val ex =
assertFailsWith<InvalidSentryTraceHeaderException> { SentryTraceHeader("$sentryId-$spanId") }
assertEquals(
"sentry-trace header does not conform to expected format: $sentryId-$spanId",
ex.message,
)
}

@Test
fun `when span-id has less than 16 characters throws exception`() {
val sentryId = SentryId()
val spanId = SpanId().toString().substring(0, 8)
val ex =
assertFailsWith<InvalidSentryTraceHeaderException> { SentryTraceHeader("$sentryId-$spanId") }
assertEquals(
"sentry-trace header does not conform to expected format: $sentryId-$spanId",
ex.message,
)
}

@Test
fun `when span-id has more than 32 characters throws exception`() {
val sentryId = SentryId()
val spanId = SpanId().toString() + "abc"
val ex =
assertFailsWith<InvalidSentryTraceHeaderException> { SentryTraceHeader("$sentryId-$spanId") }
assertEquals(
"sentry-trace header does not conform to expected format: $sentryId-$spanId",
ex.message,
)
}

@Test
fun `when span-id contains invalid characters throws exception`() {
val sentryId = SentryId()
var spanId = SpanId().toString()
spanId = spanId.substring(0, 8) + "g" + spanId.substring(8)
val ex =
assertFailsWith<InvalidSentryTraceHeaderException> { SentryTraceHeader("$sentryId-$spanId") }
assertEquals(
"sentry-trace header does not conform to expected format: $sentryId-$spanId",
ex.message,
)
}

@Test
fun `handles header with positive sampling decision`() {
val sentryId = SentryId()
Expand Down
Loading