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 % 263 262
Test Date: 2024-11-04 04:45:35 Functions: 100.0 % 4 4
Branches: 79.6 % 265 211

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

Generated by: LCOV version 2.0-1