LCOV - code coverage report
Current view: top level - src/univalue/lib - univalue_read.cpp (source / functions) Coverage Total Hit
Test: test_bitcoin_coverage.info Lines: 99.6 % 264 263
Test Date: 2026-02-04 04:43:42 Functions: 100.0 % 4 4
Branches: 78.2 % 280 219

             Branch data     Line data    Source code
       1                 :             : // Copyright 2014 BitPay Inc.
       2                 :             : // Distributed under the MIT software license, see the accompanying
       3                 :             : // file COPYING or https://opensource.org/licenses/mit-license.php.
       4                 :             : 
       5                 :             : #include <univalue.h>
       6                 :             : #include <univalue_utffilter.h>
       7                 :             : 
       8                 :             : #include <cstdint>
       9                 :             : #include <cstring>
      10                 :             : #include <string>
      11                 :             : #include <string_view>
      12                 :             : #include <vector>
      13                 :             : 
      14                 :             : /*
      15                 :             :  * According to stackexchange, the original json test suite wanted
      16                 :             :  * to limit depth to 22.  Widely-deployed PHP bails at depth 512,
      17                 :             :  * so we will follow PHP's lead, which should be more than sufficient
      18                 :             :  * (further stackexchange comments indicate depth > 32 rarely occurs).
      19                 :             :  */
      20                 :             : static constexpr size_t MAX_JSON_DEPTH = 512;
      21                 :             : 
      22                 :       20260 : static bool json_isdigit(int ch)
      23                 :             : {
      24                 :       20260 :     return ((ch >= '0') && (ch <= '9'));
      25                 :             : }
      26                 :             : 
      27                 :             : // convert hexadecimal string to unsigned integer
      28                 :          50 : static const char *hatoui(const char *first, const char *last,
      29                 :             :                           unsigned int& out)
      30                 :             : {
      31                 :          50 :     unsigned int result = 0;
      32         [ +  + ]:         250 :     for (; first != last; ++first)
      33                 :             :     {
      34                 :         200 :         int digit;
      35         [ +  + ]:         200 :         if (json_isdigit(*first))
      36                 :         150 :             digit = *first - '0';
      37                 :             : 
      38         [ +  + ]:          50 :         else if (*first >= 'a' && *first <= 'f')
      39                 :          28 :             digit = *first - 'a' + 10;
      40                 :             : 
      41         [ +  - ]:          22 :         else if (*first >= 'A' && *first <= 'F')
      42                 :          22 :             digit = *first - 'A' + 10;
      43                 :             : 
      44                 :             :         else
      45                 :             :             break;
      46                 :             : 
      47                 :         200 :         result = 16 * result + digit;
      48                 :             :     }
      49                 :          50 :     out = result;
      50                 :             : 
      51                 :          50 :     return first;
      52                 :             : }
      53                 :             : 
      54                 :       51928 : enum jtokentype getJsonToken(std::string& tokenVal, unsigned int& consumed,
      55                 :             :                             const char *raw, const char *end)
      56                 :             : {
      57                 :       51928 :     tokenVal.clear();
      58                 :       51928 :     consumed = 0;
      59                 :             : 
      60                 :       51928 :     const char *rawStart = raw;
      61                 :             : 
      62   [ +  +  +  + ]:      112174 :     while (raw < end && (json_isspace(*raw)))          // skip whitespace
      63                 :       60246 :         raw++;
      64                 :             : 
      65         [ +  + ]:       51928 :     if (raw >= end)
      66                 :             :         return JTOK_NONE;
      67                 :             : 
      68   [ +  +  +  +  :       51820 :     switch (*raw) {
          +  +  +  +  +  
                      + ]
      69                 :             : 
      70                 :         386 :     case '{':
      71                 :         386 :         raw++;
      72                 :         386 :         consumed = (raw - rawStart);
      73                 :         386 :         return JTOK_OBJ_OPEN;
      74                 :         370 :     case '}':
      75                 :         370 :         raw++;
      76                 :         370 :         consumed = (raw - rawStart);
      77                 :         370 :         return JTOK_OBJ_CLOSE;
      78                 :        6692 :     case '[':
      79                 :        6692 :         raw++;
      80                 :        6692 :         consumed = (raw - rawStart);
      81                 :        6692 :         return JTOK_ARR_OPEN;
      82                 :        5643 :     case ']':
      83                 :        5643 :         raw++;
      84                 :        5643 :         consumed = (raw - rawStart);
      85                 :        5643 :         return JTOK_ARR_CLOSE;
      86                 :             : 
      87                 :        1023 :     case ':':
      88                 :        1023 :         raw++;
      89                 :        1023 :         consumed = (raw - rawStart);
      90                 :        1023 :         return JTOK_COLON;
      91                 :       17026 :     case ',':
      92                 :       17026 :         raw++;
      93                 :       17026 :         consumed = (raw - rawStart);
      94                 :       17026 :         return JTOK_COMMA;
      95                 :             : 
      96                 :         283 :     case 'n':
      97                 :         283 :     case 't':
      98                 :         283 :     case 'f':
      99         [ +  + ]:         283 :         if (!strncmp(raw, "null", 4)) {
     100                 :          18 :             raw += 4;
     101                 :          18 :             consumed = (raw - rawStart);
     102                 :          18 :             return JTOK_KW_NULL;
     103         [ +  + ]:         265 :         } else if (!strncmp(raw, "true", 4)) {
     104                 :         130 :             raw += 4;
     105                 :         130 :             consumed = (raw - rawStart);
     106                 :         130 :             return JTOK_KW_TRUE;
     107         [ +  + ]:         135 :         } else if (!strncmp(raw, "false", 5)) {
     108                 :         131 :             raw += 5;
     109                 :         131 :             consumed = (raw - rawStart);
     110                 :         131 :             return JTOK_KW_FALSE;
     111                 :             :         } else
     112                 :             :             return JTOK_ERR;
     113                 :             : 
     114                 :        4368 :     case '-':
     115                 :        4368 :     case '0':
     116                 :        4368 :     case '1':
     117                 :        4368 :     case '2':
     118                 :        4368 :     case '3':
     119                 :        4368 :     case '4':
     120                 :        4368 :     case '5':
     121                 :        4368 :     case '6':
     122                 :        4368 :     case '7':
     123                 :        4368 :     case '8':
     124                 :        4368 :     case '9': {
     125                 :             :         // part 1: int
     126         [ +  + ]:        4368 :         std::string numStr;
     127                 :             : 
     128                 :        4368 :         const char *first = raw;
     129                 :             : 
     130                 :        4368 :         const char *firstDigit = first;
     131         [ +  + ]:        4368 :         if (!json_isdigit(*firstDigit))
     132                 :         396 :             firstDigit++;
     133   [ +  +  +  + ]:        4368 :         if ((*firstDigit == '0') && json_isdigit(firstDigit[1]))
     134                 :             :             return JTOK_ERR;
     135                 :             : 
     136         [ +  - ]:        4367 :         numStr += *raw;                       // copy first char
     137                 :        4367 :         raw++;
     138                 :             : 
     139   [ +  +  +  -  :        4367 :         if ((*first == '-') && (raw < end) && (!json_isdigit(*raw)))
                   +  - ]
     140                 :             :             return JTOK_ERR;
     141                 :             : 
     142   [ +  +  +  + ]:       12824 :         while (raw < end && json_isdigit(*raw)) {  // copy digits
     143         [ +  - ]:        8457 :             numStr += *raw;
     144                 :        8457 :             raw++;
     145                 :             :         }
     146                 :             : 
     147                 :             :         // part 2: frac
     148   [ +  +  +  + ]:        4367 :         if (raw < end && *raw == '.') {
     149         [ +  - ]:         355 :             numStr += *raw;                   // copy .
     150                 :         355 :             raw++;
     151                 :             : 
     152   [ +  -  +  - ]:         355 :             if (raw >= end || !json_isdigit(*raw))
     153                 :             :                 return JTOK_ERR;
     154   [ +  +  +  + ]:        2779 :             while (raw < end && json_isdigit(*raw)) { // copy digits
     155         [ +  - ]:        2424 :                 numStr += *raw;
     156                 :        2424 :                 raw++;
     157                 :             :             }
     158                 :             :         }
     159                 :             : 
     160                 :             :         // part 3: exp
     161   [ +  +  +  +  :        4367 :         if (raw < end && (*raw == 'e' || *raw == 'E')) {
                   +  + ]
     162         [ +  - ]:          26 :             numStr += *raw;                   // copy E
     163                 :          26 :             raw++;
     164                 :             : 
     165   [ +  -  +  +  :          26 :             if (raw < end && (*raw == '-' || *raw == '+')) { // copy +/-
                   +  + ]
     166         [ +  - ]:          19 :                 numStr += *raw;
     167                 :          19 :                 raw++;
     168                 :             :             }
     169                 :             : 
     170   [ +  -  +  + ]:          26 :             if (raw >= end || !json_isdigit(*raw))
     171                 :             :                 return JTOK_ERR;
     172   [ +  +  +  + ]:          59 :             while (raw < end && json_isdigit(*raw)) { // copy digits
     173         [ +  - ]:          36 :                 numStr += *raw;
     174                 :          36 :                 raw++;
     175                 :             :             }
     176                 :             :         }
     177                 :             : 
     178         [ +  - ]:        4364 :         tokenVal = numStr;
     179                 :        4364 :         consumed = (raw - rawStart);
     180                 :        4364 :         return JTOK_NUMBER;
     181                 :        4368 :         }
     182                 :             : 
     183                 :       16010 :     case '"': {
     184                 :       16010 :         raw++;                                // skip "
     185                 :             : 
     186                 :       16010 :         std::string valStr;
     187                 :       16010 :         JSONUTF8StringFilter writer(valStr);
     188                 :             : 
     189                 :      797643 :         while (true) {
     190   [ +  +  +  + ]:      797643 :             if (raw >= end || (unsigned char)*raw < 0x20)
     191                 :             :                 return JTOK_ERR;
     192                 :             : 
     193         [ +  + ]:      797639 :             else if (*raw == '\\') {
     194                 :          81 :                 raw++;                        // skip backslash
     195                 :             : 
     196         [ +  - ]:          81 :                 if (raw >= end)
     197                 :             :                     return JTOK_ERR;
     198                 :             : 
     199   [ +  +  +  +  :          81 :                 switch (*raw) {
          +  +  +  +  +  
                      + ]
     200         [ +  - ]:           7 :                 case '"':  writer.push_back('\"'); break;
     201         [ +  - ]:           3 :                 case '\\': writer.push_back('\\'); break;
     202         [ +  - ]:           2 :                 case '/':  writer.push_back('/'); break;
     203         [ +  - ]:           3 :                 case 'b':  writer.push_back('\b'); break;
     204         [ +  - ]:           3 :                 case 'f':  writer.push_back('\f'); break;
     205         [ +  - ]:           3 :                 case 'n':  writer.push_back('\n'); break;
     206         [ +  - ]:           3 :                 case 'r':  writer.push_back('\r'); break;
     207         [ +  - ]:           3 :                 case 't':  writer.push_back('\t'); break;
     208                 :             : 
     209                 :          50 :                 case 'u': {
     210                 :          50 :                     unsigned int codepoint;
     211   [ +  -  +  - ]:         100 :                     if (raw + 1 + 4 >= end ||
     212                 :          50 :                         hatoui(raw + 1, raw + 1 + 4, codepoint) !=
     213                 :             :                                raw + 1 + 4)
     214                 :           0 :                         return JTOK_ERR;
     215         [ +  - ]:          50 :                     writer.push_back_u(codepoint);
     216                 :          50 :                     raw += 4;
     217                 :          50 :                     break;
     218                 :             :                     }
     219                 :             :                 default:
     220                 :             :                     return JTOK_ERR;
     221                 :             : 
     222                 :             :                 }
     223                 :             : 
     224                 :          77 :                 raw++;                        // skip esc'd char
     225                 :             :             }
     226                 :             : 
     227         [ +  + ]:      797558 :             else if (*raw == '"') {
     228                 :       16002 :                 raw++;                        // skip "
     229                 :       16002 :                 break;                        // stop scanning
     230                 :             :             }
     231                 :             : 
     232                 :             :             else {
     233         [ +  - ]:      781556 :                 writer.push_back(static_cast<unsigned char>(*raw));
     234                 :      781556 :                 raw++;
     235                 :             :             }
     236                 :             :         }
     237                 :             : 
     238   [ +  +  +  + ]:       32004 :         if (!writer.finalize())
     239                 :             :             return JTOK_ERR;
     240         [ +  - ]:       15998 :         tokenVal = valStr;
     241                 :       15998 :         consumed = (raw - rawStart);
     242                 :       15998 :         return JTOK_STRING;
     243                 :       16010 :         }
     244                 :             : 
     245                 :             :     default:
     246                 :             :         return JTOK_ERR;
     247                 :             :     }
     248                 :             : }
     249                 :             : 
     250                 :             : enum expect_bits : unsigned {
     251                 :             :     EXP_OBJ_NAME = (1U << 0),
     252                 :             :     EXP_COLON = (1U << 1),
     253                 :             :     EXP_ARR_VALUE = (1U << 2),
     254                 :             :     EXP_VALUE = (1U << 3),
     255                 :             :     EXP_NOT_VALUE = (1U << 4),
     256                 :             : };
     257                 :             : 
     258                 :             : #define expect(bit) (expectMask & (EXP_##bit))
     259                 :             : #define setExpect(bit) (expectMask |= EXP_##bit)
     260                 :             : #define clearExpect(bit) (expectMask &= ~EXP_##bit)
     261                 :             : 
     262                 :         171 : bool UniValue::read(std::string_view str_in)
     263                 :             : {
     264                 :         171 :     clear();
     265                 :             : 
     266                 :         171 :     uint32_t expectMask = 0;
     267                 :         171 :     std::vector<UniValue*> stack;
     268                 :             : 
     269                 :         171 :     std::string tokenVal;
     270                 :         171 :     unsigned int consumed;
     271                 :         171 :     enum jtokentype tok = JTOK_NONE;
     272                 :         171 :     enum jtokentype last_tok = JTOK_NONE;
     273                 :         171 :     const char* raw{str_in.data()};
     274                 :         171 :     const char* end{raw + str_in.size()};
     275                 :       49315 :     do {
     276                 :       49315 :         last_tok = tok;
     277                 :             : 
     278         [ +  - ]:       49315 :         tok = getJsonToken(tokenVal, consumed, raw, end);
     279         [ +  + ]:       49315 :         if (tok == JTOK_NONE || tok == JTOK_ERR)
     280                 :             :             return false;
     281                 :       49279 :         raw += consumed;
     282                 :             : 
     283         [ +  + ]:       49279 :         bool isValueOpen = jsonTokenIsValue(tok) ||
     284         [ +  + ]:       31135 :             tok == JTOK_OBJ_OPEN || tok == JTOK_ARR_OPEN;
     285                 :             : 
     286         [ +  + ]:       49279 :         if (expect(VALUE)) {
     287         [ +  + ]:        1019 :             if (!isValueOpen)
     288                 :             :                 return false;
     289                 :        1017 :             clearExpect(VALUE);
     290                 :             : 
     291         [ +  + ]:       48260 :         } else if (expect(ARR_VALUE)) {
     292                 :       23036 :             bool isArrValue = isValueOpen || (tok == JTOK_ARR_CLOSE);
     293         [ +  + ]:       23036 :             if (!isArrValue)
     294                 :             :                 return false;
     295                 :             : 
     296                 :       23034 :             clearExpect(ARR_VALUE);
     297                 :             : 
     298         [ +  + ]:       25224 :         } else if (expect(OBJ_NAME)) {
     299                 :        1039 :             bool isObjName = (tok == JTOK_OBJ_CLOSE || tok == JTOK_STRING);
     300         [ +  + ]:        1039 :             if (!isObjName)
     301                 :             :                 return false;
     302                 :             : 
     303         [ +  + ]:       24185 :         } else if (expect(COLON)) {
     304         [ +  + ]:        1023 :             if (tok != JTOK_COLON)
     305                 :             :                 return false;
     306                 :        1021 :             clearExpect(COLON);
     307                 :             : 
     308         [ +  + ]:       23162 :         } else if (!expect(COLON) && (tok == JTOK_COLON)) {
     309                 :             :             return false;
     310                 :             :         }
     311                 :             : 
     312         [ +  + ]:       49268 :         if (expect(NOT_VALUE)) {
     313         [ +  + ]:       24022 :             if (isValueOpen)
     314                 :             :                 return false;
     315                 :       24020 :             clearExpect(NOT_VALUE);
     316                 :             :         }
     317                 :             : 
     318   [ +  +  +  +  :       49266 :         switch (tok) {
             +  +  +  - ]
     319                 :             : 
     320                 :        7074 :         case JTOK_OBJ_OPEN:
     321                 :        7074 :         case JTOK_ARR_OPEN: {
     322         [ +  + ]:        7074 :             VType utyp = (tok == JTOK_OBJ_OPEN ? VOBJ : VARR);
     323   [ -  +  +  + ]:        7074 :             if (!stack.size()) {
     324         [ +  + ]:         130 :                 if (utyp == VOBJ)
     325         [ +  - ]:          59 :                     setObject();
     326                 :             :                 else
     327         [ +  - ]:          71 :                     setArray();
     328         [ +  - ]:         130 :                 stack.push_back(this);
     329                 :             :             } else {
     330                 :        6944 :                 UniValue tmpVal(utyp);
     331                 :        6944 :                 UniValue *top = stack.back();
     332         [ +  - ]:        6944 :                 top->values.push_back(tmpVal);
     333                 :             : 
     334                 :        6944 :                 UniValue *newTop = &(top->values.back());
     335         [ +  - ]:        6944 :                 stack.push_back(newTop);
     336                 :        6944 :             }
     337                 :             : 
     338   [ -  +  +  + ]:        7074 :             if (stack.size() > MAX_JSON_DEPTH)
     339                 :             :                 return false;
     340                 :             : 
     341         [ +  + ]:        7072 :             if (utyp == VOBJ)
     342                 :         384 :                 setExpect(OBJ_NAME);
     343                 :             :             else
     344                 :        6688 :                 setExpect(ARR_VALUE);
     345                 :             :             break;
     346                 :             :             }
     347                 :             : 
     348                 :        6010 :         case JTOK_OBJ_CLOSE:
     349                 :        6010 :         case JTOK_ARR_CLOSE: {
     350   [ -  +  +  -  :        6010 :             if (!stack.size() || (last_tok == JTOK_COMMA))
                   +  + ]
     351                 :             :                 return false;
     352                 :             : 
     353         [ +  + ]:        6008 :             VType utyp = (tok == JTOK_OBJ_CLOSE ? VOBJ : VARR);
     354                 :        6008 :             UniValue *top = stack.back();
     355         [ +  + ]:        6008 :             if (utyp != top->getType())
     356                 :             :                 return false;
     357                 :             : 
     358                 :        6007 :             stack.pop_back();
     359                 :        6007 :             clearExpect(OBJ_NAME);
     360                 :        6007 :             setExpect(NOT_VALUE);
     361                 :        6007 :             break;
     362                 :             :             }
     363                 :             : 
     364                 :        1021 :         case JTOK_COLON: {
     365   [ -  +  +  - ]:        1021 :             if (!stack.size())
     366                 :             :                 return false;
     367                 :             : 
     368                 :        1021 :             UniValue *top = stack.back();
     369         [ +  - ]:        1021 :             if (top->getType() != VOBJ)
     370                 :             :                 return false;
     371                 :             : 
     372                 :        1021 :             setExpect(VALUE);
     373                 :        1021 :             break;
     374                 :             :             }
     375                 :             : 
     376                 :       17022 :         case JTOK_COMMA: {
     377         [ -  + ]:       17022 :             if (!stack.size() ||
     378   [ +  -  +  - ]:       17022 :                 (last_tok == JTOK_COMMA) || (last_tok == JTOK_ARR_OPEN))
     379                 :             :                 return false;
     380                 :             : 
     381                 :       17022 :             UniValue *top = stack.back();
     382         [ +  + ]:       17022 :             if (top->getType() == VOBJ)
     383                 :         658 :                 setExpect(OBJ_NAME);
     384                 :             :             else
     385                 :       16364 :                 setExpect(ARR_VALUE);
     386                 :             :             break;
     387                 :             :             }
     388                 :             : 
     389                 :         276 :         case JTOK_KW_NULL:
     390                 :         276 :         case JTOK_KW_TRUE:
     391                 :         276 :         case JTOK_KW_FALSE: {
     392      [ +  +  + ]:         276 :             UniValue tmpVal;
     393      [ +  +  + ]:         276 :             switch (tok) {
     394                 :             :             case JTOK_KW_NULL:
     395                 :             :                 // do nothing more
     396                 :             :                 break;
     397                 :         128 :             case JTOK_KW_TRUE:
     398         [ +  - ]:         128 :                 tmpVal.setBool(true);
     399                 :             :                 break;
     400                 :         131 :             case JTOK_KW_FALSE:
     401         [ +  - ]:         131 :                 tmpVal.setBool(false);
     402                 :             :                 break;
     403                 :             :             default: /* impossible */ break;
     404                 :             :             }
     405                 :             : 
     406   [ -  +  +  + ]:         276 :             if (!stack.size()) {
     407         [ +  - ]:          11 :                 *this = tmpVal;
     408                 :             :                 break;
     409                 :             :             }
     410                 :             : 
     411                 :         265 :             UniValue *top = stack.back();
     412         [ +  - ]:         265 :             top->values.push_back(tmpVal);
     413                 :             : 
     414                 :         265 :             setExpect(NOT_VALUE);
     415                 :         265 :             break;
     416                 :         276 :             }
     417                 :             : 
     418                 :        1867 :         case JTOK_NUMBER: {
     419         [ -  + ]:        3734 :             UniValue tmpVal(VNUM, tokenVal);
     420   [ -  +  +  + ]:        1867 :             if (!stack.size()) {
     421         [ +  - ]:          17 :                 *this = tmpVal;
     422                 :             :                 break;
     423                 :             :             }
     424                 :             : 
     425                 :        1850 :             UniValue *top = stack.back();
     426         [ +  - ]:        1850 :             top->values.push_back(tmpVal);
     427                 :             : 
     428                 :        1850 :             setExpect(NOT_VALUE);
     429                 :        1850 :             break;
     430                 :        1867 :             }
     431                 :             : 
     432                 :       15996 :         case JTOK_STRING: {
     433         [ +  + ]:       15996 :             if (expect(OBJ_NAME)) {
     434                 :        1023 :                 UniValue *top = stack.back();
     435         [ +  - ]:        1023 :                 top->keys.push_back(tokenVal);
     436                 :        1023 :                 clearExpect(OBJ_NAME);
     437                 :        1023 :                 setExpect(COLON);
     438                 :             :             } else {
     439         [ -  + ]:       29946 :                 UniValue tmpVal(VSTR, tokenVal);
     440   [ -  +  +  + ]:       14973 :                 if (!stack.size()) {
     441         [ +  - ]:           2 :                     *this = tmpVal;
     442                 :           2 :                     break;
     443                 :             :                 }
     444                 :       14971 :                 UniValue *top = stack.back();
     445         [ +  - ]:       14971 :                 top->values.push_back(tmpVal);
     446                 :       14973 :             }
     447                 :             : 
     448                 :       15994 :             setExpect(NOT_VALUE);
     449                 :       15994 :             break;
     450                 :             :             }
     451                 :             : 
     452                 :             :         default:
     453                 :             :             return false;
     454                 :             :         }
     455         [ +  + ]:       49261 :     } while (!stack.empty ());
     456                 :             : 
     457                 :             :     /* Check that nothing follows the initial construct (parsed above).  */
     458         [ +  - ]:         117 :     tok = getJsonToken(tokenVal, consumed, raw, end);
     459         [ +  + ]:         117 :     if (tok != JTOK_NONE)
     460                 :          13 :         return false;
     461                 :             : 
     462                 :             :     return true;
     463                 :         171 : }
     464                 :             : 
        

Generated by: LCOV version 2.0-1