Skip to content
Permalink
Browse files Browse the repository at this point in the history
Throw on bad types during skipping data
Summary:
The current code silently returns on bad types. In case when we have an invalid data, we may get a container of a large size with a bad type, this would lead to us running long loop doing nothing (though we already can say that the data is invalid).

The new code would throw an exception as soon as we try to skip a value of invalid type.

Fixes CVE-2019-3552

Reviewed By: yfeldblum, stevegury

Differential Revision: D8344920

fbshipit-source-id: f12e8f3442f7ad5e1a81d822380701e929b80f0d
  • Loading branch information
spalamarchuk authored and facebook-github-bot committed Feb 14, 2019
1 parent c595188 commit c5d6e07
Show file tree
Hide file tree
Showing 5 changed files with 87 additions and 5 deletions.
8 changes: 8 additions & 0 deletions thrift/lib/cpp/protocol/TProtocolException.cpp
Expand Up @@ -57,4 +57,12 @@ namespace apache { namespace thrift { namespace protocol {
"Attempt to interpret value {} as bool, probably the data is corrupted",
value));
}

[[noreturn]] void TProtocolException::throwInvalidSkipType(TType type) {
throw TProtocolException(
TProtocolException::INVALID_DATA,
folly::sformat(
"Encountered invalid field/element type ({}) during skipping",
static_cast<uint8_t>(type)));
}
}}}
2 changes: 2 additions & 0 deletions thrift/lib/cpp/protocol/TProtocolException.h
Expand Up @@ -23,6 +23,7 @@
#define _THRIFT_PROTOCOL_TPROTOCOLEXCEPTION_H_ 1

#include <thrift/lib/cpp/Thrift.h>
#include <thrift/lib/cpp/protocol/TType.h>

#include <string>

Expand Down Expand Up @@ -106,6 +107,7 @@ class TProtocolException : public apache::thrift::TLibraryException {
folly::StringPiece field,
folly::StringPiece type);
[[noreturn]] static void throwBoolValueOutOfRange(uint8_t value);
[[noreturn]] static void throwInvalidSkipType(TType type);

protected:
/**
Expand Down
5 changes: 3 additions & 2 deletions thrift/lib/cpp2/protocol/Protocol.h
Expand Up @@ -176,8 +176,9 @@ void skip(Protocol_& prot, TType arg_type) {
prot.readListEnd();
return;
}
default:
return;
default: {
TProtocolException::throwInvalidSkipType(arg_type);
}
}
}

Expand Down
9 changes: 6 additions & 3 deletions thrift/lib/py/protocol/TProtocol.py
Expand Up @@ -177,9 +177,7 @@ def readString(self):
pass

def skip(self, type):
if type == TType.STOP:
return
elif type == TType.BOOL:
if type == TType.BOOL:
self.readBool()
elif type == TType.BYTE:
self.readByte()
Expand Down Expand Up @@ -220,6 +218,11 @@ def skip(self, type):
for _ in range(size):
self.skip(etype)
self.readListEnd()
else:
raise TProtocolException(
TProtocolException.INVALID_DATA,
"Unexpected type for skipping {}".format(type)
)

def readIntegral(self, type):
if type == TType.BOOL:
Expand Down
68 changes: 68 additions & 0 deletions thrift/test/ProtocolSkipTest.cpp
@@ -0,0 +1,68 @@
/*
* Copyright 2004-present Facebook, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#include <gtest/gtest.h>

#include <thrift/lib/cpp2/protocol/CompactProtocol.h>

using namespace apache::thrift;

TEST(ProtocolSkipTest, SkipInt) {
IOBufQueue queue;
CompactProtocolWriter writer;
writer.setOutput(&queue);
writer.writeI32(123);
auto buf = queue.move();
CompactProtocolReader reader;
reader.setInput(buf.get());
reader.skip(TType::T_I32);
}

TEST(ProtocolSkipTest, SkipStop) {
IOBufQueue queue;
CompactProtocolWriter writer;
writer.setOutput(&queue);
writer.writeFieldStop();
auto buf = queue.move();
CompactProtocolReader reader;
reader.setInput(buf.get());
bool thrown = false;
try {
reader.skip(TType::T_STOP);
} catch (const TProtocolException& ex) {
EXPECT_EQ(TProtocolException::INVALID_DATA, ex.getType());
thrown = true;
}
EXPECT_TRUE(thrown);
}

TEST(ProtocolSkipTest, SkipStopInContainer) {
IOBufQueue queue;
CompactProtocolWriter writer;
writer.setOutput(&queue);
writer.writeListBegin(TType::T_STOP, 1u << 30);
auto buf = queue.move();
CompactProtocolReader reader;
reader.setInput(buf.get());
bool thrown = false;
try {
reader.skip(TType::T_LIST);
} catch (const TProtocolException& ex) {
EXPECT_EQ(TProtocolException::INVALID_DATA, ex.getType());
thrown = true;
}
EXPECT_TRUE(thrown);
}

0 comments on commit c5d6e07

Please sign in to comment.