Skip to content

Internal changes #25580

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

Draft
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Internal changes #25580

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
101 changes: 101 additions & 0 deletions python/google/protobuf/internal/json_format_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1760,6 +1760,107 @@ def testNestedRecursiveLimit(self):
'{"payload": {}, "child": {"child":{}}}', message, max_recursion_depth=3
)

def testAnyRecursionDepthEnforcement(self):
"""Test that nested Any messages respect max_recursion_depth limit."""
# Test that deeply nested Any messages raise ParseError instead of
# bypassing the recursion limit. This prevents DoS via nested Any.
message = any_pb2.Any()

# Create nested Any structure that should exceed depth limit
# With max_recursion_depth=5, we can nest 4 Any messages
# (depth 1 = outer Any, depth 2-4 = nested Anys, depth 5 = final value)
nested_any = {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {},
},
},
},
},
}

# Should raise ParseError due to exceeding max depth, not RecursionError
self.assertRaisesRegex(
json_format.ParseError,
'Message too deep. Max recursion depth is 5',
json_format.ParseDict,
nested_any,
message,
max_recursion_depth=5,
)

# Verify that Any messages within the limit can be parsed successfully
# With max_recursion_depth=5, we can nest up to 4 Any messages
shallow_any = {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {},
},
},
},
}
json_format.ParseDict(shallow_any, message, max_recursion_depth=5)

def testAnyRecursionDepthBoundary(self):
"""Test recursion depth boundary behavior (exclusive upper limit)."""
message = any_pb2.Any()

# Create nested Any at depth exactly 4 (should succeed with max_recursion_depth=5)
depth_4_any = {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {},
},
},
},
}
# This should succeed: depth 4 < max_recursion_depth 5
json_format.ParseDict(depth_4_any, message, max_recursion_depth=5)

# Create nested Any at depth exactly 5 (should fail with max_recursion_depth=5)
depth_5_any = {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {
'@type': 'type.googleapis.com/google.protobuf.Any',
'value': {},
},
},
},
},
}
# This should fail: depth 5 == max_recursion_depth 5 (exclusive limit)
self.assertRaisesRegex(
json_format.ParseError,
'Message too deep. Max recursion depth is 5',
json_format.ParseDict,
depth_5_any,
message,
max_recursion_depth=5,
)

def testJsonNameConflictSerilize(self):
message = more_messages_pb2.ConflictJsonName(value=2)
self.assertEqual(
Expand Down
15 changes: 9 additions & 6 deletions python/google/protobuf/json_format.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,6 +524,10 @@ def ConvertMessage(self, value, message, path):
Raises:
ParseError: In case of convert problems.
"""
# Increment recursion depth at message entry. The max_recursion_depth limit
# is exclusive: a depth value equal to max_recursion_depth will trigger an
# error. For example, with max_recursion_depth=5, nesting up to depth 4 is
# allowed, but attempting depth 5 raises ParseError.
self.recursion_depth += 1
if self.recursion_depth > self.max_recursion_depth:
raise ParseError(
Expand Down Expand Up @@ -744,12 +748,11 @@ def _ConvertAnyMessage(self, value, message, path):
value['value'], sub_message, '{0}.value'.format(path)
)
elif full_name in _WKTJSONMETHODS:
methodcaller(
_WKTJSONMETHODS[full_name][1],
value['value'],
sub_message,
'{0}.value'.format(path),
)(self)
# For well-known types (including nested Any), use ConvertMessage
# to ensure recursion depth is properly tracked
self.ConvertMessage(
value['value'], sub_message, '{0}.value'.format(path)
)
else:
del value['@type']
try:
Expand Down
Loading