Skip to content

fix(bigtable): sanitize RowRange proto input #14651

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
dbolduc merged 1 commit into from
Aug 19, 2024
Merged

fix(bigtable): sanitize RowRange proto input #14651

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
17 changes: 17 additions & 0 deletions google/cloud/bigtable/row_range.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,23 @@ namespace bigtable {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
namespace btproto = ::google::bigtable::v2;

RowRange::RowRange(::google::bigtable::v2::RowRange rhs)
: row_range_(std::move(rhs)) {
// The service treats an empty end key as end of table. Some of our
// intersection logic does not, though. So we are best off sanitizing the
// input, by clearing the end key if it is empty.
if (row_range_.has_end_key_closed()) {
if (internal::IsEmptyRowKey(row_range_.end_key_closed())) {
row_range_.clear_end_key_closed();
}
}
if (row_range_.has_end_key_open()) {
if (internal::IsEmptyRowKey(row_range_.end_key_open())) {
row_range_.clear_end_key_open();
}
}
}

bool RowRange::IsEmpty() const {
RowKeyType unused;
// We do not want to copy the strings unnecessarily, so initialize a reference
Expand Down
6 changes: 3 additions & 3 deletions google/cloud/bigtable/row_range.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,19 @@ namespace google {
namespace cloud {
namespace bigtable {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN

/**
* Define the interfaces to create row key ranges.
*
* Example:
* @code
* // Create a range for the keys starting with the given prefix.
* auto range = bigtable::RowRange("foo/");
* auto range = bigtable::RowRange::StartingAt("foo/");
* @endcode
*/
class RowRange {
public:
explicit RowRange(::google::bigtable::v2::RowRange rhs)
: row_range_(std::move(rhs)) {}
explicit RowRange(::google::bigtable::v2::RowRange rhs);

RowRange(RowRange&&) = default;
RowRange& operator=(RowRange&&) = default;
Expand Down
12 changes: 12 additions & 0 deletions google/cloud/bigtable/row_range_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -735,6 +735,18 @@ TEST(RowRangeTest, IntersectEndingAtEndingAt) {
EXPECT_EQ(R::EndingAt("k"), std::get<1>(tuple));
}

TEST(RowRangeTest, SanitizesInput) {
google::bigtable::v2::RowRange proto;
proto.set_start_key_open("");
proto.set_end_key_open("");
auto rr = RowRange(proto);
EXPECT_FALSE(rr.IsEmpty());

proto.set_end_key_closed("");
rr = RowRange(std::move(proto));
EXPECT_FALSE(rr.IsEmpty());
}

} // namespace
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
} // namespace bigtable
Expand Down