AuroraMiddleware/nlohmannjson
1
0
Fork 0
mirror of https://github.com/nlohmann/json synced 2024-12-17 22:51:07 +00:00
Code Issues Releases Wiki Activity

💥 CBOR/MessagePack input must end with EOF #505

Browse Source 
The CBOR and MessagePack parsers now expect the input to be read until the end. Unless the new parameter "strict" is set to false (it is true by default), an exception is raised if the parser ends prematurely. This is a breaking change as the parsers ignored unread input so far.

Furthermore, the offset/startIndex paramter introduced in #462 was removed as this behavior can be mimicked with an iterator range. For instance, instead of calling "from_cbor(vec, 5);", you can write "from_cbor({vec.begin()+5, vec.end()});".
This commit is contained in:
Niels Lohmann 2017-08-16 14:48:23 +02:00
parent 1f31a5b808
commit 22b59693f1
No known key found for this signature in database
GPG Key ID: 7F3CEA63AE251B69
4 changed files with 86 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
src/json.hpp
View File

@ -4411,16 +4411,14 @@ class binary_reader
/*!
@brief create a JSON value from CBOR input
@param[in] get_char whether a new character should be retrieved from
the input (true, default) or whether the last
read character should be considered instead
@param[in] strict whether to expect the input to be consumed completed
@return JSON value created from CBOR input
@throw parse_error.110 if input ended unexpectedly
@throw parse_error.110 if input ended unexpectedly or the end of file was
not reached when @a strict was set to true
@throw parse_error.112 if unsupported byte was read
*/
BasicJsonType parse_cbor(const bool strict = false)
BasicJsonType parse_cbor(const bool strict)
{
const auto res = parse_cbor_internal();
if (strict)
@ -4434,12 +4432,14 @@ class binary_reader
/*!
@brief create a JSON value from MessagePack input
@param[in] strict whether to expect the input to be consumed completed
@return JSON value created from MessagePack input
@throw parse_error.110 if input ended unexpectedly
@throw parse_error.110 if input ended unexpectedly or the end of file was
not reached when @a strict was set to true
@throw parse_error.112 if unsupported byte was read
*/
BasicJsonType parse_msgpack(const bool strict = false)
BasicJsonType parse_msgpack(const bool strict)
{
const auto res = parse_msgpack_internal();
if (strict)
@ -4463,6 +4463,11 @@ class binary_reader
}
private:
/*!
@param[in] get_char whether a new character should be retrieved from the
input (true, default) or whether the last read
character should be considered instead
*/
BasicJsonType parse_cbor_internal(const bool get_char = true)
{
switch (get_char ? get() : current)
@ -13081,10 +13086,10 @@ class basic_json
}
/*!
@brief create a JSON value from a byte vector in CBOR format
@brief create a JSON value from an input in CBOR format
Deserializes a given byte vector @a v to a JSON value using the CBOR
(Concise Binary Object Representation) serialization format.
Deserializes a given input @a i to a JSON value using the CBOR (Concise
Binary Object Representation) serialization format.
The library maps CBOR types to JSON value types as follows:
@ -13146,44 +13151,42 @@ class basic_json
@note Any CBOR output created @ref to_cbor can be successfully parsed by
@ref from_cbor.
@param[in] v a byte vector in CBOR format
@param[in] start_index the index to start reading from @a v (0 by default)
@param[in] i an input in CBOR format convertible to an input adapter
@param[in] strict whether to expect the input to be consumed until EOF
(true by default)
@return deserialized JSON value
@throw parse_error.110 if the given vector ends prematurely
@throw parse_error.110 if the given input ends prematurely or the end of
file was not reached when @a strict was set to true
@throw parse_error.112 if unsupported features from CBOR were
used in the given vector @a v or if the input is not valid CBOR
used in the given input @a v or if the input is not valid CBOR
@throw parse_error.113 if a string was expected as map key, but not found
@complexity Linear in the size of the byte vector @a v.
@complexity Linear in the size of the input @a i.
@liveexample{The example shows the deserialization of a byte vector in CBOR
format to a JSON value.,from_cbor}
@sa http://cbor.io
@sa @ref to_cbor(const basic_json&) for the analogous serialization
@sa @ref from_msgpack(const std::vector<uint8_t>&, const size_t) for the
@sa @ref from_msgpack(detail::input_adapter, const bool) for the
related MessagePack format
@since version 2.0.9, parameter @a start_index since 2.1.1
@since version 2.0.9; parameter @a start_index since 2.1.1; changed to
consume input adapters, removed start_index parameter, and added
@a strict parameter since 3.0.0
*/
static basic_json from_cbor(const std::vector<uint8_t>& v,
const std::size_t start_index = 0)
static basic_json from_cbor(detail::input_adapter i,
const bool strict = true)
{
binary_reader br(detail::input_adapter(v.begin() + static_cast<difference_type>(start_index), v.end()));
return br.parse_cbor();
}
static basic_json from_cbor(detail::input_adapter i)
{
return binary_reader(i).parse_cbor();
return binary_reader(i).parse_cbor(strict);
}
/*!
@brief create a JSON value from a byte vector in MessagePack format
@brief create a JSON value from an input in MessagePack format
Deserializes a given byte vector @a v to a JSON value using the MessagePack
Deserializes a given input @a i to a JSON value using the MessagePack
serialization format.
The library maps MessagePack types to JSON value types as follows:
@ -13226,37 +13229,35 @@ class basic_json
@note Any MessagePack output created @ref to_msgpack can be successfully
parsed by @ref from_msgpack.
@param[in] v a byte vector in MessagePack format
@param[in] start_index the index to start reading from @a v (0 by default)
@return deserialized JSON value
@param[in] i an input in MessagePack format convertible to an input
adapter
@param[in] strict whether to expect the input to be consumed until EOF
(true by default)
@throw parse_error.110 if the given vector ends prematurely
@throw parse_error.110 if the given input ends prematurely or the end of
file was not reached when @a strict was set to true
@throw parse_error.112 if unsupported features from MessagePack were
used in the given vector @a v or if the input is not valid MessagePack
used in the given input @a i or if the input is not valid MessagePack
@throw parse_error.113 if a string was expected as map key, but not found
@complexity Linear in the size of the byte vector @a v.
@complexity Linear in the size of the input @a i.
@liveexample{The example shows the deserialization of a byte vector in
MessagePack format to a JSON value.,from_msgpack}
@sa http://msgpack.org
@sa @ref to_msgpack(const basic_json&) for the analogous serialization
@sa @ref from_cbor(const std::vector<uint8_t>&, const size_t) for the
related CBOR format
@sa @ref from_cbor(detail::input_adapter, const bool) for the related CBOR
format
@since version 2.0.9, parameter @a start_index since 2.1.1
@since version 2.0.9; parameter @a start_index since 2.1.1; changed to
consume input adapters, removed start_index parameter, and added
@a strict parameter since 3.0.0
*/
static basic_json from_msgpack(const std::vector<uint8_t>& v,
const std::size_t start_index = 0)
static basic_json from_msgpack(detail::input_adapter i,
const bool strict = true)
{
binary_reader br(detail::input_adapter(v.begin() + static_cast<difference_type>(start_index), v.end()));
return br.parse_msgpack();
}
static basic_json from_msgpack(detail::input_adapter i)
{
return binary_reader(i).parse_msgpack();
return binary_reader(i).parse_msgpack(strict);
}
/// @}

21
test/src/unit-cbor.cpp
View File

@ -1260,6 +1260,23 @@ TEST_CASE("CBOR")
CHECK_THROWS_WITH(json::from_cbor(std::vector<uint8_t>({0xa1, 0xff, 0x01})),
"[json.exception.parse_error.113] parse error at 2: expected a CBOR string; last byte: 0xff");
}
SECTION("strict mode")
{
std::vector<uint8_t> vec = {0xf6, 0xf6};
SECTION("non-strict mode")
{
const auto result = json::from_cbor(vec, false);
CHECK(result == json());
}
SECTION("strict mode")
{
CHECK_THROWS_AS(json::from_cbor(vec), json::parse_error);
CHECK_THROWS_WITH(json::from_cbor(vec),
"[json.exception.parse_error.110] parse error at 2: expected end of input");
}
}
}
}
@ -1305,7 +1322,7 @@ TEST_CASE("single CBOR roundtrip")
// check with different start index
packed.insert(packed.begin(), 5, 0xff);
CHECK(j1 == json::from_cbor(packed, 5));
CHECK(j1 == json::from_cbor({packed.begin() + 5, packed.end()}));
}
}
@ -1654,7 +1671,7 @@ TEST_CASE("all first bytes", "[!throws]")
try
{
json::from_cbor({byte});
json::from_cbor(std::vector<uint8_t>(1, byte));
}
catch (const json::parse_error& e)
{

19
test/src/unit-msgpack.cpp
View File

@ -1101,6 +1101,23 @@ TEST_CASE("MessagePack")
CHECK_THROWS_WITH(json::from_msgpack(std::vector<uint8_t>({0x81, 0xff, 0x01})),
"[json.exception.parse_error.113] parse error at 2: expected a MessagePack string; last byte: 0xff");
}
SECTION("strict mode")
{
std::vector<uint8_t> vec = {0xc0, 0xc0};
SECTION("non-strict mode")
{
const auto result = json::from_msgpack(vec, false);
CHECK(result == json());
}
SECTION("strict mode")
{
CHECK_THROWS_AS(json::from_msgpack(vec), json::parse_error);
CHECK_THROWS_WITH(json::from_msgpack(vec),
"[json.exception.parse_error.110] parse error at 2: expected end of input");
}
}
}
}
@ -1147,7 +1164,7 @@ TEST_CASE("single MessagePack roundtrip")
// check with different start index
packed.insert(packed.begin(), 5, 0xff);
CHECK(j1 == json::from_msgpack(packed, 5));
CHECK(j1 == json::from_msgpack({packed.begin() + 5, packed.end()}));
}
}

2
test/src/unit-regression.cpp
View File

@ -1108,7 +1108,7 @@ TEST_CASE("regression tests")
SECTION("issue #504 - assertion error (OSS-Fuzz 856)")
{
std::vector<uint8_t> vec1 = {0xf9, 0xff, 0xff, 0x4a, 0x3a, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0x01, 0x37, 0x02, 0x38};
json j1 = json::from_cbor(vec1);
json j1 = json::from_cbor(vec1, false);
// step 2: round trip
std::vector<uint8_t> vec2 = json::to_cbor(j1);