Skip to content

fix redis: type-check pub/sub reply elements before typed access #1345

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

Open
netliomax25-code wants to merge 1 commit into
base: develop
Choose a base branch
from
+107 −6
Open

fix redis: type-check pub/sub reply elements before typed access #1345

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
19 changes: 13 additions & 6 deletions redis/src/storages/redis/impl/sentinel.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,17 @@ void OnSubscribeImpl(
return;
}
if (!strcasecmp(reply_array[0].GetString().c_str(), subscribe_type.data())) {
subscribe_callback(reply->server_id, reply_array[1].GetString(), reply_array[2].GetInt());
if (reply_array[1].IsString() && reply_array[2].IsInt()) {
subscribe_callback(reply->server_id, reply_array[1].GetString(), reply_array[2].GetInt());
}
} else if (!strcasecmp(reply_array[0].GetString().c_str(), unsubscribe_type.data())) {
unsubscribe_callback(reply->server_id, reply_array[1].GetString(), reply_array[2].GetInt());
if (reply_array[1].IsString() && reply_array[2].IsInt()) {
unsubscribe_callback(reply->server_id, reply_array[1].GetString(), reply_array[2].GetInt());
}
} else if (!strcasecmp(reply_array[0].GetString().c_str(), message_type.data())) {
message_callback(reply->server_id, reply_array[1].GetString(), reply_array[2].GetString());
if (reply_array[1].IsString() && reply_array[2].IsString()) {
message_callback(reply->server_id, reply_array[1].GetString(), reply_array[2].GetString());
}
}
}

Expand Down Expand Up @@ -359,15 +365,16 @@ void Sentinel::OnPsubscribeReply(
return;
}
if (!strcasecmp(reply_array[0].GetString().c_str(), "PSUBSCRIBE")) {
if (reply_array.size() == 3) {
if (reply_array.size() == 3 && reply_array[1].IsString() && reply_array[2].IsInt()) {
subscribe_callback(reply->server_id, reply_array[1].GetString(), reply_array[2].GetInt());
}
} else if (!strcasecmp(reply_array[0].GetString().c_str(), "PUNSUBSCRIBE")) {
if (reply_array.size() == 3) {
if (reply_array.size() == 3 && reply_array[1].IsString() && reply_array[2].IsInt()) {
unsubscribe_callback(reply->server_id, reply_array[1].GetString(), reply_array[2].GetInt());
}
} else if (!strcasecmp(reply_array[0].GetString().c_str(), "PMESSAGE")) {
if (reply_array.size() == 4) {
if (reply_array.size() == 4 && reply_array[1].IsString() && reply_array[2].IsString() &&
reply_array[3].IsString()) {
pmessage_callback(
reply->server_id,
reply_array[1].GetString(),
Expand Down
94 changes: 94 additions & 0 deletions redis/src/storages/redis/impl/sentinel_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,98 @@ TEST(Sentinel, OnPsubscribeReplyTooShortArray) {
}
}

namespace {

// A malicious/compromised server may answer with a well-formed array of the
// expected length whose elements have unexpected types. ReplyData::GetString()/
// GetInt() only UASSERT the type (a no-op in release) and then dereference the
// pointer returned by std::get_if, which is null on a type mismatch. So each of
// these replies must be ignored, not passed to a typed accessor.
[[nodiscard]] storages::redis::ReplyData::Array MakeReplyArray(std::vector<storages::redis::ReplyData> parts) {
storages::redis::ReplyData::Array array;
for (auto& part : parts) {
array.push_back(std::move(part));
}
return array;
}

} // namespace

TEST(Sentinel, OnSubscribeReplyWrongElementTypes) {
using storages::redis::Reply;
using storages::redis::ReplyData;
using storages::redis::impl::Sentinel;

const auto fail_message = [](storages::redis::ServerId, const std::string&, const std::string&) {
FAIL() << "message callback must not fire on a wrong-typed reply element";
};
const auto fail_subscribe = [](storages::redis::ServerId, const std::string&, size_t) {
FAIL() << "subscribe callback must not fire on a wrong-typed reply element";
};
const auto fail_unsubscribe = [](storages::redis::ServerId, const std::string&, size_t) {
FAIL() << "unsubscribe callback must not fire on a wrong-typed reply element";
};

std::vector<ReplyData::Array> replies;
// channel is expected to be a string, count an integer
replies.push_back(MakeReplyArray({std::string{"SUBSCRIBE"}, ReplyData{42}, ReplyData{1}}));
replies.push_back(MakeReplyArray({std::string{"SUBSCRIBE"}, std::string{"news"}, std::string{"1"}}));
replies.push_back(MakeReplyArray({std::string{"UNSUBSCRIBE"}, ReplyData{42}, ReplyData{0}}));
replies.push_back(MakeReplyArray({std::string{"UNSUBSCRIBE"}, std::string{"news"}, std::string{"0"}}));
// channel and message are both expected to be strings
replies.push_back(MakeReplyArray({std::string{"MESSAGE"}, ReplyData{42}, std::string{"payload"}}));
replies.push_back(MakeReplyArray({std::string{"MESSAGE"}, std::string{"news"}, ReplyData{42}}));

for (auto& array : replies) {
auto reply = std::make_shared<Reply>("SUBSCRIBE", ReplyData{std::move(array)});
Sentinel::OnSubscribeReply(fail_message, fail_subscribe, fail_unsubscribe, reply);
}

// The sharded pub/sub variant shares the same dispatch (different opcodes).
std::vector<ReplyData::Array> sharded_replies;
sharded_replies.push_back(MakeReplyArray({std::string{"SSUBSCRIBE"}, ReplyData{42}, ReplyData{1}}));
sharded_replies.push_back(MakeReplyArray({std::string{"SUNSUBSCRIBE"}, ReplyData{42}, ReplyData{0}}));
sharded_replies.push_back(MakeReplyArray({std::string{"SMESSAGE"}, ReplyData{42}, std::string{"payload"}}));
sharded_replies.push_back(MakeReplyArray({std::string{"SMESSAGE"}, std::string{"news"}, ReplyData{42}}));
for (auto& array : sharded_replies) {
auto reply = std::make_shared<Reply>("SSUBSCRIBE", ReplyData{std::move(array)});
Sentinel::OnSsubscribeReply(fail_message, fail_subscribe, fail_unsubscribe, reply);
}
}

TEST(Sentinel, OnPsubscribeReplyWrongElementTypes) {
using storages::redis::Reply;
using storages::redis::ReplyData;
using storages::redis::impl::Sentinel;

const auto fail_pmessage =
[](storages::redis::ServerId, const std::string&, const std::string&, const std::string&) {
FAIL() << "pmessage callback must not fire on a wrong-typed reply element";
};
const auto fail_subscribe = [](storages::redis::ServerId, const std::string&, size_t) {
FAIL() << "subscribe callback must not fire on a wrong-typed reply element";
};
const auto fail_unsubscribe = [](storages::redis::ServerId, const std::string&, size_t) {
FAIL() << "unsubscribe callback must not fire on a wrong-typed reply element";
};

std::vector<ReplyData::Array> replies;
replies.push_back(MakeReplyArray({std::string{"PSUBSCRIBE"}, ReplyData{42}, ReplyData{1}}));
replies.push_back(MakeReplyArray({std::string{"PSUBSCRIBE"}, std::string{"news.*"}, std::string{"1"}}));
replies.push_back(MakeReplyArray({std::string{"PUNSUBSCRIBE"}, ReplyData{42}, ReplyData{0}}));
replies.push_back(MakeReplyArray({std::string{"PUNSUBSCRIBE"}, std::string{"news.*"}, std::string{"0"}}));
// pattern, channel and message are all expected to be strings
const std::string pat{"news.*"};
const std::string chan{"news"};
const std::string msg{"m"};
replies.push_back(MakeReplyArray({std::string{"PMESSAGE"}, ReplyData{42}, chan, msg}));
replies.push_back(MakeReplyArray({std::string{"PMESSAGE"}, pat, ReplyData{42}, msg}));
replies.push_back(MakeReplyArray({std::string{"PMESSAGE"}, pat, chan, ReplyData{42}}));

for (auto& array : replies) {
auto reply = std::make_shared<Reply>("PSUBSCRIBE", ReplyData{std::move(array)});
Sentinel::OnPsubscribeReply(fail_pmessage, fail_subscribe, fail_unsubscribe, reply);
}
}

USERVER_NAMESPACE_END
Loading