Tue, 22 Oct 2024 23:10:31 +0200
avoid state buffer allocation for JSON with reasonable nesting depth
/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright 2024 Mike Becker, Olaf Wintermann All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #include "cx/test.h" #include "cx/json.h" CX_TEST(test_json_init_default) { CxJson json; CX_TEST_DO { cxJsonInit(&json); CX_TEST_ASSERT(json.states == json.states_internal); CX_TEST_ASSERT(json.nstates == 0); CX_TEST_ASSERT(json.states_alloc == 8); CX_TEST_ASSERT(json.reader_array_alloc == 8); } } CX_TEST(test_json_simple_object) { cxstring text = cx_str( "{\n" "\t\"message\":\"success\",\n" "\t\"position\":{\n" "\t\t\"longitude\":-94.7099,\n" "\t\t\"latitude\":51.5539\n" "\t},\n" "\t\"timestamp\":1729348561,\n" "\t\"alive\":true\n" "}" ); CX_TEST_DO { int result; CxJson json; cxJsonInit(&json); cxJsonFill(&json, text.ptr, text.length); // parse the big fat object CxJsonValue *obj; result = cxJsonNext(&json, &obj); CX_TEST_ASSERT(result == 1); // check the contents CX_TEST_ASSERT(cxJsonIsObject(obj)); CxJsonValue *message = cxJsonObjGet(obj, "message"); CX_TEST_ASSERT(cxJsonIsString(message)); CX_TEST_ASSERT(0 == cx_strcmp( cx_strcast(cxJsonAsString(message)), cx_str("success")) ); CxJsonValue *position = cxJsonObjGet(obj, "position"); CX_TEST_ASSERT(cxJsonIsObject(position)); CxJsonValue *longitude = cxJsonObjGet(position, "longitude"); CX_TEST_ASSERT(cxJsonIsNumber(longitude)); CX_TEST_ASSERT(cxJsonAsDouble(longitude) == -94.7099); CxJsonValue *latitude = cxJsonObjGet(position, "latitude"); CX_TEST_ASSERT(cxJsonIsNumber(latitude)); CX_TEST_ASSERT(cxJsonAsDouble(latitude) == 51.5539); CxJsonValue *timestamp = cxJsonObjGet(obj, "timestamp"); CX_TEST_ASSERT(cxJsonIsInteger(timestamp)); CX_TEST_ASSERT(cxJsonAsInteger(timestamp) == 1729348561); CxJsonValue *alive = cxJsonObjGet(obj, "alive"); CX_TEST_ASSERT(cxJsonIsBool(alive)); CX_TEST_ASSERT(cxJsonIsTrue(alive)); CX_TEST_ASSERT(!cxJsonIsFalse(alive)); CX_TEST_ASSERT(cxJsonAsBool(alive)); // this recursively frees everything else cxJsonValueFree(obj); // we only have one object that already contained all the data result = cxJsonNext(&json, &obj); CX_TEST_ASSERT(result == 0); cxJsonDestroy(&json); } } CX_TEST(test_json_object_incomplete_token) { cxstring text = cx_str( "{\"message\":\"success\" , \"__timestamp\":1729348561}"); cxstring parts[16]; size_t nparts = 0; // split the json text into mulple parts for(size_t i=0;i<text.length;i+=4) { parts[nparts++] = cx_strsubsl(text, i, 4); } CX_TEST_DO { int result; CxJson json; cxJsonInit(&json); CxJsonValue *obj; size_t part = 0; while(part < nparts) { cxJsonFill(&json, parts[part].ptr, parts[part].length); part++; result = cxJsonNext(&json, &obj); if(result != 0) { break; } } CX_TEST_ASSERT(result == 1); CX_TEST_ASSERT(part == nparts); CX_TEST_ASSERT(obj); CxJsonValue *message = cxJsonObjGet(obj, "message"); CX_TEST_ASSERT(cxJsonIsString(message)); CX_TEST_ASSERT(0 == cx_strcmp( cx_strcast(cxJsonAsString(message)), cx_str("success")) ); CxJsonValue *timestamp = cxJsonObjGet(obj, "__timestamp"); CX_TEST_ASSERT(message->type == CX_JSON_STRING); CX_TEST_ASSERT(cxJsonIsInteger(timestamp)); CX_TEST_ASSERT(cxJsonAsInteger(timestamp) == 1729348561); // this recursively frees everything else cxJsonValueFree(obj); // we only have one object that already contained all the data result = cxJsonNext(&json, &obj); CX_TEST_ASSERT(result == 0); cxJsonDestroy(&json); } } CX_TEST(test_json_object_error) { cxstring text0 = cx_str( "{\n" "\t\"message\":\"success\",\n" "\t\"data\":{\n" "\t\t\"obj\":{\n" "\t\t\t\"array\": [1, 2, 3, ?syntaxerror? ]\n" "\t\t\"}\n" "\t},\n" "\t\"timestamp\":1729348561,\n" "}" ); cxstring text1 = cx_str("{ \"string\" }"); cxstring text2 = cx_str("{ \"a\" : }"); cxstring text3 = cx_str("{ \"a\" : \"b\" ]"); cxstring text4 = cx_str("{ \"name\": \"value\" ]"); cxstring tests[] = { text0, text1, text2, text3, text4 }; CX_TEST_DO { int result; CxJson json; CxJsonValue *obj = NULL; for(int i=0;i<5;i++) { cxJsonInit(&json); cxJsonFill(&json, tests[i].ptr, tests[i].length); result = cxJsonNext(&json, &obj); CX_TEST_ASSERT(result == -1); CX_TEST_ASSERT(obj == NULL); cxJsonDestroy(&json); } } } CX_TEST(test_json_large_nesting_depth) { CxJson json; CxJsonValue *d1; cxstring text = cx_str("{\"test\": [{},{\"foo\": [[{\"bar\":[4, 2, [null, {\"key\": 47}]]}]]}]}"); CX_TEST_DO { cxJsonInit(&json); cxJsonFill(&json, text.ptr, text.length); cxJsonNext(&json, &d1); CX_TEST_ASSERT(d1 != NULL); CX_TEST_ASSERT(cxJsonIsObject(d1)); CxJsonValue *d2 = cxJsonObjGet(d1, "test"); CX_TEST_ASSERT(cxJsonIsArray(d2)); CX_TEST_ASSERT(cxJsonArrSize(d2) == 2); CxJsonValue *d3 = cxJsonArrGet(d2, 1); CX_TEST_ASSERT(cxJsonIsObject(d3)); CxJsonValue *d4 = cxJsonObjGet(d3, "foo"); CX_TEST_ASSERT(cxJsonIsArray(d4)); CX_TEST_ASSERT(cxJsonArrSize(d4) == 1); CxJsonValue *d5 = cxJsonArrGet(d4, 0); CX_TEST_ASSERT(cxJsonIsArray(d5)); CX_TEST_ASSERT(cxJsonArrSize(d5) == 1); CxJsonValue *d6 = cxJsonArrGet(d5, 0); CX_TEST_ASSERT(cxJsonIsObject(d6)); CxJsonValue *d7 = cxJsonObjGet(d6, "bar"); CX_TEST_ASSERT(cxJsonIsArray(d7)); CX_TEST_ASSERT(cxJsonArrSize(d7) == 3); CxJsonValue *d8 = cxJsonArrGet(d7, 2); CX_TEST_ASSERT(cxJsonIsArray(d8)); CX_TEST_ASSERT(cxJsonArrSize(d8) == 2); CxJsonValue *d9a = cxJsonArrGet(d8, 0); CX_TEST_ASSERT(cxJsonIsNull(d9a)); CxJsonValue *d9b = cxJsonArrGet(d8, 1); CX_TEST_ASSERT(cxJsonIsObject(d9b)); CxJsonValue *d10 = cxJsonObjGet(d9b, "key"); CX_TEST_ASSERT(cxJsonIsInteger(d10)); CX_TEST_ASSERT(cxJsonAsInteger(d10) == 47); CX_TEST_ASSERT(json.states != json.states_internal); CX_TEST_ASSERT(json.states_alloc > cx_nmemb(json.states_internal)); cxJsonDestroy(&json); } } CxTestSuite *cx_test_suite_json(void) { CxTestSuite *suite = cx_test_suite_new("json"); cx_test_register(suite, test_json_init_default); cx_test_register(suite, test_json_simple_object); cx_test_register(suite, test_json_object_incomplete_token); cx_test_register(suite, test_json_object_error); cx_test_register(suite, test_json_large_nesting_depth); return suite; }