1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
|
/* packet-thrift.c
* Routines for thrift protocol dissection.
* Based on work by John Song <jsong@facebook.com> and
* Bill Fumerola <bill@facebook.com>
*
* https://github.com/andrewcox/wireshark-with-thrift-plugin/blob/wireshark-1.8.6-with-thrift-plugin/plugins/thrift/packet-thrift.cpp
*
* Copyright 2015, Anders Broman <anders.broman[at]ericsson.com>
* Copyright 2021, Richard van der Hoff <richard[at]matrix.org>
* Copyright 2019-2024, Triton Circonflexe <triton[at]kumal.info>
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
/* Ref https://thrift.apache.org/developers
* https://thrift.apache.org/docs/idl.html
* https://diwakergupta.github.io/thrift-missing-guide/
* https://erikvanoosten.github.io/thrift-missing-specification/
* https://github.com/apache/thrift/blob/master/doc/specs/thrift-compact-protocol.md
*/
#include "config.h"
#include <stdint.h>
#include <epan/packet.h>
#include <epan/prefs.h>
#include <epan/proto_data.h>
#include "packet-tcp.h"
#include "packet-tls.h"
#include "packet-thrift.h"
/* Line 30: Constants and early declarations. */
/* Line 180: Protocol data structure and helper functions. */
/* Line 300: Helper functions to use within custom sub-dissectors. */
/* Line 630: Generic functions to dissect TBinaryProtocol message content. */
/* Line 900: Generic functions to dissect Thrift message header. */
void proto_register_thrift(void);
void proto_reg_handoff_thrift(void);
#define THRIFT_BINARY_VERSION_VALUE_MASK 0x7fff
#define THRIFT_BINARY_VERSION_MASK 0xffff00f8
#define THRIFT_BINARY_MESSAGE_MASK 0x00000007
#define THRIFT_BINARY_VERSION_1 0x80010000
#define THRIFT_COMPACT_VERSION_VALUE_MASK 0x001f
#define THRIFT_COMPACT_VERSION_MASK 0xff1f
#define THRIFT_COMPACT_MESSAGE_MASK 0x00e0
#define THRIFT_COMPACT_VERSION_1 0x8201
#define THRIFT_COMPACT_MESSAGE_SHIFT 5
#define NOT_A_VALID_PDU (0)
#define ABORT_SUBDISSECTION_ON_ISSUE(offset) do { if (offset < 0) return offset; } while (0)
#define ABORT_ON_INCOMPLETE_PDU(len) do {\
if (tvb_reported_length_remaining(tvb, *offset) < (len)) {\
/* Do not indicate the incomplete data if we know the above dissector is able to reassemble. */\
if (pinfo->can_desegment <= 0) \
expert_add_info(pinfo, NULL, &ei_thrift_not_enough_data);\
/* Do not consume more than available for the reassembly to work. */\
thrift_opt->reassembly_offset = *offset;\
thrift_opt->reassembly_length = len;\
*offset = THRIFT_REQUEST_REASSEMBLY;\
return THRIFT_REQUEST_REASSEMBLY;\
} } while (0)
static dissector_handle_t thrift_handle;
static dissector_handle_t thrift_http_handle;
static bool framed_desegment = true;
static unsigned thrift_tls_port;
static bool show_internal_thrift_fields;
static bool try_generic_if_sub_dissector_fails;
static unsigned nested_type_depth = 25;
static dissector_table_t thrift_method_name_dissector_table;
/* TBinaryProtocol elements length. */
static const int TBP_THRIFT_TYPE_LEN = 1;
static const int TBP_THRIFT_FID_LEN = 2;
static const int TBP_THRIFT_BOOL_LEN = 1;
static const int TBP_THRIFT_I8_LEN = 1;
static const int TBP_THRIFT_DOUBLE_LEN = 8;
static const int TBP_THRIFT_I16_LEN = 2;
static const int TBP_THRIFT_I32_LEN = 4;
static const int TBP_THRIFT_I64_LEN = 8;
static const int TBP_THRIFT_UUID_LEN = 16;
static const int TBP_THRIFT_MTYPE_OFFSET = 3;
static const int TBP_THRIFT_MTYPE_LEN = 1;
static const int TBP_THRIFT_VERSION_LEN = 4; /* (Version + method type) is explicitly passed as an int32 in libthrift */
static const int TBP_THRIFT_LENGTH_LEN = 4;
static const int TBP_THRIFT_SEQ_ID_LEN = 4;
static const int TBP_THRIFT_STRICT_HEADER_LEN = 8; /* (Protocol id + Version + Method type) + Name length = (4) + 4. */
/* Old encoding: Name length [ + Name] + Message type + Sequence Identifier + T_STOP */
static const int TBP_THRIFT_MIN_MESSAGE_LEN = 10; /* TBP_THRIFT_LENGTH_LEN + TBP_THRIFT_I8_LEN + TBP_THRIFT_SEQ_ID_LEN + TBP_THRIFT_TYPE_LEN; */
static const int TBP_THRIFT_STRICT_MIN_MESSAGE_LEN = 13; /* TBP_THRIFT_STRICT_HEADER_LEN + TBP_THRIFT_SEQ_ID_LEN + TBP_THRIFT_TYPE_LEN; */
static const int TBP_THRIFT_BINARY_LEN = 4; /* Length (even with empty content). */
static const int TBP_THRIFT_STRUCT_LEN = 1; /* Empty struct still contains T_STOP. */
static const int TBP_THRIFT_LINEAR_LEN = 5; /* Elements type + number of elements for list & set. */
/* TCompactProtocol elements length when different from TBinaryProtocol.
* Are identical:
* - Field Type (although Compact squeezes in the high nibble the field id delta or list/set length).
* - T_BOOL (in linear containers, not structs)
* - T_I8
* - T_DOUBLE (endianness is inverted, though)
*/
static const int TCP_THRIFT_DELTA_NOT_SET;
static const int TCP_THRIFT_LENGTH_LARGER = 0xf;
static const int TCP_THRIFT_MAP_TYPES_LEN = 1; /* High nibble = key type, low nibble = value type. */
static const int TCP_THRIFT_NIBBLE_SHIFT = 4;
static const int TCP_THRIFT_VERSION_LEN = 2; /* Protocol id + (Method type + Version) */
static const int TCP_THRIFT_MIN_VARINT_LEN = 1;
/* Those cannot be define as static const int since they are used within a switch. */
/* Maximum length in bytes for 16, 32, and 64 bits integers encoded as varint. */
#define TCP_THRIFT_MAX_I16_LEN (3)
#define TCP_THRIFT_MAX_I32_LEN (5)
#define TCP_THRIFT_MAX_I64_LEN (10)
static const int TCP_THRIFT_STRUCT_LEN = 1; /* Empty struct still contains T_STOP. */
static const int TCP_THRIFT_MIN_MESSAGE_LEN = 5; /* Protocol id + (Method type + Version) + Name length [+ Name] + Sequence Identifier + T_STOP */
static const uint32_t TCP_THRIFT_NIBBLE_MASK = 0xf;
static const int OCTETS_TO_BITS_SHIFT = 3; /* 8 bits per octets = 3 shifts left. */
static const int DISABLE_SUBTREE = -1;
static int proto_thrift;
static int hf_thrift_frame_length;
static int hf_thrift_protocol_id;
static int hf_thrift_version;
static int hf_thrift_mtype;
static int hf_thrift_str_len;
static int hf_thrift_method;
static int hf_thrift_seq_id;
static int hf_thrift_type;
static int hf_thrift_key_type;
static int hf_thrift_value_type;
static int hf_thrift_compact_struct_type;
static int hf_thrift_fid;
static int hf_thrift_fid_delta;
static int hf_thrift_bool;
static int hf_thrift_i8;
static int hf_thrift_i16;
static int hf_thrift_i32;
static int hf_thrift_i64;
static int hf_thrift_uuid;
static int hf_thrift_binary;
static int hf_thrift_string;
static int hf_thrift_struct;
static int hf_thrift_list;
static int hf_thrift_set;
static int hf_thrift_map;
static int hf_thrift_num_list_item;
static int hf_thrift_num_list_pos;
static int hf_thrift_num_set_item;
static int hf_thrift_num_set_pos;
static int hf_thrift_num_map_item;
static int hf_thrift_large_container;
static int hf_thrift_double;
static int hf_thrift_exception;
static int hf_thrift_exception_message;
static int hf_thrift_exception_type;
static int ett_thrift;
static int ett_thrift_header;
static int ett_thrift_params;
static int ett_thrift_field;
static int ett_thrift_struct;
static int ett_thrift_list;
static int ett_thrift_set;
static int ett_thrift_map;
static int ett_thrift_error; /* Error while reading the header. */
static int ett_thrift_exception; /* ME_THRIFT_T_EXCEPTION */
static expert_field ei_thrift_wrong_type;
static expert_field ei_thrift_wrong_field_id;
static expert_field ei_thrift_negative_length;
static expert_field ei_thrift_wrong_proto_version;
static expert_field ei_thrift_struct_fid_not_in_seq;
static expert_field ei_thrift_frame_too_short;
static expert_field ei_thrift_not_enough_data;
static expert_field ei_thrift_frame_too_long;
static expert_field ei_thrift_varint_too_large;
static expert_field ei_thrift_undefined_field_id;
static expert_field ei_thrift_negative_field_id;
static expert_field ei_thrift_unordered_field_id;
static expert_field ei_thrift_application_exception;
static expert_field ei_thrift_protocol_exception;
static expert_field ei_thrift_too_many_subtypes;
static const thrift_member_t thrift_exception[] = {
{ &hf_thrift_exception_message, 1, true, DE_THRIFT_T_BINARY, NULL, { .encoding = ENC_UTF_8 }, NULL },
{ &hf_thrift_exception_type, 2, false, DE_THRIFT_T_I32, TMFILL },
{ NULL, 0, false, DE_THRIFT_T_STOP, TMFILL }
};
typedef enum {
DE_THRIFT_C_STOP = DE_THRIFT_T_STOP,
DE_THRIFT_C_BOOL_TRUE,
DE_THRIFT_C_BOOL_FALSE,
DE_THRIFT_C_I8,
DE_THRIFT_C_I16,
DE_THRIFT_C_I32,
DE_THRIFT_C_I64,
DE_THRIFT_C_DOUBLE,
DE_THRIFT_C_BINARY,
DE_THRIFT_C_LIST,
DE_THRIFT_C_SET,
DE_THRIFT_C_MAP,
DE_THRIFT_C_STRUCT,
DE_THRIFT_C_UUID,
} thrift_compact_type_enum_t;
typedef struct _thrift_field_header_t {
union {
thrift_type_enum_t binary;
thrift_compact_type_enum_t compact;
} type;
int type_offset;
int64_t field_id;
int fid_offset;
int fid_length;
proto_item *type_pi;
proto_item *fid_pi;
proto_tree *fh_tree;
} thrift_field_header_t;
static const value_string thrift_type_vals[] = {
{ DE_THRIFT_T_STOP, "T_STOP" },
{ DE_THRIFT_T_VOID, "T_VOID" },
{ DE_THRIFT_T_BOOL, "T_BOOL" },
{ DE_THRIFT_T_I8, "T_I8" },
{ DE_THRIFT_T_DOUBLE, "T_DOUBLE" },
{ DE_THRIFT_T_I16, "T_I16" },
{ DE_THRIFT_T_I32, "T_I32" },
{ DE_THRIFT_T_I64, "T_I64" },
{ DE_THRIFT_T_BINARY, "T_BINARY" },
{ DE_THRIFT_T_STRUCT, "T_STRUCT" },
{ DE_THRIFT_T_MAP, "T_MAP" },
{ DE_THRIFT_T_SET, "T_SET" },
{ DE_THRIFT_T_LIST, "T_LIST" },
{ DE_THRIFT_T_UUID, "T_UUID" },
{ 0, NULL }
};
/* type values used within structs in the compact protocol */
static const value_string thrift_compact_type_vals[] = {
{ DE_THRIFT_C_BOOL_TRUE, "BOOLEAN_TRUE" },
{ DE_THRIFT_C_BOOL_FALSE, "BOOLEAN_FALSE" },
{ DE_THRIFT_C_I8, "T_I8" },
{ DE_THRIFT_C_I16, "T_I16" },
{ DE_THRIFT_C_I32, "T_I32" },
{ DE_THRIFT_C_I64, "T_I64" },
{ DE_THRIFT_C_DOUBLE, "T_DOUBLE" },
{ DE_THRIFT_C_BINARY, "T_BINARY" },
{ DE_THRIFT_C_LIST, "T_LIST" },
{ DE_THRIFT_C_SET, "T_SET" },
{ DE_THRIFT_C_MAP, "T_MAP" },
{ DE_THRIFT_C_STRUCT, "T_STRUCT" },
{ DE_THRIFT_C_UUID, "T_UUID" },
{ 0, NULL }
};
static const value_string thrift_exception_type_vals[] = {
{ 0, "Unknown (type of peer)" },
{ 1, "Unknown Method" },
{ 2, "Invalid Message Type" },
{ 3, "Wrong Method Name" },
{ 4, "Bad Sequence Id" },
{ 5, "Missing Result" },
{ 6, "Internal Error" },
{ 7, "Protocol Error (something went wrong during decoding)" },
{ 8, "Invalid Transform" },
{ 9, "Invalid Protocol" },
{ 10, "Unsupported Client Type" },
{ 0, NULL }
};
static const value_string thrift_proto_vals[] = {
{ 0x80, "Strict Binary Protocol" },
{ 0x82, "Compact Protocol" },
{ 0, NULL }
};
static const value_string thrift_mtype_vals[] = {
{ ME_THRIFT_T_CALL, "CALL" },
{ ME_THRIFT_T_REPLY, "REPLY" },
{ ME_THRIFT_T_EXCEPTION, "EXCEPTION" },
{ ME_THRIFT_T_ONEWAY, "ONEWAY" },
{ 0, NULL }
};
/* Options */
#define DECODE_BINARY_AS_AUTO_UTF8 0
#define DECODE_BINARY_AS_BINARY 1
#define DECODE_BINARY_AS_ASCII 2
#define DECODE_BINARY_AS_UTF8 3
#define DECODE_BINARY_AS_UTF16BE 4
#define DECODE_BINARY_AS_UTF16LE 5
#define DECODE_BINARY_AS_UTF32BE 6
#define DECODE_BINARY_AS_UTF32LE 7
static int32_t binary_decode = DECODE_BINARY_AS_AUTO_UTF8;
static const enum_val_t binary_display_options[] = {
{ "auto", "UTF-8 if printable", DECODE_BINARY_AS_AUTO_UTF8 },
{ "hexadecimal", "Binary (hexadecimal string)", DECODE_BINARY_AS_BINARY },
{ "ascii", "ASCII String", DECODE_BINARY_AS_ASCII },
{ "utf8", "UTF-8 String", DECODE_BINARY_AS_UTF8 },
{ "utf16be", "UTF-16 Big Endian", DECODE_BINARY_AS_UTF16BE },
{ "utf16le", "UTF-16 Little Endian", DECODE_BINARY_AS_UTF16LE },
{ "utf32be", "UTF-32 Big Endian", DECODE_BINARY_AS_UTF32BE },
{ "utf32le", "UTF-32 Little Endian", DECODE_BINARY_AS_UTF32LE },
{ NULL, NULL, -1 }
};
static int dissect_thrift_binary_type(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt, proto_tree *header_tree, int type, proto_item *type_pi);
static int dissect_thrift_compact_type(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt, proto_tree *header_tree, int type, proto_item *type_pi);
static int dissect_thrift_t_struct_expert(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, int ett_id, const thrift_member_t *seq, expert_field* ei);
/*=====BEGIN GENERIC HELPERS=====*/
/* Check that the 4-byte value match a Thrift Strict TBinaryProtocol version
* - 0x8001 The version itself
* - 0x?? An undetermined byte (not used)
* - 0x0m The method type between 1 and 4.
* Values above 4 will be accepted if ignore_msg_type is true.
*/
static bool
is_thrift_strict_version(uint32_t header, bool ignore_msg_type)
{
int msg_type;
if ((header & THRIFT_BINARY_VERSION_MASK) == THRIFT_BINARY_VERSION_1) {
if (ignore_msg_type) {
return true;
}
msg_type = (header & THRIFT_BINARY_MESSAGE_MASK);
if ((ME_THRIFT_T_CALL <= msg_type) && (msg_type <= ME_THRIFT_T_ONEWAY)) {
return true;
}
}
return false;
}
/* Check that the 2-byte value match a Thrift TCompactProtocol version
* - 0x82 The protocol id.
* - 0bmmmvvvvv The method on the 3 MSbits and version on the 5 LSbits.
*/
static bool
is_thrift_compact_version(uint16_t header, bool ignore_msg_type)
{
int msg_type;
if ((header & THRIFT_COMPACT_VERSION_MASK) == THRIFT_COMPACT_VERSION_1) {
if (ignore_msg_type) {
return true;
}
msg_type = (header & THRIFT_COMPACT_MESSAGE_MASK) >> THRIFT_COMPACT_MESSAGE_SHIFT;
if ((ME_THRIFT_T_CALL <= msg_type) && (msg_type <= ME_THRIFT_T_ONEWAY)) {
return true;
}
}
return false;
}
/*
* Check that the string at the designed position is valid UTF-8.
* This allows us to fail early if the length of the string seems very long.
* This /can/ indicate that this packet does not contain a Thrift PDU.
*
* This method does /NOT/ check if the data is available, the caller must check that if needed.
* - Heuristic for method name must check for captured length.
* - Check UTF-8 vs. binary before adding to tree must check for reported length.
*/
static int
thrift_binary_utf8_isprint(tvbuff_t *tvb, int offset, int max_len, bool accept_crlf)
{
int check_len = tvb_reported_length_remaining(tvb, offset);
int pos, remaining = 0; /* position in tvb, remaining bytes for multi-byte characters. */
uint8_t min_next = 0x80, max_next = 0xBF;
bool ended = false;
int printable_len = 0; /* In case the string ends with several NUL bytes. */
if (max_len < check_len) {
check_len = max_len;
}
for (pos = offset; pos < offset + check_len; pos++) {
uint8_t current = tvb_get_uint8(tvb, pos);
if (ended) {
if (current != 0) {
return -1;
}
} else if (remaining == 0) {
/* We are at the beginning of a character. */
if (current == 0) {
ended = true;
continue; /* Avoid counting this NUL byte as printable. */
} else if ((current & 0x80) == 0) {
if (!g_ascii_isprint(current)) {
if (!accept_crlf) {
/* New line and chariot return or not valid in the method name */
return -1;
}
if (current != '\r' && current != '\n') {
/* But would have been acceptable for data content */
return -1;
}
}
} else if ((current & 0xE0) == 0xC0) {
/* 2 bytes code 8 to 11 bits */
if (current >= 0xC2) {
remaining = 1;
min_next = 0x80;
} else {
/* Overlong encoding of ASCII for C0 and C1. */
return -1;
}
} else if ((current & 0xF0) == 0xE0) {
/* 3 bytes code 12 to 16 bits */
remaining = 2;
if (current == 0xE0) {
min_next = 0xA0; /* 0b101x xxxx to code at least 12 bits. */
} else {
if (current == 0xED) {
/* Reject reserved UTF-16 surrogates as specified for UTF-8. */
max_next = 0x9F;
}
min_next = 0x80;
}
} else if ((current & 0xF8) == 0xF0) {
/* 4 bytes code 17 to 21 bits */
remaining = 3;
if (current == 0xF0) {
min_next = 0x90; /* 0b1001 xxxx to code at least 17 bits. */
} else if (current > 0xF4) {
/* Invalid leading byte (above U+10FFFF). */
return -1;
} else {
min_next = 0x80;
}
} else {
/* Not the beginning of an UTF-8 character. */
return -1;
}
++printable_len;
} else {
if ((current < min_next) || (max_next < current)) {
/* Not a canonical UTF-8 character continuation. */
return -1;
}
min_next = 0x80;
max_next = 0xBF;
--remaining;
++printable_len;
}
}
return printable_len;
}
/** Simple wrapper around tvb_get_varint to handle reassembly.
*
* @param[in] tvb Pointer to the tvbuff_t holding the captured data.
* @param[in] pinfo Pointer to the packet_info holding information about the currently dissected packet.
* @param[in] tree Pointer to the proto_tree used to hold the display tree in Wireshark's interface.
* @param[in] offset Offset from the beginning of the tvbuff_t where the Thrift field is. Function will dissect type, id, & data.
* @param[in] max_length The expected maximum encoding length of the integer.
* @param[in] value If parsing succeeds, parsed varint will be stored here.
* @param[in] encoding The ENC_* that defines the format (e.g., ENC_VARINT_PROTOBUF or ENC_VARINT_ZIGZAG).
*
* @return THRIFT_REQUEST_REASSEMBLY(-1) if reassembly is necessary,
* 0 in case of error,
* a positive value indicating the length of the varint otherwise.
*/
static int
thrift_get_varint_enc(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, int max_length, uint64_t *value, const unsigned encoding)
{
unsigned length;
int readable = tvb_reported_length_remaining(tvb, offset);
if (readable <= 0) {
return THRIFT_REQUEST_REASSEMBLY;
}
if (readable > TCP_THRIFT_MAX_I64_LEN) {
readable = TCP_THRIFT_MAX_I64_LEN;
}
length = tvb_get_varint(tvb, offset, readable, value, encoding);
if (length == 0) {
if (readable < max_length) {
/* There was not enough data to ensure the varint is complete for the expected size of integer. */
return THRIFT_REQUEST_REASSEMBLY;
} else {
/* Either an error on the wire or a sub-optimal encoding, we always consider it as an error. */
proto_tree_add_expert(tree, pinfo, &ei_thrift_varint_too_large, tvb, offset, max_length);
}
}
return length;
}
static bool
is_thrift_compact_bool_type(thrift_compact_type_enum_t type)
{
return type == DE_THRIFT_C_BOOL_TRUE || type == DE_THRIFT_C_BOOL_FALSE;
}
/* Function that reads the field header and return all associated data.
*
* @param[in] tvb: Pointer to the tvbuff_t holding the captured data.
* @param[in] pinfo: Pointer to the packet_info holding information about the currently dissected packet.
* @param[in] tree: Pointer to the proto_tree used to hold the display tree in Wireshark's interface.
* The caller may set it to NULL to prevent the creation of the field header sub-tree.
* This possibility is used by sub-dissector when show_internal_thrift_fields is false,
* and by dissect_thrift_common to differentiate between successful and exception T_REPLY.
* @param[in] offset: Offset from the beginning of the tvbuff_t where the Thrift field is. Function will dissect type, id, & data.
* @param[in] thrift_opt: Options from the Thrift dissector that will be necessary for sub-dissection (binary vs. compact, ...)
* @param[in] gen_bool: Generate item when one of the boolean types is encountered.
*
* @return See "GENERIC DISSECTION PARAMETERS DOCUMENTATION".
*/
static int
dissect_thrift_field_header(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt, thrift_field_header_t *header, bool gen_bool)
{
/*
* Binary protocol field header (3 bytes):
* +--------+--------+--------+
* |0000tttt| field id |
* +--------+--------+--------+
*
* Compact protocol field header (1 byte, short form):
* +--------+
* |ddddtttt|
* +--------+
*
* Compact protocol field header (2 to 4 bytes, long form):
* +--------+--------+...+--------+
* |0000tttt| field id |
* +--------+--------+...+--------+
*
* Binary & Compact protocol stop field (1 byte):
* +--------+
* |00000000|
* +--------+
*
* Where:
* 'dddd' is the field id delta, a strictly positive unsigned 4 bits integer.
* 'tttt' is the type of the field value, an unsigned 4 bits strictly positive integer.
* field id is the numerical value of the field in the structure.
*/
DISSECTOR_ASSERT(header != NULL);
ABORT_SUBDISSECTION_ON_ISSUE(*offset); /* In case of sub-dissection functions. */
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_TYPE_LEN); /* In all dissection cases. */
uint8_t dfid_type = tvb_get_uint8(tvb, *offset);
int32_t delta = TCP_THRIFT_DELTA_NOT_SET;
int64_t fid = 0;
memset(header, 0, sizeof(thrift_field_header_t));
/* Read type (and delta for Compact) */
header->type_offset = *offset;
*offset += TBP_THRIFT_TYPE_LEN;
if (dfid_type == DE_THRIFT_T_STOP) {
header->type.binary = (thrift_type_enum_t)dfid_type;
/* No need for sub-tree in this case. */
header->type_pi = proto_tree_add_item(tree, hf_thrift_type, tvb, header->type_offset, TBP_THRIFT_TYPE_LEN, ENC_BIG_ENDIAN);
return *offset;
}
/* Read the field id */
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
header->type.compact = (thrift_compact_type_enum_t)(dfid_type & TCP_THRIFT_NIBBLE_MASK);
delta = (dfid_type >> TCP_THRIFT_NIBBLE_SHIFT) & TCP_THRIFT_NIBBLE_MASK;
if (delta == TCP_THRIFT_DELTA_NOT_SET) {
header->fid_offset = *offset;
header->fid_length = thrift_get_varint_enc(tvb, pinfo, NULL, *offset, TCP_THRIFT_MAX_I16_LEN, &fid, ENC_VARINT_ZIGZAG);
switch (header->fid_length) {
case THRIFT_REQUEST_REASSEMBLY:
/* Will always return after setting the expert parts. */
ABORT_ON_INCOMPLETE_PDU(TCP_THRIFT_MAX_I16_LEN);
return THRIFT_REQUEST_REASSEMBLY; // Just to avoid a false positive warning.
case 0: /* In case of error, the offset stay at the error position. */
default:
header->field_id = fid;
*offset += header->fid_length;
break;
}
} else {
/* The field id data in the tvb is represented by the delta with the type. */
header->field_id = thrift_opt->previous_field_id + delta;
header->fid_offset = header->type_offset;
header->fid_length = TBP_THRIFT_TYPE_LEN;
}
} else {
/* Fixed size field id for Binary protocol. */
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_FID_LEN);
header->type.binary = (thrift_type_enum_t)dfid_type;
header->field_id = tvb_get_ntohis(tvb, *offset);
header->fid_offset = *offset;
header->fid_length = TBP_THRIFT_FID_LEN;
*offset += TBP_THRIFT_FID_LEN;
}
/* Create the field header sub-tree if requested only. */
if (tree != NULL) {
unsigned nested_count = p_get_proto_depth(pinfo, proto_thrift);
if (nested_count >= thrift_opt->nested_type_depth) {
expert_add_info(pinfo, proto_tree_get_parent(tree), &ei_thrift_too_many_subtypes);
return THRIFT_REQUEST_REASSEMBLY;
}
header->fh_tree = proto_tree_add_subtree_format(tree, tvb, header->type_offset, *offset - header->type_offset, ett_thrift_field, NULL,
"Field Header #%" PRId64, header->field_id);
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
header->type_pi = proto_tree_add_bits_item(header->fh_tree, hf_thrift_compact_struct_type, tvb, (header->type_offset << OCTETS_TO_BITS_SHIFT) + TCP_THRIFT_NIBBLE_SHIFT, TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
header->fid_pi = proto_tree_add_bits_item(header->fh_tree, hf_thrift_fid_delta, tvb, header->type_offset << OCTETS_TO_BITS_SHIFT, TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
if (delta == TCP_THRIFT_DELTA_NOT_SET) {
proto_item_append_text(header->fid_pi, " (Not Set)");
}
if (gen_bool && is_thrift_compact_bool_type(header->type.compact)) {
proto_item *bool_item = proto_tree_add_boolean(tree, hf_thrift_bool, tvb, header->type_offset, TBP_THRIFT_TYPE_LEN, 2 - header->type.compact);
proto_item_set_generated(bool_item);
}
if (gen_bool && is_thrift_compact_bool_type(header->type.compact)) {
proto_item *bool_item = proto_tree_add_boolean(tree, hf_thrift_bool, tvb, header->type_offset, TBP_THRIFT_TYPE_LEN, 2 - header->type.compact);
proto_item_set_generated(bool_item);
}
} else {
header->type_pi = proto_tree_add_item(header->fh_tree, hf_thrift_type, tvb, header->type_offset, TBP_THRIFT_TYPE_LEN, ENC_BIG_ENDIAN);
}
if (delta == TCP_THRIFT_DELTA_NOT_SET) {
if (header->fid_length > 0) {
header->fid_pi = proto_tree_add_item(header->fh_tree, hf_thrift_fid, tvb, header->fid_offset, header->fid_length, ENC_BIG_ENDIAN);
} else {
/* Varint for field id was too long to decode, handle the error in the sub-tree. */
proto_tree_add_expert(header->fh_tree, pinfo, &ei_thrift_varint_too_large, tvb, header->fid_offset, TCP_THRIFT_MAX_I16_LEN);
return THRIFT_REQUEST_REASSEMBLY;
}
} else {
if ((int64_t)INT16_MIN > header->field_id || header->field_id > (int64_t)INT16_MAX) {
header->fid_pi = proto_tree_add_int64(header->fh_tree, hf_thrift_i64, tvb, header->fid_offset, header->fid_length, header->field_id);
expert_add_info(pinfo, header->fid_pi, &ei_thrift_varint_too_large);
/* We continue anyway as the field id was displayed successfully. */
} else {
header->fid_pi = proto_tree_add_int(header->fh_tree, hf_thrift_fid, tvb, header->fid_offset, header->fid_length, (int16_t)header->field_id);
}
proto_item_set_generated(header->fid_pi);
}
/* When reading a successful T_REPLY, we always have
* - previous_field_id == 0 because we are at the beginning of a structure, and
* - header->field_id == 0 because it is the return value
* so we need to ignore this case. */
if (header->field_id < thrift_opt->previous_field_id || (header->field_id == thrift_opt->previous_field_id && thrift_opt->previous_field_id != 0)) {
if (thrift_opt->previous_field_id == 0) {
// Maybe an old application from when negative values were authorized.
expert_add_info(pinfo, header->fid_pi, &ei_thrift_negative_field_id);
} else {
// Although not mandated by Thrift protocol, applications should send fields in numerical order.
expert_add_info(pinfo, header->fid_pi, &ei_thrift_unordered_field_id);
}
}
} else {
/* The fid_pi value (proto_item for field_id) is required for sub-dissectors.
* Create it even in the absence of tree. */
if (delta == TCP_THRIFT_DELTA_NOT_SET) {
if (header->fid_length > 0) {
header->fid_pi = proto_tree_add_item(header->fh_tree, hf_thrift_fid, tvb, header->fid_offset, header->fid_length, ENC_BIG_ENDIAN);
} else {
/* Varint for field id was too long to decode, handle the error without the sub-tree. */
proto_tree_add_expert(tree, pinfo, &ei_thrift_varint_too_large, tvb, header->fid_offset, TCP_THRIFT_MAX_I16_LEN);
return THRIFT_REQUEST_REASSEMBLY;
}
} else {
if ((int64_t)INT16_MIN > header->field_id || header->field_id > (int64_t)INT16_MAX) {
header->fid_pi = proto_tree_add_int64(header->fh_tree, hf_thrift_i64, tvb, header->fid_offset, header->fid_length, header->field_id);
expert_add_info(pinfo, header->fid_pi, &ei_thrift_varint_too_large);
/* We continue anyway as the field id was displayed successfully. */
} else {
header->fid_pi = proto_tree_add_int(header->fh_tree, hf_thrift_fid, tvb, header->fid_offset, header->fid_length, (int16_t)header->field_id);
}
proto_item_set_generated(header->fid_pi);
}
}
return *offset;
}
/* Dissect a varint and add it to the display tree with the requested hf_id.
* This function is used by both generic compact dissector and sub-dissector.
*
* @param[in] tvb: Pointer to the tvbuff_t holding the captured data.
* @param[in] pinfo: Pointer to the packet_info holding information about the currently dissected packet.
* @param[in] tree: Pointer to the proto_tree used to hold the display tree in Wireshark's interface.
* @param[in,out] offset: Pointer to the offset from the beginning of the tvbuff_t where the Thrift field is. Function will dissect only the data.
* The offset is modified according to table in "GENERIC DISSECTION PARAMETERS DOCUMENTATION" section.
* @param[in] thrift_opt: Options from the Thrift dissector that will be necessary for sub-dissection (binary vs. compact, ...)
*
* @param[in] max_length: Expected maximum length of the data that encodes the integer.
* This is only used to check if reassembly is necessary as with enough data and sub-optimal encoding,
* this function will happily dissect the value anyway.
* @param[in] hf_id: The hf_id that needs to be used for the display.
* If the found integer is larger that the expected integer size (driven by max_length parameter),
* the integer will always be displayed as a generic T_I64 and an expert info will be added.
* @param[in] raw_dissector Dissector for raw integer (we need to create a tvbuff_t with the flatten integer.
*
* @return See "GENERIC DISSECTION PARAMETERS DOCUMENTATION".
*/
static int
dissect_thrift_varint(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt, int max_length, int hf_id, dissector_t raw_dissector)
{
int64_t varint;
proto_item *pi;
int length = thrift_get_varint_enc(tvb, pinfo, tree, *offset, max_length, &varint, ENC_VARINT_ZIGZAG);
switch (length) {
case THRIFT_REQUEST_REASSEMBLY:
/* Will always return after setting the expert parts. */
ABORT_ON_INCOMPLETE_PDU(max_length);
return THRIFT_REQUEST_REASSEMBLY; // Just to avoid a false positive warning.
case 0:
/* In case of error, the offset stay at the error position. */
return THRIFT_REQUEST_REASSEMBLY;
default:
switch (max_length) {
case TCP_THRIFT_MAX_I16_LEN:
if ((int64_t)INT16_MIN > varint || varint > (int64_t)INT16_MAX) {
pi = proto_tree_add_int64(tree, hf_thrift_i64, tvb, *offset, length, varint);
expert_add_info(pinfo, pi, &ei_thrift_varint_too_large);
/* We continue anyway as the varint was indeed decoded. */
} else {
if (raw_dissector != NULL) {
uint8_t *data = wmem_alloc(wmem_packet_scope(), TBP_THRIFT_I16_LEN);
data[0] = (varint >> 8) & 0xFF;
data[1] = varint & 0xFF;
tvbuff_t* sub_tvb = tvb_new_child_real_data(tvb, data, TBP_THRIFT_I16_LEN, TBP_THRIFT_I16_LEN);
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
proto_tree_add_int(tree, hf_id, tvb, *offset, length, (int16_t)varint);
}
}
break;
case TCP_THRIFT_MAX_I32_LEN:
if ((int64_t)INT32_MIN > varint || varint > (int64_t)INT32_MAX) {
pi = proto_tree_add_int64(tree, hf_thrift_i64, tvb, *offset, length, varint);
expert_add_info(pinfo, pi, &ei_thrift_varint_too_large);
/* We continue anyway as the varint was indeed decoded. */
} else {
if (raw_dissector != NULL) {
uint8_t *data = wmem_alloc(wmem_packet_scope(), TBP_THRIFT_I32_LEN);
data[0] = (varint >> 24) & 0xFF;
data[1] = (varint >> 16) & 0xFF;
data[2] = (varint >> 8) & 0xFF;
data[3] = varint & 0xFF;
tvbuff_t* sub_tvb = tvb_new_child_real_data(tvb, data, TBP_THRIFT_I32_LEN, TBP_THRIFT_I32_LEN);
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
proto_tree_add_int(tree, hf_id, tvb, *offset, length, (int32_t)varint);
}
}
break;
case TCP_THRIFT_MAX_I64_LEN:
default:
if (raw_dissector != NULL) {
uint8_t *data = wmem_alloc(wmem_packet_scope(), TBP_THRIFT_I64_LEN);
data[0] = (varint >> 56) & 0xFF;
data[1] = (varint >> 48) & 0xFF;
data[2] = (varint >> 40) & 0xFF;
data[3] = (varint >> 32) & 0xFF;
data[4] = (varint >> 24) & 0xFF;
data[5] = (varint >> 16) & 0xFF;
data[6] = (varint >> 8) & 0xFF;
data[7] = varint & 0xFF;
tvbuff_t* sub_tvb = tvb_new_child_real_data(tvb, data, TBP_THRIFT_I64_LEN, TBP_THRIFT_I64_LEN);
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
proto_tree_add_int64(tree, hf_id, tvb, *offset, length, varint);
}
break;
}
*offset += length;
break;
}
return *offset;
}
/* Common function used by both Binary and Compact generic dissectors to dissect T_BINARY fields
* as requested in the dissector preferences.
* This function only dissects the data, not the field header nor the length.
*/
static int
dissect_thrift_string_as_preferred(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt, int str_len)
{
ABORT_ON_INCOMPLETE_PDU(str_len); /* Thrift assumes there will never be binary/string >= 2GiB */
if (tree) {
switch (binary_decode) {
case DECODE_BINARY_AS_UTF32LE:
proto_tree_add_item(tree, hf_thrift_string, tvb, *offset, str_len, ENC_UCS_4 | ENC_LITTLE_ENDIAN);
break;
case DECODE_BINARY_AS_UTF32BE:
proto_tree_add_item(tree, hf_thrift_string, tvb, *offset, str_len, ENC_UCS_4 | ENC_BIG_ENDIAN);
break;
case DECODE_BINARY_AS_UTF16LE:
proto_tree_add_item(tree, hf_thrift_string, tvb, *offset, str_len, ENC_UTF_16 | ENC_LITTLE_ENDIAN);
break;
case DECODE_BINARY_AS_UTF16BE:
proto_tree_add_item(tree, hf_thrift_string, tvb, *offset, str_len, ENC_UTF_16 | ENC_BIG_ENDIAN);
break;
case DECODE_BINARY_AS_UTF8:
proto_tree_add_item(tree, hf_thrift_string, tvb, *offset, str_len, ENC_UTF_8);
break;
case DECODE_BINARY_AS_ASCII:
proto_tree_add_item(tree, hf_thrift_string, tvb, *offset, str_len, ENC_ASCII);
break;
case DECODE_BINARY_AS_AUTO_UTF8:
/* When there is no data at all, consider it a string
* but a buffer containing only NUL bytes is a binary.
* If not entirely captured, consider it as a binary. */
if (tvb_captured_length_remaining(tvb, *offset) >= str_len &&
(str_len == 0 || thrift_binary_utf8_isprint(tvb, *offset, str_len, true) > 0)) {
proto_tree_add_item(tree, hf_thrift_string, tvb, *offset, str_len, ENC_UTF_8);
break;
}
/* otherwise, continue with type BINARY */
/* FALL THROUGH */
case DECODE_BINARY_AS_BINARY:
default:
proto_tree_add_item(tree, hf_thrift_binary, tvb, *offset, str_len, ENC_NA);
break;
}
}
*offset += str_len;
return *offset;
}
// Converts the type value in TCompactProtocol to the equivalent standard
// value from TBinaryProtocol.
static thrift_type_enum_t
compact_struct_type_to_generic_type(thrift_compact_type_enum_t compact)
{
switch (compact) {
case DE_THRIFT_C_STOP:
return DE_THRIFT_T_STOP;
case DE_THRIFT_C_BOOL_TRUE:
case DE_THRIFT_C_BOOL_FALSE:
return DE_THRIFT_T_BOOL;
case DE_THRIFT_C_I8:
return DE_THRIFT_T_I8;
case DE_THRIFT_C_I16:
return DE_THRIFT_T_I16;
case DE_THRIFT_C_I32:
return DE_THRIFT_T_I32;
case DE_THRIFT_C_I64:
return DE_THRIFT_T_I64;
case DE_THRIFT_C_DOUBLE:
return DE_THRIFT_T_DOUBLE;
case DE_THRIFT_C_BINARY:
return DE_THRIFT_T_BINARY;
case DE_THRIFT_C_LIST:
return DE_THRIFT_T_LIST;
case DE_THRIFT_C_SET:
return DE_THRIFT_T_SET;
case DE_THRIFT_C_MAP:
return DE_THRIFT_T_MAP;
case DE_THRIFT_C_STRUCT:
return DE_THRIFT_T_STRUCT;
case DE_THRIFT_C_UUID:
return DE_THRIFT_T_UUID;
default:
return DE_THRIFT_T_VOID;
}
}
/*=====END GENERIC HELPERS=====*/
/*=====BEGIN SUB-DISSECTION=====*/
/*
* Helper functions to use within custom sub-dissectors.
*
* Behavior:
* 1. If is_field is true, dissect the field header (field type + field id).
* 1.a. Check the type in the PDU against the expected one according to the call.
* 2. If requested, add the type and field id to the tree (internal thrift fields).
* 3. Dissect the value of the field.
*
* Return the offset marking the end of the dissected value or a negative error code.
* See packet-thrift.h for details.
*/
/*
* See packet-thrift.h for parameters documentation of dissect_thrift_t_<type> functions.
*/
int
dissect_thrift_t_stop(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset)
{
ABORT_SUBDISSECTION_ON_ISSUE(offset);
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_TYPE_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
if (tvb_get_uint8(tvb, offset) != DE_THRIFT_T_STOP) {
proto_tree_add_expert(tree, pinfo, &ei_thrift_wrong_type, tvb, offset, TBP_THRIFT_TYPE_LEN);
return THRIFT_SUBDISSECTOR_ERROR;
}
if (show_internal_thrift_fields) {
proto_tree_add_item(tree, hf_thrift_type, tvb, offset, TBP_THRIFT_TYPE_LEN, ENC_BIG_ENDIAN);
}
offset += TBP_THRIFT_TYPE_LEN;
return offset;
}
/* Common function used by all sub-dissection functions to handle the field header dissection as well as the display.
*
* @param[in] tvb: Pointer to the tvbuff_t holding the captured data.
* @param[in] pinfo: Pointer to the packet_info holding information about the currently dissected packet.
* @param[in] tree: Pointer to the proto_tree used to hold the display tree in Wireshark's interface.
* @param[in] offset: Offset from the beginning of the tvbuff_t where the Thrift field is. Function will dissect type, id, & data.
* @param[in] thrift_opt: Options from the Thrift dissector that will be necessary for sub-dissection (binary vs. compact, ...)
*
* @param[in] expected: The type expected by the caller sub-dissector.
* Note: the generic type is used even in case of compact dissection.
*
* @param[in] field_id: Thrift field identifier, to check that the right field is being dissected (in case of optional fields).
*
* @param[out] header_tree: Optional pointer to a proto_tree pointer.
* If not NULL, the field header sub-tree will be set in this variable.
* Used by binary/string sub-dissector to put the length in this field header as well.
*
* @return Offset of the first non-dissected byte in case of success,
* THRIFT_REQUEST_REASSEMBLY (-1) in case reassembly is required, or
* THRIFT_SUBDISSECTOR_ERROR (-2) in case of error.
*/
static int
dissect_thrift_t_field_header(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, thrift_type_enum_t expected, int field_id, proto_tree **header_tree)
{
thrift_field_header_t field_header;
proto_tree *internal_tree = NULL;
thrift_type_enum_t generic_type;
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
if (show_internal_thrift_fields) {
internal_tree = tree;
}
/* Read the entire field header using the dedicated function. */
if (dissect_thrift_field_header(tvb, pinfo, internal_tree, &offset, thrift_opt, &field_header, false) == THRIFT_REQUEST_REASSEMBLY) {
if (offset == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
} else {
return THRIFT_SUBDISSECTOR_ERROR;
}
}
/* Check the type first. */
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
generic_type = compact_struct_type_to_generic_type(field_header.type.compact);
} else {
generic_type = field_header.type.binary;
}
if (generic_type != expected) {
proto_tree_add_expert_format(tree, pinfo, &ei_thrift_wrong_type, tvb, offset, TBP_THRIFT_TYPE_LEN,
"Sub-dissector expects type = %s, found %s.",
val_to_str(expected, thrift_type_vals, "%02x"),
val_to_str(generic_type, thrift_type_vals, "%02x"));
return THRIFT_SUBDISSECTOR_ERROR;
}
/* Once we know it's the expected type (which is /not/ T_STOP), we can read the field id. */
if (field_header.field_id != (int64_t)field_id) {
expert_add_info_format(pinfo, field_header.fid_pi, &ei_thrift_wrong_field_id,
"Sub-dissector expects field id = %d, found %" PRId64 " instead.", field_id, field_header.field_id);
}
/* Expose the field header sub-tree if requested. */
if (header_tree != NULL) {
*header_tree = field_header.fh_tree;
}
return offset;
}
static int
dissect_thrift_raw_bool(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, dissector_t raw_dissector)
{
int dt_offset = offset;
bool bool_val = false;
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
ABORT_SUBDISSECTION_ON_ISSUE(offset);
thrift_opt->use_std_dissector = true;
if (is_field) {
/* In case of Compact protocol struct field (or command parameter / return value),
* the boolean type also indicates the boolean value. */
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
/* Read value in type nibble. */
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_TYPE_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
if (((tvb_get_uint8(tvb, offset) >> TCP_THRIFT_NIBBLE_SHIFT) & TCP_THRIFT_NIBBLE_MASK) == DE_THRIFT_C_BOOL_TRUE) {
bool_val = true;
}
/* If we have neither DE_THRIFT_C_BOOL_TRUE nor DE_THRIFT_C_BOOL_FALSE as the type,
* dissect_thrift_t_field_header will catch the issue anyway. */
}
offset = dissect_thrift_t_field_header(tvb, pinfo, tree, offset, thrift_opt, DE_THRIFT_T_BOOL, field_id, NULL);
ABORT_SUBDISSECTION_ON_ISSUE(offset);
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
/* It is the responsibility of the sub-dissector to only use the least significant bit. */
if (raw_dissector != NULL) {
tvbuff_t* sub_tvb = tvb_new_subset_length(tvb, offset, TBP_THRIFT_BOOL_LEN);
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
/* The value must be in the top-level tree, /after/ the field header tree. */
proto_item *pi = proto_tree_add_boolean(tree, hf_id, tvb, dt_offset, TBP_THRIFT_TYPE_LEN, bool_val);
proto_item_set_generated(pi);
}
return offset;
}
}
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_BOOL_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
/* Either in a list/set/map or in a Binary protocol encoding. */
if (raw_dissector != NULL) {
tvbuff_t* sub_tvb = tvb_new_subset_length(tvb, offset, TBP_THRIFT_BOOL_LEN);
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
proto_tree_add_item(tree, hf_id, tvb, offset, TBP_THRIFT_BOOL_LEN, ENC_BIG_ENDIAN);
}
offset += TBP_THRIFT_BOOL_LEN;
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
return offset;
}
int
dissect_thrift_t_bool(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id)
{
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
return dissect_thrift_raw_bool(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, NULL);
}
static int
dissect_thrift_raw_i8(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, dissector_t raw_dissector)
{
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
if (is_field) {
offset = dissect_thrift_t_field_header(tvb, pinfo, tree, offset, thrift_opt, DE_THRIFT_T_I8, field_id, NULL);
}
ABORT_SUBDISSECTION_ON_ISSUE(offset);
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_I8_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
thrift_opt->use_std_dissector = true;
/* Compact protocol does not use varint for T_I8 as it would be counter-productive. */
if (raw_dissector != NULL) {
tvbuff_t* sub_tvb = tvb_new_subset_length(tvb, offset, TBP_THRIFT_I8_LEN);
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
proto_tree_add_item(tree, hf_id, tvb, offset, TBP_THRIFT_I8_LEN, ENC_BIG_ENDIAN);
}
offset += TBP_THRIFT_I8_LEN;
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
return offset;
}
int
dissect_thrift_t_i8(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id)
{
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
return dissect_thrift_raw_i8(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, NULL);
}
static int
dissect_thrift_raw_i16(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, dissector_t raw_dissector)
{
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
if (is_field) {
offset = dissect_thrift_t_field_header(tvb, pinfo, tree, offset, thrift_opt, DE_THRIFT_T_I16, field_id, NULL);
}
ABORT_SUBDISSECTION_ON_ISSUE(offset);
thrift_opt->use_std_dissector = true;
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
int result = dissect_thrift_varint(tvb, pinfo, tree, &offset, thrift_opt, TCP_THRIFT_MAX_I16_LEN, hf_id, raw_dissector);
if (result == THRIFT_REQUEST_REASSEMBLY) {
if (offset == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
} else {
return THRIFT_SUBDISSECTOR_ERROR;
}
}
} else if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_I16_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
} else {
if (raw_dissector != NULL) {
tvbuff_t* sub_tvb = tvb_new_subset_length(tvb, offset, TBP_THRIFT_I16_LEN);
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
proto_tree_add_item(tree, hf_id, tvb, offset, TBP_THRIFT_I16_LEN, ENC_BIG_ENDIAN);
}
offset += TBP_THRIFT_I16_LEN;
}
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
return offset;
}
int
dissect_thrift_t_i16(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id)
{
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
return dissect_thrift_raw_i16(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, NULL);
}
static int
dissect_thrift_raw_i32(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, dissector_t raw_dissector)
{
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
if (is_field) {
offset = dissect_thrift_t_field_header(tvb, pinfo, tree, offset, thrift_opt, DE_THRIFT_T_I32, field_id, NULL);
}
ABORT_SUBDISSECTION_ON_ISSUE(offset);
thrift_opt->use_std_dissector = true;
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
int result = dissect_thrift_varint(tvb, pinfo, tree, &offset, thrift_opt, TCP_THRIFT_MAX_I32_LEN, hf_id, raw_dissector);
if (result == THRIFT_REQUEST_REASSEMBLY) {
if (offset == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
} else {
return THRIFT_SUBDISSECTOR_ERROR;
}
}
} else if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_I32_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
} else {
if (raw_dissector != NULL) {
tvbuff_t* sub_tvb = tvb_new_subset_length(tvb, offset, TBP_THRIFT_I32_LEN);
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
proto_tree_add_item(tree, hf_id, tvb, offset, TBP_THRIFT_I32_LEN, ENC_BIG_ENDIAN);
}
offset += TBP_THRIFT_I32_LEN;
}
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
return offset;
}
int
dissect_thrift_t_i32(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id)
{
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
return dissect_thrift_raw_i32(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, NULL);
}
static int
dissect_thrift_raw_i64(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, dissector_t raw_dissector)
{
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
if (is_field) {
offset = dissect_thrift_t_field_header(tvb, pinfo, tree, offset, thrift_opt, DE_THRIFT_T_I64, field_id, NULL);
}
ABORT_SUBDISSECTION_ON_ISSUE(offset);
thrift_opt->use_std_dissector = true;
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
int result = dissect_thrift_varint(tvb, pinfo, tree, &offset, thrift_opt, TCP_THRIFT_MAX_I64_LEN, hf_id, raw_dissector);
if (result == THRIFT_REQUEST_REASSEMBLY) {
if (offset == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
} else {
return THRIFT_SUBDISSECTOR_ERROR;
}
}
} else if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_I64_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
} else {
if (raw_dissector != NULL) {
tvbuff_t* sub_tvb = tvb_new_subset_length(tvb, offset, TBP_THRIFT_I64_LEN);
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
proto_tree_add_item(tree, hf_id, tvb, offset, TBP_THRIFT_I64_LEN, ENC_BIG_ENDIAN);
}
offset += TBP_THRIFT_I64_LEN;
}
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
return offset;
}
int
dissect_thrift_t_i64(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id)
{
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
return dissect_thrift_raw_i64(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, NULL);
}
static int
dissect_thrift_raw_double(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, dissector_t raw_dissector)
{
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
if (is_field) {
offset = dissect_thrift_t_field_header(tvb, pinfo, tree, offset, thrift_opt, DE_THRIFT_T_DOUBLE, field_id, NULL);
}
ABORT_SUBDISSECTION_ON_ISSUE(offset);
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_DOUBLE_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
thrift_opt->use_std_dissector = true;
if (raw_dissector != NULL) {
tvbuff_t* sub_tvb;
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
/* Create a sub-tvbuff_t in big endian format as documented. */
uint8_t *data = wmem_alloc(wmem_packet_scope(), TBP_THRIFT_DOUBLE_LEN);
data[0] = tvb_get_uint8(tvb, offset + 7);
data[1] = tvb_get_uint8(tvb, offset + 6);
data[2] = tvb_get_uint8(tvb, offset + 5);
data[3] = tvb_get_uint8(tvb, offset + 4);
data[4] = tvb_get_uint8(tvb, offset + 3);
data[5] = tvb_get_uint8(tvb, offset + 2);
data[6] = tvb_get_uint8(tvb, offset + 1);
data[7] = tvb_get_uint8(tvb, offset);
sub_tvb = tvb_new_child_real_data(tvb, data, TBP_THRIFT_DOUBLE_LEN, TBP_THRIFT_DOUBLE_LEN);
} else {
sub_tvb = tvb_new_subset_length(tvb, offset, TBP_THRIFT_DOUBLE_LEN);
}
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
proto_tree_add_item(tree, hf_id, tvb, offset, TBP_THRIFT_DOUBLE_LEN, ENC_LITTLE_ENDIAN);
} else {
proto_tree_add_item(tree, hf_id, tvb, offset, TBP_THRIFT_DOUBLE_LEN, ENC_BIG_ENDIAN);
}
}
offset += TBP_THRIFT_DOUBLE_LEN;
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
return offset;
}
int
dissect_thrift_t_double(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id)
{
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
return dissect_thrift_raw_double(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, NULL);
}
static int
dissect_thrift_raw_uuid(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, dissector_t raw_dissector)
{
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
/* Dissect field header if necessary. */
if (is_field) {
offset = dissect_thrift_t_field_header(tvb, pinfo, tree, offset, thrift_opt, DE_THRIFT_T_UUID, field_id, NULL);
}
ABORT_SUBDISSECTION_ON_ISSUE(offset);
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_UUID_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
thrift_opt->use_std_dissector = true;
if (raw_dissector != NULL) {
tvbuff_t* sub_tvb = tvb_new_subset_length(tvb, offset, TBP_THRIFT_UUID_LEN);
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
proto_tree_add_item(tree, hf_id, tvb, offset, TBP_THRIFT_UUID_LEN, ENC_BIG_ENDIAN);
}
offset += TBP_THRIFT_UUID_LEN;
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
return offset;
}
int
dissect_thrift_t_uuid(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id)
{
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
return dissect_thrift_raw_uuid(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, NULL);
}
static int
dissect_thrift_raw_binary(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, unsigned encoding, dissector_t raw_dissector)
{
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
proto_tree *header_tree = NULL;
proto_item *len_item = NULL;
int32_t str_len, len_len;
int64_t varint;
/* Dissect field header if necessary. */
if (is_field) {
offset = dissect_thrift_t_field_header(tvb, pinfo, tree, offset, thrift_opt, DE_THRIFT_T_BINARY, field_id, &header_tree);
} else {
header_tree = tree;
}
ABORT_SUBDISSECTION_ON_ISSUE(offset);
/* Dissect length. */
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
len_len = thrift_get_varint_enc(tvb, pinfo, header_tree, offset, TCP_THRIFT_MAX_I32_LEN, &varint, ENC_VARINT_PROTOBUF);
switch (len_len) {
case THRIFT_REQUEST_REASSEMBLY:
return THRIFT_REQUEST_REASSEMBLY;
case 0:
return THRIFT_SUBDISSECTOR_ERROR;
default:
break;
}
if ((int64_t)INT32_MIN > varint || varint > (int64_t)INT32_MAX) {
len_item = proto_tree_add_int64(header_tree, hf_thrift_i64, tvb, offset, len_len, varint);
expert_add_info(pinfo, len_item, &ei_thrift_varint_too_large);
return THRIFT_REQUEST_REASSEMBLY;
}
str_len = (int32_t)varint;
if (show_internal_thrift_fields) {
len_item = proto_tree_add_int(header_tree, hf_thrift_str_len, tvb, offset, len_len, str_len);
}
} else {
len_len = TBP_THRIFT_LENGTH_LEN;
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_LENGTH_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
if (show_internal_thrift_fields) {
len_item = proto_tree_add_item_ret_int(header_tree, hf_thrift_str_len, tvb, offset, TBP_THRIFT_LENGTH_LEN, ENC_BIG_ENDIAN, &str_len);
} else {
str_len = tvb_get_ntohil(tvb, offset);
}
}
if (str_len < 0) {
expert_add_info(pinfo, len_item, &ei_thrift_negative_length);
return THRIFT_SUBDISSECTOR_ERROR;
}
offset += len_len;
/* Since we put the length inside the field header, we need to extend it. */
if (header_tree != tree) {
proto_item_set_end(proto_tree_get_parent(header_tree), tvb, offset);
}
/* Dissect data */
if (tvb_reported_length_remaining(tvb, offset) < str_len) {
return THRIFT_REQUEST_REASSEMBLY;
}
thrift_opt->use_std_dissector = true;
if (raw_dissector != NULL) {
tvbuff_t* sub_tvb = tvb_new_subset_length(tvb, offset, str_len);
thrift_opt->use_std_dissector = false;
raw_dissector(sub_tvb, pinfo, tree, thrift_opt);
}
if (thrift_opt->use_std_dissector) {
proto_tree_add_item(tree, hf_id, tvb, offset, str_len, encoding);
}
offset = offset + str_len;
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
return offset;
}
int
dissect_thrift_t_binary(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id)
{
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
return dissect_thrift_raw_binary(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, ENC_NA, NULL);
}
int
dissect_thrift_t_string(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id)
{
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
return dissect_thrift_raw_binary(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, ENC_UTF_8, NULL);
}
int
dissect_thrift_t_string_enc(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, unsigned encoding)
{
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
return dissect_thrift_raw_binary(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, encoding, NULL);
}
int
dissect_thrift_t_raw_data(tvbuff_t* tvb, packet_info* pinfo, proto_tree* tree, int offset, thrift_option_data_t* thrift_opt, bool is_field, int field_id, int hf_id, thrift_type_enum_t type, dissector_t raw_dissector)
{
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
switch (type) {
case DE_THRIFT_T_BOOL:
offset = dissect_thrift_raw_bool(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, raw_dissector);
break;
case DE_THRIFT_T_I8:
offset = dissect_thrift_raw_i8(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, raw_dissector);
break;
case DE_THRIFT_T_I16:
offset = dissect_thrift_raw_i16(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, raw_dissector);
break;
case DE_THRIFT_T_I32:
offset = dissect_thrift_raw_i32(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, raw_dissector);
break;
case DE_THRIFT_T_I64:
offset = dissect_thrift_raw_i64(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, raw_dissector);
break;
case DE_THRIFT_T_DOUBLE:
offset = dissect_thrift_raw_double(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, raw_dissector);
break;
case DE_THRIFT_T_BINARY:
offset = dissect_thrift_raw_binary(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, ENC_NA, raw_dissector);
break;
case DE_THRIFT_T_UUID:
offset = dissect_thrift_raw_uuid(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, raw_dissector);
break;
default:
REPORT_DISSECTOR_BUG("Only simple data types support raw dissection.");
break;
}
return offset;
}
/* Simple dispatch function for lists, sets, maps, and structs internal elements to avoid code duplication. */
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_t_member(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, const thrift_member_t *elt)
{
switch (elt->type) {
case DE_THRIFT_T_STOP:
offset = dissect_thrift_t_stop(tvb, pinfo, tree, offset);
break;
case DE_THRIFT_T_BOOL:
offset = dissect_thrift_raw_bool(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, elt->raw_dissector);
break;
case DE_THRIFT_T_I8:
offset = dissect_thrift_raw_i8(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, elt->raw_dissector);
break;
case DE_THRIFT_T_I16:
offset = dissect_thrift_raw_i16(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, elt->raw_dissector);
break;
case DE_THRIFT_T_I32:
offset = dissect_thrift_raw_i32(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, elt->raw_dissector);
break;
case DE_THRIFT_T_I64:
offset = dissect_thrift_raw_i64(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, elt->raw_dissector);
break;
case DE_THRIFT_T_DOUBLE:
offset = dissect_thrift_raw_double(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, elt->raw_dissector);
break;
case DE_THRIFT_T_BINARY:
offset = dissect_thrift_raw_binary(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, elt->u.encoding, elt->raw_dissector);
break;
case DE_THRIFT_T_LIST:
offset = dissect_thrift_t_list(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, *elt->p_ett_id, elt->u.element);
break;
case DE_THRIFT_T_SET:
offset = dissect_thrift_t_set(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, *elt->p_ett_id, elt->u.element);
break;
case DE_THRIFT_T_MAP:
offset = dissect_thrift_t_map(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, *elt->p_ett_id, elt->u.m.key, elt->u.m.value);
break;
case DE_THRIFT_T_STRUCT:
offset = dissect_thrift_t_struct_expert(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, *elt->p_ett_id, elt->u.s.members, elt->u.s.expert_info);
break;
case DE_THRIFT_T_UUID:
offset = dissect_thrift_raw_uuid(tvb, pinfo, tree, offset, thrift_opt, is_field, elt->fid, *elt->p_hf_id, elt->raw_dissector);
break;
default:
REPORT_DISSECTOR_BUG("Unexpected Thrift type dissection requested.");
break;
}
return offset;
}
/* Effective sub-dissection for lists, sets, and maps in Binary Protocol.
* Since the only difference is in the hf_id used when showing internal Thrift fields,
* this prevents code duplication.
* Map is only adding a type in the header and one element in each loop
* so it's easy to use the same code and handle the additional elements only when necessary.
*/
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_b_linear(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, int ett_id, const thrift_member_t *key, const thrift_member_t *val, thrift_type_enum_t expected)
{
proto_item *container_pi = NULL;
proto_item *len_pi = NULL;
proto_tree *sub_tree;
int32_t key_type, val_type;
int32_t length;
unsigned nested_count = p_get_proto_depth(pinfo, proto_thrift);
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
DISSECTOR_ASSERT((thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) == 0);
/* Dissect field header if necessary. */
if (is_field) {
offset = dissect_thrift_t_field_header(tvb, pinfo, tree, offset, thrift_opt, expected, field_id, NULL);
}
/* Create the sub-tree. */
if (nested_count >= thrift_opt->nested_type_depth) {
expert_add_info(pinfo, proto_tree_get_parent(tree), &ei_thrift_too_many_subtypes);
return THRIFT_REQUEST_REASSEMBLY;
}
p_set_proto_depth(pinfo, proto_thrift, nested_count + 1);
container_pi = proto_tree_add_item(tree, hf_id, tvb, offset, -1, ENC_BIG_ENDIAN);
sub_tree = proto_item_add_subtree(container_pi, ett_id);
ABORT_SUBDISSECTION_ON_ISSUE(offset);
/* Read and check the type of the key in case of map. */
if (expected == DE_THRIFT_T_MAP) {
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_TYPE_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
key_type = tvb_get_uint8(tvb, offset);
if (show_internal_thrift_fields) {
proto_tree_add_item(sub_tree, hf_thrift_type, tvb, offset, TBP_THRIFT_TYPE_LEN, ENC_BIG_ENDIAN);
}
if (key_type != key->type) {
proto_tree_add_expert(sub_tree, pinfo, &ei_thrift_wrong_type, tvb, offset, TBP_THRIFT_TYPE_LEN);
return THRIFT_SUBDISSECTOR_ERROR;
}
offset += TBP_THRIFT_TYPE_LEN;
}
/* Read and check the type of the elements (or type of the values in case of map). */
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_TYPE_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
val_type = tvb_get_uint8(tvb, offset);
if (show_internal_thrift_fields) {
proto_tree_add_item(sub_tree, hf_thrift_type, tvb, offset, TBP_THRIFT_TYPE_LEN, ENC_BIG_ENDIAN);
}
if (val_type != val->type) {
proto_tree_add_expert(sub_tree, pinfo, &ei_thrift_wrong_type, tvb, offset, TBP_THRIFT_TYPE_LEN);
return THRIFT_SUBDISSECTOR_ERROR;
}
offset += TBP_THRIFT_TYPE_LEN;
/* Read and check the number of entries of the container. */
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_LENGTH_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
length = tvb_get_ntohil(tvb, offset);
if (show_internal_thrift_fields) {
int hf_num_item;
switch (expected) {
case DE_THRIFT_T_MAP:
hf_num_item = hf_thrift_num_map_item;
break;
case DE_THRIFT_T_SET:
hf_num_item = hf_thrift_num_set_item;
break;
case DE_THRIFT_T_LIST:
hf_num_item = hf_thrift_num_list_item;
break;
default:
return THRIFT_SUBDISSECTOR_ERROR;
}
len_pi = proto_tree_add_item_ret_int(sub_tree, hf_num_item, tvb, offset, TBP_THRIFT_LENGTH_LEN, ENC_BIG_ENDIAN, &length);
}
offset += TBP_THRIFT_LENGTH_LEN;
if (length < 0) {
expert_add_info(pinfo, len_pi, &ei_thrift_negative_length);
return THRIFT_SUBDISSECTOR_ERROR;
}
/* Read the content of the container. */
for(int i = 0; i < length; ++i) {
if (expected == DE_THRIFT_T_MAP) {
offset = dissect_thrift_t_member(tvb, pinfo, sub_tree, offset, thrift_opt, false, key);
}
offset = dissect_thrift_t_member(tvb, pinfo, sub_tree, offset, thrift_opt, false, val);
/* Avoid continuing the loop if anything went sideways. */
ABORT_SUBDISSECTION_ON_ISSUE(offset);
}
if (container_pi && offset > 0) {
proto_item_set_end(container_pi, tvb, offset);
}
p_set_proto_depth(pinfo, proto_thrift, nested_count);
return offset;
}
/* Effective sub-dissection for both lists and sets for Compact Protocol.
* Since the only difference is in the hf_id used when showing internal Thrift fields,
* this prevents code duplication.
*/
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_c_list_set(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, int ett_id, const thrift_member_t *elt, bool is_list)
{
proto_item *container_pi;
proto_item *type_pi = NULL;
proto_item *len_pi = NULL;
proto_tree *sub_tree = NULL;
uint32_t len_type;
thrift_compact_type_enum_t elt_type;
int32_t container_len, len_len, i;
uint64_t varint;
int lt_offset;
int hf_num_item = hf_thrift_num_set_item;
int hf_pos_item = hf_thrift_num_set_pos;
thrift_type_enum_t expected = DE_THRIFT_T_SET;
unsigned nested_count = p_get_proto_depth(pinfo, proto_thrift);
if (is_list) {
hf_num_item = hf_thrift_num_list_item;
hf_pos_item = hf_thrift_num_list_pos;
expected = DE_THRIFT_T_LIST;
}
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
DISSECTOR_ASSERT(thrift_opt->tprotocol & PROTO_THRIFT_COMPACT);
/* Dissect field header if necessary. */
if (is_field) {
offset = dissect_thrift_t_field_header(tvb, pinfo, tree, offset, thrift_opt, expected, field_id, NULL);
}
ABORT_SUBDISSECTION_ON_ISSUE(offset);
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_TYPE_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
/* Create the sub-tree. */
if (nested_count >= thrift_opt->nested_type_depth) {
expert_add_info(pinfo, proto_tree_get_parent(tree), &ei_thrift_too_many_subtypes);
return THRIFT_REQUEST_REASSEMBLY;
}
p_set_proto_depth(pinfo, proto_thrift, nested_count + 1);
container_pi = proto_tree_add_item(tree, hf_id, tvb, offset, -1, ENC_BIG_ENDIAN);
sub_tree = proto_item_add_subtree(container_pi, ett_id);
/* Read the type of the elements (and length if lower than 15). */
lt_offset = offset;
len_type = tvb_get_uint8(tvb, lt_offset);
offset += TBP_THRIFT_TYPE_LEN;
elt_type = (thrift_compact_type_enum_t)(len_type & TCP_THRIFT_NIBBLE_MASK);
if (show_internal_thrift_fields) {
type_pi = proto_tree_add_bits_item(sub_tree, hf_thrift_type, tvb, (lt_offset << OCTETS_TO_BITS_SHIFT) + TCP_THRIFT_NIBBLE_SHIFT, TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
}
/* Check the type of the elements. */
if (compact_struct_type_to_generic_type(elt_type) != elt->type) {
if (show_internal_thrift_fields) {
expert_add_info(pinfo, type_pi, &ei_thrift_wrong_type);
}
proto_tree_add_expert(sub_tree, pinfo, &ei_thrift_wrong_type, tvb, offset, TBP_THRIFT_TYPE_LEN);
return THRIFT_SUBDISSECTOR_ERROR;
}
container_len = (len_type >> TCP_THRIFT_NIBBLE_SHIFT) & TCP_THRIFT_NIBBLE_MASK;
/* Read and check the number of entries of the container. */
if (container_len == TCP_THRIFT_LENGTH_LARGER) {
if (show_internal_thrift_fields) {
proto_tree_add_bits_item(sub_tree, hf_thrift_large_container, tvb, (lt_offset << OCTETS_TO_BITS_SHIFT), TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
}
/* Length is greater than 14, read effective length as a varint. */
len_len = thrift_get_varint_enc(tvb, pinfo, sub_tree, offset, TCP_THRIFT_MAX_I32_LEN, &varint, ENC_VARINT_PROTOBUF);
switch (len_len) {
case THRIFT_REQUEST_REASSEMBLY:
return THRIFT_REQUEST_REASSEMBLY;
case 0:
/* In case of error, the offset stay at the error position. */
return THRIFT_SUBDISSECTOR_ERROR;
default:
if (varint > (uint64_t)INT32_MAX) {
len_pi = proto_tree_add_int64(sub_tree, hf_thrift_i64, tvb, offset, len_len, varint);
expert_add_info(pinfo, len_pi, &ei_thrift_varint_too_large);
return THRIFT_SUBDISSECTOR_ERROR;
}
container_len = (uint32_t)varint;
if (show_internal_thrift_fields) {
proto_tree_add_int(sub_tree, hf_num_item, tvb, offset, len_len, container_len);
}
offset += len_len;
break;
}
} else if (show_internal_thrift_fields) {
proto_tree_add_bits_item(sub_tree, hf_pos_item, tvb, (lt_offset << OCTETS_TO_BITS_SHIFT), TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
}
/* Read the content of the container. */
for (i = 0; i < container_len; ++i) {
offset = dissect_thrift_t_member(tvb, pinfo, sub_tree, offset, thrift_opt, false, elt);
/* Avoid continuing the loop if anything went sideways. */
ABORT_SUBDISSECTION_ON_ISSUE(offset);
}
if (container_pi && offset > 0) {
proto_item_set_end(container_pi, tvb, offset);
}
p_set_proto_depth(pinfo, proto_thrift, nested_count);
return offset;
}
int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_t_list(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, int ett_id, const thrift_member_t *elt)
{
int result;
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
result = dissect_thrift_c_list_set(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, ett_id, elt, true);
} else {
result = dissect_thrift_b_linear(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, ett_id, NULL, elt, DE_THRIFT_T_LIST);
}
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
return result;
}
int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_t_set(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, int ett_id, const thrift_member_t *elt)
{
int result;
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
result = dissect_thrift_c_list_set(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, ett_id, elt, false);
} else {
result = dissect_thrift_b_linear(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, ett_id, NULL, elt, DE_THRIFT_T_SET);
}
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
return result;
}
int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_t_map(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, int ett_id, const thrift_member_t *key, const thrift_member_t *value)
{
int result;
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
if ((thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) == 0) {
result = dissect_thrift_b_linear(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, ett_id, key, value, DE_THRIFT_T_MAP);
} else {
proto_tree *sub_tree = NULL;
proto_item *container_pi;
proto_item *ktype_pi = NULL;
proto_item *vtype_pi = NULL;
int32_t container_len, len_len, i, types;
int32_t len_offset = offset;
thrift_compact_type_enum_t ktype, vtype;
uint64_t varint;
unsigned nested_count = p_get_proto_depth(pinfo, proto_thrift);
/* Dissect field header if necessary. */
if (is_field) {
if (show_internal_thrift_fields) {
sub_tree = tree;
}
offset = dissect_thrift_t_field_header(tvb, pinfo, sub_tree, offset, thrift_opt, DE_THRIFT_T_MAP, field_id, NULL);
}
/* Read and check number of key-value pair in the map. */
if (tvb_reported_length_remaining(tvb, offset) < TCP_THRIFT_MIN_VARINT_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
len_len = thrift_get_varint_enc(tvb, pinfo, sub_tree, offset, TCP_THRIFT_MAX_I32_LEN, &varint, ENC_VARINT_PROTOBUF);
switch (len_len) {
case THRIFT_REQUEST_REASSEMBLY:
return THRIFT_REQUEST_REASSEMBLY;
case 0:
/* In case of error, the offset stay at the error position. */
return THRIFT_SUBDISSECTOR_ERROR;
default:
if (varint > (uint64_t)INT32_MAX) {
proto_item *len_pi = proto_tree_add_int64(sub_tree, hf_thrift_i64, tvb, offset, len_len, varint);
expert_add_info(pinfo, len_pi, &ei_thrift_varint_too_large);
return THRIFT_SUBDISSECTOR_ERROR;
}
container_len = (uint32_t)varint;
offset += len_len;
break;
}
/* Create the sub-tree. */
if (nested_count >= thrift_opt->nested_type_depth) {
expert_add_info(pinfo, proto_tree_get_parent(tree), &ei_thrift_too_many_subtypes);
return THRIFT_REQUEST_REASSEMBLY;
}
p_set_proto_depth(pinfo, proto_thrift, nested_count + 1);
container_pi = proto_tree_add_item(tree, hf_id, tvb, len_offset, -1, ENC_BIG_ENDIAN);
sub_tree = proto_item_add_subtree(container_pi, ett_id);
if (container_len == 0) {
proto_item_set_end(container_pi, tvb, offset);
proto_item_append_text(container_pi, " (Empty)");
p_set_proto_depth(pinfo, proto_thrift, nested_count);
return offset;
}
/* If the map is not empty, read the types of keys and values. */
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_TYPE_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
types = tvb_get_uint8(tvb, offset);
ktype = (thrift_compact_type_enum_t)((types >> TCP_THRIFT_NIBBLE_SHIFT) & TCP_THRIFT_NIBBLE_MASK);
vtype = (thrift_compact_type_enum_t)(types & TCP_THRIFT_NIBBLE_MASK);
if (show_internal_thrift_fields) {
proto_tree_add_int(sub_tree, hf_thrift_num_map_item, tvb, len_offset, len_len, container_len);
ktype_pi = proto_tree_add_bits_item(sub_tree, hf_thrift_key_type, tvb, offset << OCTETS_TO_BITS_SHIFT, TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
vtype_pi = proto_tree_add_bits_item(sub_tree, hf_thrift_value_type, tvb, (offset << OCTETS_TO_BITS_SHIFT) + TCP_THRIFT_NIBBLE_SHIFT, TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
}
/* Check that types match what is expected. */
if (compact_struct_type_to_generic_type(ktype) != key->type) {
if (show_internal_thrift_fields) {
expert_add_info(pinfo, ktype_pi, &ei_thrift_wrong_type);
} else {
proto_tree_add_expert(sub_tree, pinfo, &ei_thrift_wrong_type, tvb, offset, TBP_THRIFT_TYPE_LEN);
}
return THRIFT_SUBDISSECTOR_ERROR;
}
if (compact_struct_type_to_generic_type(vtype) != value->type) {
if (show_internal_thrift_fields) {
expert_add_info(pinfo, vtype_pi, &ei_thrift_wrong_type);
} else {
proto_tree_add_expert(sub_tree, pinfo, &ei_thrift_wrong_type, tvb, offset, TBP_THRIFT_TYPE_LEN);
}
return THRIFT_SUBDISSECTOR_ERROR;
}
/* Read the content of the container. */
for (i = 0; i < container_len; ++i) {
offset = dissect_thrift_t_member(tvb, pinfo, sub_tree, offset, thrift_opt, false, key);
offset = dissect_thrift_t_member(tvb, pinfo, sub_tree, offset, thrift_opt, false, value);
/* Avoid continuing the loop if anything went sideways. */
ABORT_SUBDISSECTION_ON_ISSUE(offset);
}
if (container_pi && offset > 0) {
proto_item_set_end(container_pi, tvb, offset);
}
result = offset;
p_set_proto_depth(pinfo, proto_thrift, nested_count);
}
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
return result;
}
int
dissect_thrift_t_struct(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, int ett_id, const thrift_member_t *seq)
{
return dissect_thrift_t_struct_expert(tvb, pinfo, tree, offset, thrift_opt, is_field, field_id, hf_id, ett_id, seq, NULL);
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_t_struct_expert(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt, bool is_field, int field_id, int hf_id, int ett_id, const thrift_member_t *seq, expert_field* ei)
{
thrift_field_header_t field_header;
proto_tree *sub_tree = NULL;
proto_item *type_pi = NULL;
bool enable_subtree = (ett_id != DISABLE_SUBTREE) || (hf_id != DISABLE_SUBTREE);
unsigned nested_count = p_get_proto_depth(pinfo, proto_thrift);
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
/* Dissect field header if necessary. */
if (is_field) {
if (show_internal_thrift_fields) {
sub_tree = tree;
}
offset = dissect_thrift_t_field_header(tvb, pinfo, sub_tree, offset, thrift_opt, DE_THRIFT_T_STRUCT, field_id, NULL);
}
ABORT_SUBDISSECTION_ON_ISSUE(offset);
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_TYPE_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
/* Create the sub-tree, if not explicitly refused. */
if (enable_subtree) {
/* Add the struct to the tree. */
if (nested_count >= thrift_opt->nested_type_depth) {
expert_add_info(pinfo, proto_tree_get_parent(tree), &ei_thrift_too_many_subtypes);
return THRIFT_REQUEST_REASSEMBLY;
}
p_set_proto_depth(pinfo, proto_thrift, nested_count + 1);
type_pi = proto_tree_add_item(tree, hf_id, tvb, offset, -1, ENC_BIG_ENDIAN);
sub_tree = proto_item_add_subtree(type_pi, ett_id);
} else {
/* Sub-dissector requested that we don't use a sub_tree.
* This is useful for ME_THRIFT_T_REPLY or unions where we always have only 1 sub-element. */
sub_tree = tree;
}
thrift_opt->previous_field_id = 0;
/* Read and check available fields. */
while (seq->type != DE_THRIFT_T_STOP) {
int local_offset = offset;
/* Read the type and check for the end of the structure.
* Never create the field header sub-tree here as it will be handled by the field's own dissector.
* We only want to get the type & field id information to compare them against what we expect.
*/
if (dissect_thrift_field_header(tvb, pinfo, NULL, &local_offset, thrift_opt, &field_header, false) == THRIFT_REQUEST_REASSEMBLY) {
if (local_offset == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
} else {
return THRIFT_SUBDISSECTOR_ERROR;
}
}
/* Right now, we only check for T_STOP type. The member sub-dissection will take care of checking the type. */
if (field_header.type.binary == DE_THRIFT_T_STOP) {
if (seq->optional) {
seq++;
continue;
} else {
proto_tree_add_expert(sub_tree, pinfo, &ei_thrift_struct_fid_not_in_seq, tvb, offset, TBP_THRIFT_TYPE_LEN);
return THRIFT_SUBDISSECTOR_ERROR;
}
}
/* Read and check the field id which is the only way to make sure we are aligned. */
if (field_header.field_id != seq->fid) {
/* Wrong field in sequence or was it optional? */
if (seq->optional) {
/* Skip to next element*/
seq++;
continue;
} else {
proto_tree_add_expert(sub_tree, pinfo, &ei_thrift_struct_fid_not_in_seq, tvb, offset, TBP_THRIFT_TYPE_LEN);
return THRIFT_SUBDISSECTOR_ERROR;
}
}
if (seq->type != DE_THRIFT_T_GENERIC) {
/* Type is not T_STOP and field id matches one we know how to dissect. */
offset = dissect_thrift_t_member(tvb, pinfo, sub_tree, offset, thrift_opt, true, seq);
} else {
/* The field is not defined in the struct, switch back to generic dissection.
* Re-read the header ensuring it is displayed (no need to check result,
* we already dissected it but without the header tree creation. */
dissect_thrift_field_header(tvb, pinfo, sub_tree, &offset, thrift_opt, &field_header, false);
expert_add_info(pinfo, field_header.fid_pi, &ei_thrift_undefined_field_id);
// Then dissect just this field.
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
if (!is_thrift_compact_bool_type(field_header.type.compact) &&
dissect_thrift_compact_type(tvb, pinfo, sub_tree, &offset, thrift_opt, field_header.fh_tree, field_header.type.compact, field_header.type_pi) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
} else {
if (dissect_thrift_binary_type(tvb, pinfo, sub_tree, &offset, thrift_opt, field_header.fh_tree, field_header.type.binary, field_header.type_pi) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
}
}
ABORT_SUBDISSECTION_ON_ISSUE(offset);
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_TYPE_LEN) {
return THRIFT_REQUEST_REASSEMBLY;
}
seq++;
/* Allow the proper handling of next delta field id in Compact protocol. */
thrift_opt->previous_field_id = field_header.field_id;
}
/* The loop exits before dissecting the T_STOP. */
offset = dissect_thrift_t_stop(tvb, pinfo, sub_tree, offset);
/* Set expert info if required. */
if (ei != NULL) {
expert_add_info(pinfo, type_pi, ei);
}
if (enable_subtree && offset > 0) {
proto_item_set_end(type_pi, tvb, offset);
}
if (is_field) {
thrift_opt->previous_field_id = field_id;
}
p_set_proto_depth(pinfo, proto_thrift, nested_count);
return offset;
}
/*=====END SUB-DISSECTION=====*/
/* GENERIC DISSECTION PARAMETERS DOCUMENTATION
*
* Generic functions for when there is no custom sub-dissector.
* Same conventions are used for binary and compact.
*
* +--------------------+--------------------------+---------------------+
* | offset \ return | REQUEST_REASSEMBLY = -1 | Length |
* +--------------------+--------------------------+---------------------+
* | REQUEST_REASSEMBLY | Reassembly required | SHALL NEVER HAPPEN! |
* +--------------------+--------------------------+---------------------+
* | Length | Error occurred at offset | Data fully parsed. |
* +--------------------+--------------------------+---------------------+
*
* @param[in] tvb: Pointer to the tvbuff_t holding the captured data.
* @param[in] pinfo: Pointer to the packet_info holding information about the currently dissected packet.
* @param[in] tree: Pointer to the proto_tree used to hold the display tree in Wireshark's interface.
* @param[in,out] offset: Pointer to the offset from the beginning of the tvbuff_t where the Thrift field is. Function will dissect only the data.
* The offset is modified according to table hereabove in sync with the return value.
* @param[in] thrift_opt: Options from the Thrift dissector that will be useful for dissection of deep data (to expose the position of failure).
*
* // Specific to dissect_thrift_binary_linear.
* @param[in] expected: Expected container type (list, set, or map).
*
* // Specific to dissect_thrift_compact_list_set.
* @param[in] is_list: `true` if the expected container type is list.
* `false` if the expected container type is set.
*
* // Specific to dissect_thrift_(binary|compact)_binary.
* // Present in dissect_thrift_(binary|compact)_type for forwarding purpose.
* @param[in] header_tree: The proto_tree in which the length must be inserted.
* If it is NULL, tree will be used instead.
* Used in structs to push the length in the field header.
*
* // Specific to dissect_thrift_(binary|compact)_type.
* @param[in] type: The type for which data needs to be dissected.
* Neither type nor field_id to dissect as there is no such "header" in list, set, and map.
* @param[in] type_pi: The proto_item of the type field to indicate position of failure.
*/
/*=====BEGIN BINARY GENERIC DISSECTION=====*/
static int
dissect_thrift_binary_binary(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt, proto_tree *header_tree)
{
/* Binary protocol binary/string data (4 bytes + data):
* +--------+--------+--------+--------+--------+ ... +--------+
* | Number of bytes | N bytes of data |
* +--------+--------+--------+--------+--------+ ... +--------+
*
* Where:
* Number of bytes is the number of encoded bytes of data.
* In particular, it might be larger than the number
* of characters in an UTF-8 string.
*/
int32_t str_len;
proto_item *pi;
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_BINARY_LEN);
if (header_tree == NULL) {
header_tree = tree;
}
pi = proto_tree_add_item_ret_int(header_tree, hf_thrift_str_len, tvb, *offset, TBP_THRIFT_LENGTH_LEN, ENC_BIG_ENDIAN, &str_len);
*offset += TBP_THRIFT_LENGTH_LEN;
if (header_tree != tree) {
proto_item_set_end(proto_tree_get_parent(header_tree), tvb, *offset);
}
if (str_len < 0) {
expert_add_info(pinfo, pi, &ei_thrift_negative_length);
return THRIFT_REQUEST_REASSEMBLY;
}
return dissect_thrift_string_as_preferred(tvb, pinfo, tree, offset, thrift_opt, str_len);
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_binary_linear(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt, thrift_type_enum_t expected)
{
/* Binary protocol list and set (5 bytes + elements):
* +--------+--------+--------+--------+--------+---...---+ ... +---...---+
* |0000tttt| number of elements |element 1| |element N|
* +--------+--------+--------+--------+--------+---...---+ ... +---...---+
*
* Binary protocol map (6 bytes + key-value pairs):
* +--------+--------+--------+--------+--------+--------+--...--+---...---+ ... +--...--+---...---+
* |0000kkkk|0000vvvv| number of key+value pairs | key 1 | value 1 | | key N | value N |
* +--------+--------+--------+--------+--------+--------+--...--+---...---+ ... +--...--+---...---+
*
* Where:
* 'tttt' is the type of the list or set elements, an unsigned 4 bits strictly positive integer.
* 'kkkk' is the type of the map keys, an unsigned 4 bits strictly positive integer.
* 'vvvv' is the type of the map values, an unsigned 4 bits strictly positive integer.
*/
proto_tree *sub_tree;
proto_item *container_pi, *len_pi, *vtype_pi;
proto_item *ktype_pi = NULL; // Avoid a false positive warning.
int32_t ktype, vtype;
int32_t container_len, i;
int ett = 0;
int hf_container = 0;
int hf_num_item = 0;
int hf_vtype = hf_thrift_type;
int min_len = TBP_THRIFT_LINEAR_LEN;
unsigned nested_count = p_get_proto_depth(pinfo, proto_thrift);
/* Set the different hf_id & ett depending on effective type. */
switch (expected) {
case DE_THRIFT_T_SET:
ett = ett_thrift_set;
hf_container = hf_thrift_set;
hf_num_item = hf_thrift_num_set_item;
break;
case DE_THRIFT_T_LIST:
ett = ett_thrift_list;
hf_container = hf_thrift_list;
hf_num_item = hf_thrift_num_list_item;
break;
case DE_THRIFT_T_MAP:
ett = ett_thrift_map;
hf_container = hf_thrift_map;
hf_num_item = hf_thrift_num_map_item;
hf_vtype = hf_thrift_value_type; /* Use specific hf_info as we have several types. */
min_len += TBP_THRIFT_TYPE_LEN; /* Additional type key + value instead of element only. */
break;
default:
REPORT_DISSECTOR_BUG("dissect_thrift_binary_linear called with something else than a container type.");
break;
}
ABORT_ON_INCOMPLETE_PDU(min_len);
/* Create the sub-tree. */
if (nested_count >= thrift_opt->nested_type_depth) {
expert_add_info(pinfo, proto_tree_get_parent(tree), &ei_thrift_too_many_subtypes);
return THRIFT_REQUEST_REASSEMBLY;
}
p_set_proto_depth(pinfo, proto_thrift, nested_count + 1);
container_pi = proto_tree_add_item(tree, hf_container, tvb, *offset, -1, ENC_NA);
sub_tree = proto_item_add_subtree(container_pi, ett);
/* Read the type of the key in case of map. */
if (expected == DE_THRIFT_T_MAP) {
ktype_pi = proto_tree_add_item_ret_uint(sub_tree, hf_thrift_key_type, tvb, *offset, TBP_THRIFT_TYPE_LEN, ENC_BIG_ENDIAN, &ktype);
*offset += TBP_THRIFT_TYPE_LEN;
}
/* Read the type of the elements (or type of the values in case of map). */
vtype_pi = proto_tree_add_item_ret_uint(sub_tree, hf_vtype, tvb, *offset, TBP_THRIFT_TYPE_LEN, ENC_BIG_ENDIAN, &vtype);
*offset += TBP_THRIFT_TYPE_LEN;
/* Read and check the number of entries of the container. */
len_pi = proto_tree_add_item_ret_int(sub_tree, hf_num_item, tvb, *offset, TBP_THRIFT_LENGTH_LEN, ENC_BIG_ENDIAN, &container_len);
*offset += TBP_THRIFT_LENGTH_LEN;
if (container_len < 0) {
expert_add_info(pinfo, len_pi, &ei_thrift_negative_length);
return THRIFT_REQUEST_REASSEMBLY;
}
/* Read the content of the container. */
for (i = 0; i < container_len; ++i) {
if (expected == DE_THRIFT_T_MAP) {
if (dissect_thrift_binary_type(tvb, pinfo, sub_tree, offset, thrift_opt, NULL, ktype, ktype_pi) == THRIFT_REQUEST_REASSEMBLY)
return THRIFT_REQUEST_REASSEMBLY;
}
if (dissect_thrift_binary_type(tvb, pinfo, sub_tree, offset, thrift_opt, NULL, vtype, vtype_pi) == THRIFT_REQUEST_REASSEMBLY)
return THRIFT_REQUEST_REASSEMBLY;
}
proto_item_set_end(container_pi, tvb, *offset);
p_set_proto_depth(pinfo, proto_thrift, nested_count);
return *offset;
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_binary_list(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt)
{
return dissect_thrift_binary_linear(tvb, pinfo, tree, offset, thrift_opt, DE_THRIFT_T_LIST);
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_binary_set(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt)
{
return dissect_thrift_binary_linear(tvb, pinfo, tree, offset, thrift_opt, DE_THRIFT_T_SET);
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_binary_map(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt)
{
return dissect_thrift_binary_linear(tvb, pinfo, tree, offset, thrift_opt, DE_THRIFT_T_MAP);
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_binary_fields(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt)
{
/*
* Binary protocol field header (3 bytes) and field value:
* +--------+--------+--------+--------+...+--------+
* |0000tttt| field id | field value |
* +--------+--------+--------+--------+...+--------+
*
* Binary & Compact protocol stop field (1 byte):
* +--------+
* |00000000|
* +--------+
*
* Where:
* 'dddd' is the field id delta, a strictly positive unsigned 4 bits integer.
* 'tttt' is the type of the field value, an unsigned 4 bits strictly positive integer.
* field id is the numerical value of the field in the structure.
* field value is the encoded value.
*/
/* This function does not create the subtree, it's the responsibility of the caller:
* - either dissect_thrift_common which creates the "Data" sub-tree,
* - or dissect_thrift_binary_struct which creates the "Struct" sub-tree.
*/
thrift_field_header_t field_header = {
.type.binary = DE_THRIFT_T_STOP, // Overwritten by dissect_thrift_field_header() but undetected by Clang.
};
thrift_opt->previous_field_id = 0;
while (true) {
if (dissect_thrift_field_header(tvb, pinfo, tree, offset, thrift_opt, &field_header, true) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
if (field_header.type.binary == DE_THRIFT_T_STOP) {
break;
}
if (dissect_thrift_binary_type(tvb, pinfo, tree, offset, thrift_opt, field_header.fh_tree, field_header.type.binary, field_header.type_pi) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
}
return *offset;
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_binary_struct(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt)
{
/* This function only creates the "Struct" sub-tree
* then it delegates the fields dissection to dissect_thrift_binary_fields.
*/
proto_tree *sub_tree;
proto_item *pi;
unsigned nested_count = p_get_proto_depth(pinfo, proto_thrift);
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_STRUCT_LEN);
if (nested_count >= thrift_opt->nested_type_depth) {
expert_add_info(pinfo, proto_tree_get_parent(tree), &ei_thrift_too_many_subtypes);
return THRIFT_REQUEST_REASSEMBLY;
}
p_set_proto_depth(pinfo, proto_thrift, nested_count + 1);
pi = proto_tree_add_item(tree, hf_thrift_struct, tvb, *offset, -1, ENC_NA);
sub_tree = proto_item_add_subtree(pi, ett_thrift_struct);
if (dissect_thrift_binary_fields(tvb, pinfo, sub_tree, offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
} else {
proto_item_set_end(pi, tvb, *offset);
}
p_set_proto_depth(pinfo, proto_thrift, nested_count);
return *offset;
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_binary_type(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt, proto_tree *header_tree, int type, proto_item *type_pi)
{
switch (type) {
case DE_THRIFT_T_BOOL:
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_BOOL_LEN);
proto_tree_add_item(tree, hf_thrift_bool, tvb, *offset, TBP_THRIFT_BOOL_LEN, ENC_BIG_ENDIAN);
*offset += TBP_THRIFT_BOOL_LEN;
break;
case DE_THRIFT_T_I8:
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_I8_LEN);
proto_tree_add_item(tree, hf_thrift_i8, tvb, *offset, TBP_THRIFT_I8_LEN, ENC_BIG_ENDIAN);
*offset += TBP_THRIFT_I8_LEN;
break;
case DE_THRIFT_T_I16:
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_I16_LEN);
proto_tree_add_item(tree, hf_thrift_i16, tvb, *offset, TBP_THRIFT_I16_LEN, ENC_BIG_ENDIAN);
*offset += TBP_THRIFT_I16_LEN;
break;
case DE_THRIFT_T_I32:
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_I32_LEN);
proto_tree_add_item(tree, hf_thrift_i32, tvb, *offset, TBP_THRIFT_I32_LEN, ENC_BIG_ENDIAN);
*offset += TBP_THRIFT_I32_LEN;
break;
case DE_THRIFT_T_I64:
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_I64_LEN);
proto_tree_add_item(tree, hf_thrift_i64, tvb, *offset, TBP_THRIFT_I64_LEN, ENC_BIG_ENDIAN);
*offset += TBP_THRIFT_I64_LEN;
break;
case DE_THRIFT_T_DOUBLE:
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_DOUBLE_LEN);
proto_tree_add_item(tree, hf_thrift_double, tvb, *offset, TBP_THRIFT_DOUBLE_LEN, ENC_BIG_ENDIAN);
*offset += TBP_THRIFT_DOUBLE_LEN;
break;
case DE_THRIFT_T_UUID:
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_UUID_LEN);
proto_tree_add_item(tree, hf_thrift_uuid, tvb, *offset, TBP_THRIFT_UUID_LEN, ENC_BIG_ENDIAN);
*offset += TBP_THRIFT_UUID_LEN;
break;
case DE_THRIFT_T_BINARY:
if (dissect_thrift_binary_binary(tvb, pinfo, tree, offset, thrift_opt, header_tree) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
case DE_THRIFT_T_LIST:
if (dissect_thrift_binary_list(tvb, pinfo, tree, offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
case DE_THRIFT_T_SET:
if (dissect_thrift_binary_set(tvb, pinfo, tree, offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
case DE_THRIFT_T_MAP:
if (dissect_thrift_binary_map(tvb, pinfo, tree, offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
case DE_THRIFT_T_STRUCT:
if (dissect_thrift_binary_struct(tvb, pinfo, tree, offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
default:
/* Bail out */
expert_add_info(pinfo, type_pi, &ei_thrift_wrong_type);
return THRIFT_REQUEST_REASSEMBLY;
}
return *offset;
}
/*=====END BINARY GENERIC DISSECTION=====*/
/*=====BEGIN COMPACT GENERIC DISSECTION=====*/
/*
* Generic functions for when there is no custom sub-dissector.
*
* Use the same conventions (parameters & return values) as TBinaryProtocol.
*
* See "GENERIC DISSECTION PARAMETERS DOCUMENTATION" comment.
*/
static int
dissect_thrift_compact_binary(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt, proto_tree *header_tree)
{
/* Compact protocol binary/string data (1 to 5 bytes + data):
* +--------+...+--------+--------+...+--------+
* | number of bytes | N bytes of data |
* +--------+...+--------+--------+...+--------+
*
* Where:
* Number of bytes is the number of encoded bytes of data encoded as an unsigned varint.
* In particular, it might be larger than the number
* of characters in an UTF-8 string.
*/
int32_t str_len;
proto_item *pi;
int64_t varint;
if (header_tree == NULL) {
header_tree = tree;
}
int len_len = thrift_get_varint_enc(tvb, pinfo, header_tree, *offset, TCP_THRIFT_MAX_I32_LEN, &varint, ENC_VARINT_PROTOBUF);
switch (len_len) {
case THRIFT_REQUEST_REASSEMBLY:
/* Will always return after setting the expert parts. */
ABORT_ON_INCOMPLETE_PDU(TCP_THRIFT_MAX_I32_LEN);
return THRIFT_REQUEST_REASSEMBLY; // Just to avoid a false positive warning.
case 0:
/* In case of error, the offset stay at the error position. */
return THRIFT_REQUEST_REASSEMBLY;
default:
*offset += len_len;
break;
}
if (header_tree != tree) {
proto_item_set_end(proto_tree_get_parent(header_tree), tvb, *offset);
}
if ((int64_t)INT32_MIN > varint || varint > (int64_t)INT32_MAX) {
pi = proto_tree_add_int64(header_tree, hf_thrift_i64, tvb, *offset, len_len, varint);
expert_add_info(pinfo, pi, &ei_thrift_varint_too_large);
return THRIFT_REQUEST_REASSEMBLY;
}
str_len = (int32_t)varint;
pi = proto_tree_add_int(header_tree, hf_thrift_str_len, tvb, *offset, len_len, str_len);
if (str_len < 0) {
expert_add_info(pinfo, pi, &ei_thrift_negative_length);
return THRIFT_REQUEST_REASSEMBLY;
}
return dissect_thrift_string_as_preferred(tvb, pinfo, tree, offset, thrift_opt, str_len);
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_compact_list_set(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt, bool is_list)
{
/* Compact protocol list/set (short form, 1 byte):
* +--------+--------+...+--------+
* |nnnntttt| nnnn elements |
* +--------+--------+...+--------+
*
* Compact protocol list/set (long form, 2+ bytes):
* +--------+--------+...+--------+--------+...+--------+
* |1111tttt| number of elements | elements |
* +--------+--------+...+--------+--------+...+--------+
*
* Where:
* 'nnnn' is the number of elements if between 0 and 14 included encoded as a 4 bits unsigned integer.
* 'tttt' is the type of the elements (using the same convention as TBinaryProtocol, unlike compact structures.
* '1111' indicates that the number of elements is encoded as an unsigned 32 bits varint (for number >= 15).
*/
proto_tree *sub_tree;
proto_item *container_pi, *type_pi, *len_pi;
uint32_t len_type, type;
int32_t container_len, len_len, i;
uint64_t varint;
int lt_offset = *offset;
int ett = ett_thrift_set;
int hf_container = hf_thrift_set;
int hf_num_item = hf_thrift_num_set_item;
int hf_pos_item = hf_thrift_num_set_pos;
unsigned nested_count = p_get_proto_depth(pinfo, proto_thrift);
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_TYPE_LEN);
/* Set the different hf_id & ett depending on effective type. */
if (is_list) {
ett = ett_thrift_list;
hf_container = hf_thrift_list;
hf_num_item = hf_thrift_num_list_item;
hf_pos_item = hf_thrift_num_list_pos;
}
/* Create the sub-tree. */
if (nested_count >= thrift_opt->nested_type_depth) {
expert_add_info(pinfo, proto_tree_get_parent(tree), &ei_thrift_too_many_subtypes);
return THRIFT_REQUEST_REASSEMBLY;
}
p_set_proto_depth(pinfo, proto_thrift, nested_count + 1);
container_pi = proto_tree_add_item(tree, hf_container, tvb, *offset, -1, ENC_NA);
sub_tree = proto_item_add_subtree(container_pi, ett);
/* Read the type of the elements (and length if lower than 15). */
len_type = tvb_get_uint8(tvb, lt_offset);
*offset += TBP_THRIFT_TYPE_LEN;
type = len_type & TCP_THRIFT_NIBBLE_MASK;
type_pi = proto_tree_add_bits_item(sub_tree, hf_thrift_type, tvb, (lt_offset << OCTETS_TO_BITS_SHIFT) + TCP_THRIFT_NIBBLE_SHIFT, TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
container_len = (len_type >> TCP_THRIFT_NIBBLE_SHIFT) & TCP_THRIFT_NIBBLE_MASK;
/* Read and check the number of entries of the container. */
if (container_len == TCP_THRIFT_LENGTH_LARGER) {
proto_tree_add_bits_item(sub_tree, hf_thrift_large_container, tvb, (lt_offset << OCTETS_TO_BITS_SHIFT), TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
/* Length is greater than 14, read effective length as a varint. */
len_len = thrift_get_varint_enc(tvb, pinfo, sub_tree, *offset, TCP_THRIFT_MAX_I32_LEN, &varint, ENC_VARINT_PROTOBUF);
switch (len_len) {
case THRIFT_REQUEST_REASSEMBLY:
/* Will always return after setting the expert parts. */
ABORT_ON_INCOMPLETE_PDU(TCP_THRIFT_MAX_I32_LEN);
return THRIFT_REQUEST_REASSEMBLY; // Just to avoid a false positive warning.
case 0:
/* In case of error, the offset stay at the error position. */
return THRIFT_REQUEST_REASSEMBLY;
default:
if (varint > (uint64_t)INT32_MAX) {
len_pi = proto_tree_add_int64(sub_tree, hf_thrift_i64, tvb, *offset, len_len, varint);
expert_add_info(pinfo, len_pi, &ei_thrift_varint_too_large);
return THRIFT_REQUEST_REASSEMBLY;
}
container_len = (uint32_t)varint;
len_pi = proto_tree_add_int(sub_tree, hf_num_item, tvb, *offset, len_len, container_len);
*offset += len_len;
break;
}
} else {
len_pi = proto_tree_add_bits_item(sub_tree, hf_pos_item, tvb, (lt_offset << OCTETS_TO_BITS_SHIFT), TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
}
if (container_len < 0) {
expert_add_info(pinfo, len_pi, &ei_thrift_negative_length);
return THRIFT_REQUEST_REASSEMBLY;
}
/* Read the content of the container. */
for (i = 0; i < container_len; ++i) {
if (dissect_thrift_compact_type(tvb, pinfo, sub_tree, offset, thrift_opt, NULL, type, type_pi) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
}
proto_item_set_end(container_pi, tvb, *offset);
p_set_proto_depth(pinfo, proto_thrift, nested_count);
return *offset;
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_compact_list(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt)
{
return dissect_thrift_compact_list_set(tvb, pinfo, tree, offset, thrift_opt, true);
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_compact_set(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt)
{
return dissect_thrift_compact_list_set(tvb, pinfo, tree, offset, thrift_opt, false);
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_compact_map(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt)
{
/* Compact protocol map header (1 byte, empty map):
* +--------+
* |00000000|
* +--------+
*
* Compact protocol map (4+ bytes, non empty map) and key-value pairs:
* +--------+...+--------+--------+--...--+---...---+ ... +--...--+---...---+
* | number of elements |kkkkvvvv| key 1 | value 1 | | key N | value N |
* +--------+...+--------+--------+--...--+---...---+ ... +--...--+---...---+
*
* Where:
* nb of elts is the number of key + value pairs, encoded as an unsigned 32 bits varint.
* If this varint is null (map is empty), the types are not encoded at all.
* 'kkkk' is the type of the map keys, an unsigned 4 bits strictly positive integer.
* 'vvvv' is the type of the map values, an unsigned 4 bits strictly positive integer.
*/
proto_tree *sub_tree;
proto_item *container_pi, *len_pi, *ktype_pi, *vtype_pi;
uint32_t types, ktype, vtype;
int32_t container_len, len_len, i;
uint64_t varint;
unsigned nested_count = p_get_proto_depth(pinfo, proto_thrift);
ABORT_ON_INCOMPLETE_PDU(TCP_THRIFT_MIN_VARINT_LEN);
/* Create the sub-tree. */
if (nested_count >= thrift_opt->nested_type_depth) {
expert_add_info(pinfo, proto_tree_get_parent(tree), &ei_thrift_too_many_subtypes);
return THRIFT_REQUEST_REASSEMBLY;
}
p_set_proto_depth(pinfo, proto_thrift, nested_count + 1);
container_pi = proto_tree_add_item(tree, hf_thrift_map, tvb, *offset, -1, ENC_NA);
sub_tree = proto_item_add_subtree(container_pi, ett_thrift_map);
/* Read and check number of key-value pair in the map. */
len_len = thrift_get_varint_enc(tvb, pinfo, sub_tree, *offset, TCP_THRIFT_MAX_I32_LEN, &varint, ENC_VARINT_PROTOBUF);
switch (len_len) {
case THRIFT_REQUEST_REASSEMBLY:
/* Will always return after setting the expert parts. */
ABORT_ON_INCOMPLETE_PDU(TCP_THRIFT_MAX_I32_LEN);
return THRIFT_REQUEST_REASSEMBLY; // Just to avoid a false positive warning.
case 0:
/* In case of error, the offset stay at the error position. */
return THRIFT_REQUEST_REASSEMBLY;
default:
if (varint > (uint64_t)INT32_MAX) {
len_pi = proto_tree_add_int64(sub_tree, hf_thrift_i64, tvb, *offset, len_len, varint);
expert_add_info(pinfo, len_pi, &ei_thrift_varint_too_large);
return THRIFT_REQUEST_REASSEMBLY;
}
container_len = (uint32_t)varint;
len_pi = proto_tree_add_int(sub_tree, hf_thrift_num_map_item, tvb, *offset, len_len, container_len);
*offset += len_len;
break;
}
if (container_len < 0) {
expert_add_info(pinfo, len_pi, &ei_thrift_negative_length);
return THRIFT_REQUEST_REASSEMBLY;
}
/* Do not try to read the key & value types of an empty map. */
if (container_len > 0) {
/* If the map is not empty, read the types of keys and values. */
types = tvb_get_uint8(tvb, *offset);
ktype = (types >> TCP_THRIFT_NIBBLE_SHIFT) & TCP_THRIFT_NIBBLE_MASK;
ktype_pi = proto_tree_add_bits_item(sub_tree, hf_thrift_key_type, tvb, *offset << OCTETS_TO_BITS_SHIFT, TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
vtype = types & TCP_THRIFT_NIBBLE_MASK;
vtype_pi = proto_tree_add_bits_item(sub_tree, hf_thrift_value_type, tvb, (*offset << OCTETS_TO_BITS_SHIFT) + TCP_THRIFT_NIBBLE_SHIFT, TCP_THRIFT_NIBBLE_SHIFT, ENC_BIG_ENDIAN);
*offset += TCP_THRIFT_MAP_TYPES_LEN;
/* Read the content of the container. */
for (i = 0; i < container_len; ++i) {
if (dissect_thrift_compact_type(tvb, pinfo, sub_tree, offset, thrift_opt, NULL, ktype, ktype_pi) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
if (dissect_thrift_compact_type(tvb, pinfo, sub_tree, offset, thrift_opt, NULL, vtype, vtype_pi) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
}
}
proto_item_set_end(container_pi, tvb, *offset);
p_set_proto_depth(pinfo, proto_thrift, nested_count);
return *offset;
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_compact_fields(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt)
{
/*
* Compact protocol field header (1 byte, short form) and field value:
* +--------+--------+...+--------+
* |ddddtttt| field value |
* +--------+--------+...+--------+
*
* Compact protocol field header (2 to 4 bytes, long form) and field value:
* +--------+--------+...+--------+--------+...+--------+
* |0000tttt| field id | field value |
* +--------+--------+...+--------+--------+...+--------+
*
* Compact protocol stop field (1 byte):
* +--------+
* |00000000|
* +--------+
*
* Where:
*
* 'dddd' is the field id delta, a strictly positive unsigned 4 bits integer.
* 'tttt' is the type of the field value, a strictly positive unsigned 4 bits integer.
* field id is the numerical value of the field in the structure.
* field value is the encoded value.
*/
/* This function does not create the subtree, it's the responsibility of the caller:
* - either dissect_thrift_common which creates the "Data" sub-tree,
* - or dissect_thrift_compact_struct which creates the "Struct" sub-tree.
*/
thrift_field_header_t field_header = {
.type.compact = DE_THRIFT_C_STOP, // Overwritten by dissect_thrift_field_header() but undetected by Clang.
};
thrift_opt->previous_field_id = 0;
while (true) {
if (dissect_thrift_field_header(tvb, pinfo, tree, offset, thrift_opt, &field_header, true) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
if (field_header.type.compact == DE_THRIFT_C_STOP) {
break; /* Need to break out of the loop, cannot do that in the switch. */
}
if (!is_thrift_compact_bool_type(field_header.type.compact) &&
dissect_thrift_compact_type(tvb, pinfo, tree, offset, thrift_opt, field_header.fh_tree, field_header.type.compact, field_header.type_pi) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
thrift_opt->previous_field_id = field_header.field_id;
}
return *offset;
}
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_compact_struct(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt)
{
/* This function only creates the "Struct" sub-tree
* then it delegates the fields dissection to dissect_thrift_compact_fields.
*/
proto_tree *sub_tree;
proto_item *pi;
unsigned nested_count = p_get_proto_depth(pinfo, proto_thrift);
ABORT_ON_INCOMPLETE_PDU(TCP_THRIFT_STRUCT_LEN);
if (nested_count >= thrift_opt->nested_type_depth) {
expert_add_info(pinfo, proto_tree_get_parent(tree), &ei_thrift_too_many_subtypes);
return THRIFT_REQUEST_REASSEMBLY;
}
p_set_proto_depth(pinfo, proto_thrift, nested_count + 1);
pi = proto_tree_add_item(tree, hf_thrift_struct, tvb, *offset, -1, ENC_NA);
sub_tree = proto_item_add_subtree(pi, ett_thrift_struct);
if (dissect_thrift_compact_fields(tvb, pinfo, sub_tree, offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
} else {
proto_item_set_end(pi, tvb, *offset);
}
p_set_proto_depth(pinfo, proto_thrift, nested_count);
return *offset;
}
/* Dissect a compact thrift field of a given type.
*
* This function is used only for linear containers (list, set, map).
* It uses the same type identifiers as TCompactProtocol, except for
* the bool type which is encoded in the same way as BOOL_FALSE (2).
*/
static int
// NOLINTNEXTLINE(misc-no-recursion)
dissect_thrift_compact_type(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int *offset, thrift_option_data_t *thrift_opt, proto_tree *header_tree, int type, proto_item *type_pi)
{
switch (type) {
case DE_THRIFT_C_BOOL_FALSE:
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_BOOL_LEN);
proto_tree_add_item(tree, hf_thrift_bool, tvb, *offset, TBP_THRIFT_BOOL_LEN, ENC_BIG_ENDIAN);
*offset += TBP_THRIFT_BOOL_LEN;
break;
case DE_THRIFT_C_I8:
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_I8_LEN);
proto_tree_add_item(tree, hf_thrift_i8, tvb, *offset, TBP_THRIFT_I8_LEN, ENC_BIG_ENDIAN);
*offset += TBP_THRIFT_I8_LEN;
break;
case DE_THRIFT_C_I16:
if (dissect_thrift_varint(tvb, pinfo, tree, offset, thrift_opt, TCP_THRIFT_MAX_I16_LEN, hf_thrift_i16, NULL) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
case DE_THRIFT_C_I32:
if (dissect_thrift_varint(tvb, pinfo, tree, offset, thrift_opt, TCP_THRIFT_MAX_I32_LEN, hf_thrift_i32, NULL) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
case DE_THRIFT_C_I64:
if (dissect_thrift_varint(tvb, pinfo, tree, offset, thrift_opt, TCP_THRIFT_MAX_I64_LEN, hf_thrift_i64, NULL) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
case DE_THRIFT_C_DOUBLE:
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_DOUBLE_LEN);
/* https://github.com/apache/thrift/blob/master/doc/specs/thrift-compact-protocol.md
* In section double encoding:
* "But while the binary protocol encodes the int64 in 8 bytes in big endian order,
* the compact protocol encodes it in little endian order - this is due to an early
* implementation bug that finally became the de-facto standard."
*/
proto_tree_add_item(tree, hf_thrift_double, tvb, *offset, TBP_THRIFT_DOUBLE_LEN, ENC_LITTLE_ENDIAN);
*offset += TBP_THRIFT_DOUBLE_LEN;
break;
case DE_THRIFT_C_UUID:
ABORT_ON_INCOMPLETE_PDU(TBP_THRIFT_UUID_LEN);
proto_tree_add_item(tree, hf_thrift_uuid, tvb, *offset, TBP_THRIFT_UUID_LEN, ENC_BIG_ENDIAN);
*offset += TBP_THRIFT_UUID_LEN;
break;
case DE_THRIFT_C_BINARY:
if (dissect_thrift_compact_binary(tvb, pinfo, tree, offset, thrift_opt, header_tree) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
case DE_THRIFT_C_LIST:
if (dissect_thrift_compact_list(tvb, pinfo, tree, offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
case DE_THRIFT_C_SET:
if (dissect_thrift_compact_set(tvb, pinfo, tree, offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
case DE_THRIFT_C_MAP:
if (dissect_thrift_compact_map(tvb, pinfo, tree, offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
case DE_THRIFT_C_STRUCT:
if (dissect_thrift_compact_struct(tvb, pinfo, tree, offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY) {
return THRIFT_REQUEST_REASSEMBLY;
}
break;
default:
/* Bail out */
expert_add_info(pinfo, type_pi, &ei_thrift_wrong_type);
return THRIFT_REQUEST_REASSEMBLY;
}
return *offset;
}
/*=====END COMPACT GENERIC DISSECTION=====*/
/*
* End of generic functions
*/
/*
Binary protocol Message, strict encoding, 13+ bytes:
+--------+--------+--------+--------++--------+--------+--------+--------++--------+...+--------++--------+--------+--------+--------++...++--------+
|1vvvvvvv|vvvvvvvv|unused |00000mmm|| name length || name || seq id || || T_STOP |
+--------+--------+--------+--------++--------+--------+--------+--------++--------+...+--------++--------+--------+--------+--------++...++--------+
Where:
* 'vvvvvvvvvvvvvvv' is the version, an unsigned 15 bit number fixed to '1' (in binary: '000 0000 0000 0001'). The leading bit is 1.
* Although for consistency with Compact protocol, we will use |pppppppp|000vvvvv| instead in the display:
* 'pppppppp' = 0x80 for the protocol id and
* '000' 3 zeroed bits as mandated by the specs.
* 'vvvvv' 5 bits for the version (see below).
* 'unused' is an ignored byte.
* 'mmm' is the message type, an unsigned 3 bit integer.
* The 5 leading bits must be '0' as some clients take the whole byte.
* (checked for java in 0.9.1)
* 'name length' is the byte length of the name field, a signed 32 bit integer encoded in network (big endian) order (must be >= 0).
* 'name' is the method name, an UTF-8 encoded string.
* 'seq id' is the sequence id, a signed 32 bit integer encoded in network (big endian) order.
Binary protocol Message, old encoding, 9+ bytes:
+--------+--------+--------+--------++--------+...+--------++--------++--------+--------+--------+--------++...++--------+
| name length || name ||00000mmm|| seq id || || T_STOP |
+--------+--------+--------+--------++--------+...+--------++--------++--------+--------+--------+--------++...++--------+
Where name length, name, mmm, seq id are the same as above.
Because name length must be positive (therefore the first bit is always 0),
the first bit allows the receiver to see whether the strict format or the old format is used.
Note: Double separators indicate how the Thrift parts are sent on the wire depending on the network settings.
There are clients and server in production that do not squeeze as much data as possible in a packet
but push each Thrift write<Type>() call directly to the wire, making it harder to detect
as we only have 4 bytes in the first packet.
Compact protocol Message (5+ bytes):
+--------+--------+--------+...+--------+--------+...+--------+--------+...+--------+...+--------+
|pppppppp|mmmvvvvv| seq id | name length | name | | T_STOP |
+--------+--------+--------+...+--------+--------+...+--------+--------+...+--------+...+--------+
Where:
* 'pppppppp' is the protocol id, fixed to '1000 0010', 0x82.
* 'mmm' is the message type, an unsigned 3 bit integer.
* 'vvvvv' is the version, an unsigned 5 bit integer, fixed to '00001'.
* 'seq id' is the sequence id, a signed 32 bit integer encoded as a varint.
* 'name length' is the byte length of the name field, a signed 32 bit integer encoded as a varint (must be >= 0).
* 'name' is the method name to invoke, an UTF-8 encoded string.
Note: The content of the message is everything after the header until and including the T_STOP last byte,
In both protocols, the content is arranged exactly as the content of a struct.
Framed Transport can encapsulate any protocol version:
+--------+--------+--------+--------+--------+...+--------+--------+
| message length | Any protocol message, T_STOP |
+--------+--------+--------+--------+--------+...+--------+--------+
|<------ message length ------>|
Message types are encoded with the following values:
* _Call_: 1
* _Reply_: 2
* _Exception_: 3
* _Oneway_: 4
*/
/*=====BEGIN HEADER GENERIC DISSECTION=====*/
/* Dissect a unique Thrift TBinaryProtocol PDU and return the effective length of this PDU.
*
* This method is called only if the preliminary verifications have been done so it will use as
* much data as possible and will return THRIFT_REQUEST_REASSEMBLY and ask for reassembly if there is
* not enough data.
*
* In case of TFramedTransport, tcp_dissect_pdus made sure that we had all necessary data so reassembly
* will fail if the effective data is bigger than the frame which is a real error.
*
* Returns:
* - THRIFT_REQUEST_REASSEMBLY = -1 if reassembly is required
* - 0 if an error occurred
* - offset > 0 to indicate the end of the PDU in case of success
*
* This method MUST be called with non-null thrift_opt.
*/
static int
dissect_thrift_common(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset, thrift_option_data_t *thrift_opt)
{
proto_tree *thrift_tree, *sub_tree;
proto_item *thrift_pi, *data_pi;
proto_item *mtype_pi = NULL;
proto_item *fid_pi = NULL;
int start_offset = offset;
int header_offset = 0, data_offset = 0;
int32_t seqid_len = TCP_THRIFT_MAX_I32_LEN;
int32_t str_len_len = TCP_THRIFT_MAX_I32_LEN;
uint8_t mtype;
uint16_t version;
int32_t str_len, seq_id;
int64_t varint;
uint8_t *method_str;
int remaining;
tvbuff_t *msg_tvb;
int len, tframe_length = 0;
bool is_framed, is_compact, request_reasm;
/* Get the current state of dissection. */
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
is_framed = (thrift_opt->tprotocol & PROTO_THRIFT_FRAMED) != 0;
is_compact = (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) != 0;
/* Create the item now in case of malformed buffer to use with expert_add_info() */
thrift_pi = proto_tree_add_item(tree, proto_thrift, tvb, offset, -1, ENC_NA);
thrift_tree = proto_item_add_subtree(thrift_pi, ett_thrift);
data_pi = thrift_pi; /* Used for expert_add_info in case of reassembly before the sub-tree is created. */
if (is_framed) {
/* Thrift documentation indicates a maximum of 16 MB frames by default.
* Configurable since Thrift 0.14.0 so better stay on the safe side.
* We are more tolerant with 2 GiB. */
/* TODO: Add a dissector parameter using the same default as Thrift?
* If we do, check the length in test_thrift_strict as well. */
tframe_length = tvb_get_ntohil(tvb, offset);
if (tframe_length <= 0) {
thrift_tree = proto_item_add_subtree(thrift_pi, ett_thrift_error);
data_pi = proto_tree_add_item(thrift_tree, hf_thrift_frame_length, tvb, offset, TBP_THRIFT_LENGTH_LEN, ENC_BIG_ENDIAN);
expert_add_info(pinfo, data_pi, &ei_thrift_negative_length);
return 0;
}
proto_item_set_len(thrift_pi, TBP_THRIFT_LENGTH_LEN + tframe_length);
/* Keep the same start point to avoid awkward offset calculations */
offset += TBP_THRIFT_LENGTH_LEN;
}
header_offset = offset;
remaining = tvb_reported_length_remaining(tvb, offset);
/* We should be called only when the entire frame is ready
* so we don't need to verify if we have enough data.
* If not framed, anything remaining is obviously greater than 0. */
DISSECTOR_ASSERT(remaining >= tframe_length);
/****************************************************************/
/* Decode the header depending on compact, strict (new) or old. */
/****************************************************************/
if (is_compact) {
if (remaining < TCP_THRIFT_MIN_MESSAGE_LEN) {
goto add_expert_and_reassemble;
}
/* Compact: proto_id|mtype+version|seqid|length|name */
version = tvb_get_ntohs(tvb, offset) & THRIFT_COMPACT_VERSION_VALUE_MASK;
mtype = (tvb_get_ntohs(tvb, offset) & THRIFT_COMPACT_MESSAGE_MASK) >> THRIFT_COMPACT_MESSAGE_SHIFT;
offset += TCP_THRIFT_VERSION_LEN;
/* Pass sequence id */
seqid_len = thrift_get_varint_enc(tvb, pinfo, tree, offset, TCP_THRIFT_MAX_I32_LEN, &varint, ENC_VARINT_ZIGZAG);
/* We use the same reassembly/error convention. */
if (seqid_len <= 0) {
return seqid_len;
}
offset += seqid_len;
if (varint > (int64_t)INT32_MAX || varint < (int64_t)INT32_MIN) {
expert_add_info(pinfo, thrift_pi, &ei_thrift_varint_too_large);
/* Sequence id is only informative, we may be just fine. */
}
seq_id = (int32_t)varint;
/* Read length of method name */
str_len_len = thrift_get_varint_enc(tvb, pinfo, tree, offset, TCP_THRIFT_MAX_I32_LEN, &varint, ENC_VARINT_PROTOBUF);
if (str_len_len <= 0) {
return str_len_len;
}
if (varint > (int64_t)INT32_MAX) {
expert_add_info(pinfo, thrift_pi, &ei_thrift_varint_too_large);
return 0;
}
str_len = (int32_t)varint;
if (str_len < 0) {
expert_add_info(pinfo, thrift_pi, &ei_thrift_negative_length);
return 0;
}
offset += str_len_len;
/* Set method name */
if (tvb_reported_length_remaining(tvb, offset) < str_len) {
goto add_expert_and_reassemble;
}
method_str = tvb_get_string_enc(pinfo->pool, tvb, offset, str_len, ENC_UTF_8);
offset += str_len;
} else if (thrift_opt->tprotocol & PROTO_THRIFT_STRICT) {
if (remaining < TBP_THRIFT_STRICT_MIN_MESSAGE_LEN) {
goto add_expert_and_reassemble;
}
version = tvb_get_ntohs(tvb, offset) & THRIFT_BINARY_VERSION_VALUE_MASK;
mtype = tvb_get_uint8(tvb, offset + TBP_THRIFT_MTYPE_OFFSET) & THRIFT_BINARY_MESSAGE_MASK;
str_len = tvb_get_ntohil(tvb, offset + TBP_THRIFT_VERSION_LEN);
if (str_len < 0) {
expert_add_info(pinfo, thrift_pi, &ei_thrift_negative_length);
return 0;
}
if (remaining < TBP_THRIFT_STRICT_MIN_MESSAGE_LEN + str_len) {
goto add_expert_and_reassemble;
}
offset += TBP_THRIFT_VERSION_LEN + TBP_THRIFT_LENGTH_LEN;
method_str = tvb_get_string_enc(pinfo->pool, tvb, offset, str_len, ENC_UTF_8);
offset += str_len;
seq_id = tvb_get_ntohil(tvb, offset);
offset += TBP_THRIFT_SEQ_ID_LEN;
} else {
if (remaining < TBP_THRIFT_MIN_MESSAGE_LEN) {
goto add_expert_and_reassemble;
}
version = 0;
str_len = tvb_get_ntohil(tvb, offset);
if (str_len < 0) {
expert_add_info(pinfo, thrift_pi, &ei_thrift_negative_length);
return 0;
}
if (remaining < TBP_THRIFT_MIN_MESSAGE_LEN + str_len) {
goto add_expert_and_reassemble;
}
offset += TBP_THRIFT_LENGTH_LEN;
method_str = tvb_get_string_enc(pinfo->pool, tvb, offset, str_len, ENC_UTF_8);
offset += str_len;
mtype = tvb_get_uint8(tvb, offset + TBP_THRIFT_LENGTH_LEN + str_len) & THRIFT_BINARY_MESSAGE_MASK;
offset += TBP_THRIFT_TYPE_LEN;
seq_id = tvb_get_ntohil(tvb, offset);
offset += TBP_THRIFT_SEQ_ID_LEN;
}
data_offset = offset;
/* Can be used in case of error, in particular when TFramedTransport is in use. */
thrift_opt->reassembly_tree = thrift_tree;
thrift_opt->reassembly_offset = start_offset;
thrift_opt->reassembly_length = -1;
thrift_opt->mtype = (thrift_method_type_enum_t)mtype;
/*****************************************************/
/* Create the header tree with the extracted fields. */
/*****************************************************/
col_append_sep_fstr(pinfo->cinfo, COL_INFO, ", ", "%s %s", val_to_str(mtype, thrift_mtype_vals, "%d"), method_str);
if (thrift_tree) {
offset = start_offset; /* Reset parsing position. */
if (is_framed) {
proto_tree_add_item(thrift_tree, hf_thrift_frame_length, tvb, offset, TBP_THRIFT_LENGTH_LEN, ENC_BIG_ENDIAN);
offset += TBP_THRIFT_LENGTH_LEN;
}
sub_tree = proto_tree_add_subtree_format(thrift_tree, tvb, header_offset, data_offset - header_offset, ett_thrift_header, &data_pi,
"%s [version: %d, seqid: %d, method: %s]",
val_to_str(mtype, thrift_mtype_vals, "%d"),
version, seq_id, method_str);
/* Decode the header depending on compact, strict (new) or old. */
if (is_compact) {
/* Compact: proto_id|mtype+version|seqid|length|name */
proto_tree_add_item(sub_tree, hf_thrift_protocol_id, tvb, offset, TBP_THRIFT_TYPE_LEN, ENC_BIG_ENDIAN);
proto_tree_add_bits_item(sub_tree, hf_thrift_version, tvb, (offset << OCTETS_TO_BITS_SHIFT) + 11, 5, ENC_BIG_ENDIAN);
mtype_pi = proto_tree_add_bits_item(sub_tree, hf_thrift_mtype, tvb, (offset << OCTETS_TO_BITS_SHIFT) + 8, 3, ENC_BIG_ENDIAN);
offset += TCP_THRIFT_VERSION_LEN;
proto_tree_add_int(sub_tree, hf_thrift_seq_id, tvb, offset, seqid_len, seq_id);
offset += seqid_len;
proto_tree_add_int(sub_tree, hf_thrift_str_len, tvb, offset, str_len_len, str_len);
offset += str_len_len;
proto_tree_add_item(sub_tree, hf_thrift_method, tvb, offset, str_len, ENC_UTF_8);
offset = offset + str_len;
} else if (thrift_opt->tprotocol & PROTO_THRIFT_STRICT) {
/* Strict: proto_id|version|mtype|length|name|seqid */
proto_tree_add_item(sub_tree, hf_thrift_protocol_id, tvb, offset, TBP_THRIFT_TYPE_LEN, ENC_BIG_ENDIAN);
proto_tree_add_bits_item(sub_tree, hf_thrift_version, tvb, (offset << OCTETS_TO_BITS_SHIFT) + 11, 5, ENC_BIG_ENDIAN);
offset += TBP_THRIFT_MTYPE_OFFSET;
mtype_pi = proto_tree_add_bits_item(sub_tree, hf_thrift_mtype, tvb, (offset << OCTETS_TO_BITS_SHIFT) + 5, 3, ENC_BIG_ENDIAN);
offset += TBP_THRIFT_MTYPE_LEN;
proto_tree_add_item(sub_tree, hf_thrift_str_len, tvb, offset, TBP_THRIFT_LENGTH_LEN, ENC_BIG_ENDIAN);
offset += TBP_THRIFT_LENGTH_LEN;
proto_tree_add_item(sub_tree, hf_thrift_method, tvb, offset, str_len, ENC_UTF_8);
offset = offset + str_len;
proto_tree_add_item(sub_tree, hf_thrift_seq_id, tvb, offset, TBP_THRIFT_SEQ_ID_LEN, ENC_BIG_ENDIAN);
offset += TBP_THRIFT_SEQ_ID_LEN;
} else {
/* Old: length|name|mtype|seqid */
proto_tree_add_item(sub_tree, hf_thrift_str_len, tvb, offset, TBP_THRIFT_LENGTH_LEN, ENC_BIG_ENDIAN);
offset += TBP_THRIFT_LENGTH_LEN;
proto_tree_add_item(sub_tree, hf_thrift_method, tvb, offset, str_len, ENC_UTF_8);
offset = offset + str_len;
mtype_pi = proto_tree_add_bits_item(sub_tree, hf_thrift_mtype, tvb, (offset << OCTETS_TO_BITS_SHIFT) + 5, 3, ENC_BIG_ENDIAN);
offset += TBP_THRIFT_MTYPE_LEN;
proto_tree_add_item(sub_tree, hf_thrift_seq_id, tvb, offset, TBP_THRIFT_SEQ_ID_LEN, ENC_BIG_ENDIAN);
offset += TBP_THRIFT_SEQ_ID_LEN;
}
DISSECTOR_ASSERT(offset == data_offset);
}
/* TODO: Save CALL seq_id to link with matching REPLY|EXCEPTION for conversation_t. */
/* TODO: Track the command name as well? Act differently for null & non-null seq_id? */
if (tvb_reported_length_remaining(tvb, data_offset) < TBP_THRIFT_TYPE_LEN) {
goto add_expert_and_reassemble;
}
/***********************************************************/
/* Call method dissector here using dissector_try_string() */
/* except in case of EXCEPTION for detailed dissection. */
/***********************************************************/
thrift_opt->previous_field_id = 0;
msg_tvb = tvb_new_subset_remaining(tvb, data_offset);
if (thrift_opt->mtype == ME_THRIFT_T_REPLY) {
thrift_field_header_t header = {
.field_id = 0, // Overwritten by dissect_thrift_field_header() but undetected by Clang.
};
/* For REPLY, in order to separate successful answers from errors (exceptions),
* Thrift generates a struct with as much fields (all optional) as there are exceptions possible + 1.
* At most 1 field will be filled for any reply
* - Field id = 0: The effective type of the return value of the method (not set if void).
* - Field id > 0: The number of the exception that was raised by the method.
* Note: This is different from the ME_THRIFT_T_EXCEPTION method type that is used in case the method is unknown
* or the PDU invalid/impossible to decode for the other endpoint.
* We read this before checking for sub-dissectors as the information might be useful to them.
*/
int result = data_offset;
result = dissect_thrift_field_header(tvb, pinfo, NULL, &result, thrift_opt, &header, false);
switch (result) {
case THRIFT_REQUEST_REASSEMBLY:
goto add_expert_and_reassemble;
case THRIFT_SUBDISSECTOR_ERROR:
return 0;
default:
break;
}
thrift_opt->reply_field_id = header.field_id;
fid_pi = header.fid_pi;
}
if (thrift_opt->mtype != ME_THRIFT_T_EXCEPTION) {
if (pinfo->can_desegment > 0) pinfo->can_desegment++;
len = dissector_try_string(thrift_method_name_dissector_table, method_str, msg_tvb, pinfo, tree, thrift_opt);
if (pinfo->can_desegment > 0) pinfo->can_desegment--;
} else {
/* Attach the expert_info to the method type as it is a protocol-level exception. */
expert_add_info(pinfo, mtype_pi, &ei_thrift_protocol_exception);
/* Leverage the sub-dissector capabilities to dissect Thrift exceptions. */
len = dissect_thrift_t_struct(msg_tvb, pinfo, thrift_tree, 0, thrift_opt, false, 0, hf_thrift_exception, ett_thrift_exception, thrift_exception);
}
if (len > 0) {
/* The sub dissector dissected the tvb*/
if (!is_framed) {
proto_item_set_end(thrift_pi, msg_tvb, len);
}
return data_offset + len;
} else if (len == THRIFT_REQUEST_REASSEMBLY) {
/* The sub-dissector requested more bytes (len = -1) */
goto reassemble_pdu;
} else if (len <= THRIFT_SUBDISSECTOR_ERROR) {
/* All other negative values are treated as error codes (only -2 is recommended). */
if (!try_generic_if_sub_dissector_fails) {
return 0;
}
/* else { Fallback to dissect using the generic dissector. } */
} /* else len = 0, no specific sub-dissector. */
/***********************/
/* Generic dissection. */
/***********************/
sub_tree = proto_tree_add_subtree(thrift_tree, tvb, data_offset, -1, ett_thrift_params, &data_pi, "Data");
thrift_opt->reassembly_length = TBP_THRIFT_TYPE_LEN;
if (thrift_opt->reply_field_id != 0) {
expert_add_info(pinfo, fid_pi, &ei_thrift_application_exception);
proto_item_set_text(data_pi, "Exception: %" PRId64, thrift_opt->reply_field_id);
}
if (is_compact) {
request_reasm = dissect_thrift_compact_fields(tvb, pinfo, sub_tree, &offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY;
} else { /* Binary (strict/old distinction only applies to the header) */
request_reasm = dissect_thrift_binary_fields(tvb, pinfo, sub_tree, &offset, thrift_opt) == THRIFT_REQUEST_REASSEMBLY;
}
/* Check the result of the Data part dissection. */
if (request_reasm) {
if (offset > 0) {
/* An error occurred at the given offset, consume everything. */
return tvb_reported_length(tvb);
} /* else It's really a reassembly request. */
goto reassemble_pdu;
} else {
/* We found the end of the data. */
proto_item_set_end(data_pi, tvb, offset);
}
/* Set the end of the global Thrift tree (except if framed because it's already set),
* as well as the end of the Data sub-tree. */
if (!is_framed) {
/* In case the frame is larger than the data, we need to know the difference. */
proto_item_set_end(thrift_pi, tvb, offset);
}
proto_item_set_end(data_pi, tvb, offset);
return offset;
add_expert_and_reassemble: /* When detected in this function. */
expert_add_info(pinfo, data_pi, &ei_thrift_not_enough_data);
reassemble_pdu: /* When detected by any called function (that already added the expert info). */
/* We did not encounter final T_STOP. */
pinfo->desegment_offset = start_offset;
pinfo->desegment_len = DESEGMENT_ONE_MORE_SEGMENT;
return THRIFT_REQUEST_REASSEMBLY;
}
/* For tcp_dissect_pdus. */
static unsigned
get_framed_thrift_pdu_len(packet_info *pinfo _U_, tvbuff_t *tvb, int offset, void *data _U_)
{
return (unsigned)TBP_THRIFT_LENGTH_LEN + tvb_get_ntohl(tvb, offset);
}
/* Effective dissection once the exact encoding has been determined.
* - Calls dissect_thrift_common in a loop until end of a packet matches end of Thrift PDU.
*
* This method MUST be called with non-null thrift_opt.
*/
static int
dissect_thrift_loop(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, thrift_option_data_t *thrift_opt)
{
int32_t offset = 0;
int32_t hdr_offset = 0;
int32_t last_pdu_start_offset = 0;
int32_t remaining = tvb_reported_length_remaining(tvb, offset);
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
/* Loop until the end of the packet coincides with the end of a PDU. */
while (remaining > 0) {
last_pdu_start_offset = offset;
if (remaining < TBP_THRIFT_LENGTH_LEN) {
goto reassemble_pdu;
}
if (thrift_opt->tprotocol & PROTO_THRIFT_COMPACT) {
offset = dissect_thrift_common(tvb, pinfo, tree, offset, thrift_opt);
} else {
/* According to Thrift documentation, old and new (strict) binary protocols
* could coexist on a single server so we cannot assume it's still the same.
* In particular, client could send a first request in old format to get
* the server version and switch to strict if the server is up-to-date
* or if it rejected explicitly the old format (there's an example for that). */
if (tvb_get_int8(tvb, offset + hdr_offset) < 0) {
/* Strict header (If only the message type is incorrect, assume this is a new one. */
if (!is_thrift_strict_version(tvb_get_ntohl(tvb, offset + hdr_offset), true)) {
expert_add_info(pinfo, NULL, &ei_thrift_wrong_proto_version);
return tvb_reported_length_remaining(tvb, 0);
}
thrift_opt->tprotocol = (thrift_protocol_enum_t)(thrift_opt->tprotocol | PROTO_THRIFT_STRICT);
} else {
/* Old header. */
thrift_opt->tprotocol = (thrift_protocol_enum_t)(thrift_opt->tprotocol & ~PROTO_THRIFT_STRICT);
}
offset = dissect_thrift_common(tvb, pinfo, tree, offset, thrift_opt);
}
if (offset == THRIFT_REQUEST_REASSEMBLY) {
goto reassemble_pdu;
} else if (offset == 0) {
/* An error occurred, we just stop, consuming everything. */
return tvb_reported_length_remaining(tvb, 0);
}
remaining = tvb_reported_length_remaining(tvb, offset);
}
return offset;
reassemble_pdu:
/* We did not encounter a final T_STOP exactly at the last byte. */
pinfo->desegment_offset = last_pdu_start_offset;
pinfo->desegment_len = DESEGMENT_ONE_MORE_SEGMENT;
return tvb_reported_length(tvb);
}
/* Dissect a unique Thrift PDU within a TFramedTransport and return the effective length of this PDU.
*
* This method is called only if the preliminary verifications have been done including length.
* This method will throw if there is not enough data or too much data.
*
* This method MUST be called with non-null thrift_opt/data using thrift_option_data_t effective type.
*/
static int
dissect_thrift_framed(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data)
{
int32_t offset = 0;
int32_t frame_len = 0;
int32_t reported = tvb_reported_length_remaining(tvb, offset);
thrift_option_data_t *thrift_opt = (thrift_option_data_t *)data;
DISSECTOR_ASSERT(thrift_opt);
DISSECTOR_ASSERT(thrift_opt->canary == THRIFT_OPTION_DATA_CANARY);
DISSECTOR_ASSERT(thrift_opt->tprotocol & PROTO_THRIFT_FRAMED);
frame_len = tvb_get_ntohil(tvb, offset);
// Note: The framed dissector can be called even if the entire packet is bigger than the frame.
// This can happen when the frame was initially rejected because it was too short.
DISSECTOR_ASSERT((frame_len + TBP_THRIFT_LENGTH_LEN) <= reported);
offset = dissect_thrift_common(tvb, pinfo, tree, offset, thrift_opt);
if (offset == THRIFT_REQUEST_REASSEMBLY) {
/* No reassembly possible in this case */
proto_tree_add_expert(thrift_opt->reassembly_tree, pinfo, &ei_thrift_frame_too_short,
tvb, thrift_opt->reassembly_offset, thrift_opt->reassembly_length);
pinfo->desegment_offset = reported;
pinfo->desegment_len = 0;
} else if (offset > 0 && tvb_reported_length_remaining(tvb, offset) > 0) {
proto_tree_add_expert(thrift_opt->reassembly_tree, pinfo, &ei_thrift_frame_too_long,
tvb, offset, tvb_reported_length_remaining(tvb, offset));
}
return reported;
}
/* Thrift dissection when forced by Decode As… or port selection */
static int
dissect_thrift_transport(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
int32_t str_len, length = tvb_reported_length(tvb);
thrift_option_data_t thrift_opt;
memset(&thrift_opt, 0, sizeof(thrift_option_data_t));
thrift_opt.nested_type_depth = nested_type_depth;
/* Starting without even the version / frame length / name length probably means a Keep-Alive at the beginning of the capture. */
if (length < TBP_THRIFT_VERSION_LEN) {
if (tvb_get_uint8(tvb, 0) != (THRIFT_COMPACT_VERSION_1 >> 8)) {
proto_tree_add_expert(tree, pinfo, &ei_thrift_not_enough_data, tvb, 0, length);
/* Not a Thrift packet, maybe a keep-alive at the beginning of the capture. */
return NOT_A_VALID_PDU;
} /* else this might be a compact capture without Nagle activated. */
}
/* Need at least the old encoding header (Name Length + Method + Sequence Id) + ending T_STOP */
if (length < TBP_THRIFT_MIN_MESSAGE_LEN) {
/* Note: if Nagle algorithm is not active, some systems can spit out Thrift individual elements one by one.
* For instance on strict protocol:
* Frame x+0: 4 bytes = version + method type (sent using writeI32)
* Frame x+1: 4 bytes = method length
* Frame x+2: n bytes = method name
* Frame x+3: 4 bytes = sequence id
* Frame x+4: 1 byte = field type… */
goto reassemble_pdu;
}
/* MSb of first byte is 1 for compact and binary strict protocols
* and 0 for framed transport and old binary protocol. */
if (tvb_get_int8(tvb, 0) >= 0) {
/* Option 1 = old binary
* Option 2 = framed strict binary
* Option 3 = framed old binary
* Option 4 = framed compact or anything not handled. */
int remaining = tvb_reported_length_remaining(tvb, TBP_THRIFT_LENGTH_LEN); /* Remaining after initial 4 bytes of "length" */
/* Old header. */
str_len = tvb_get_ntohil(tvb, 0);
if (remaining == 0) {
/* The endpoint probably does not have Nagle activated, wait for next packet. */
goto reassemble_pdu;
}
/* Checking for old binary option. */
if (remaining < str_len) {
/* Not enough data to check name validity.
* Even without Nagle activated, this is /not/ plain old binary Thrift data (or method name is awfully long).
* Non-framed old binary is not possible, consider framed data only. */
// TODO: Display available data & error in case we can't reassemble?
pinfo->desegment_len = str_len - remaining;
/* Maybe we should return NOT_A_VALID_PDU instead and drop this packet but port preferences tells us this /is/ Thrift data. */
return THRIFT_REQUEST_REASSEMBLY;
}
if (thrift_binary_utf8_isprint(tvb, TBP_THRIFT_LENGTH_LEN, str_len, false) == str_len) {
/* UTF-8 valid data means first byte is greater than 0x20 and not between 0x80 and 0xbf (neither 0x80 nor 0x82 in particular).
* This would indicate a method name longer than 512 MiB in Framed old binary protocol which is insane.
* Therefore, most sane option is old binary without any framing. */
thrift_opt.canary = THRIFT_OPTION_DATA_CANARY;
thrift_opt.tprotocol = PROTO_THRIFT_BINARY;
/* Name length + name + method + seq_id + T_STOP */
if (length < TBP_THRIFT_MIN_MESSAGE_LEN + str_len) {
goto reassemble_pdu;
}
} else {
/* This cannot be non-framed old binary so it must be framed (and we have all of it). */
if (str_len < TBP_THRIFT_MIN_MESSAGE_LEN) {
/* This is /not/ valid Framed data. */
return NOT_A_VALID_PDU;
}
if (tvb_get_int8(tvb, TBP_THRIFT_LENGTH_LEN) >= 0) {
/* Framed old binary format is the only matching option remaining. */
thrift_opt.canary = THRIFT_OPTION_DATA_CANARY;
thrift_opt.tprotocol = PROTO_THRIFT_FRAMED;
} else {
if (is_thrift_strict_version(tvb_get_ntohl(tvb, TBP_THRIFT_LENGTH_LEN), true)) {
/* Framed strict binary protocol. */
thrift_opt.canary = THRIFT_OPTION_DATA_CANARY;
thrift_opt.tprotocol = (thrift_protocol_enum_t)(PROTO_THRIFT_FRAMED | PROTO_THRIFT_STRICT);
} else {
/* Framed compact protocol or something else entirely, bail out. */
return NOT_A_VALID_PDU;
}
}
}
} else if (is_thrift_strict_version(tvb_get_ntohl(tvb, 0), true)) {
/* We don't need all the checks from the heuristic because the user prefs told us it /is/ Thrift data.
* If it fails, it will probably pass through otherwise hard-to-reach code-paths so that's good for tests. */
thrift_opt.canary = THRIFT_OPTION_DATA_CANARY;
thrift_opt.tprotocol = PROTO_THRIFT_STRICT;
} else if (tvb_get_uint8(tvb, 0) == 0x82) {
/* Same thing here so 0x82 gives us the TCompactProtocol answer. */
thrift_opt.canary = THRIFT_OPTION_DATA_CANARY;
thrift_opt.tprotocol = PROTO_THRIFT_COMPACT;
} else {
/* else { Not a Thrift packet. } */
return NOT_A_VALID_PDU;
}
col_set_str(pinfo->cinfo, COL_PROTOCOL, "THRIFT");
col_clear(pinfo->cinfo, COL_INFO);
if (thrift_opt.tprotocol & PROTO_THRIFT_FRAMED) {
tcp_dissect_pdus(tvb, pinfo, tree, framed_desegment, TBP_THRIFT_LENGTH_LEN,
get_framed_thrift_pdu_len, dissect_thrift_framed, &thrift_opt);
return tvb_reported_length(tvb);
} else {
return dissect_thrift_loop(tvb, pinfo, tree, &thrift_opt);
}
reassemble_pdu:
pinfo->desegment_offset = 0;
pinfo->desegment_len = DESEGMENT_ONE_MORE_SEGMENT;
return THRIFT_REQUEST_REASSEMBLY;
}
/* Test if the captured packet matches a Thrift strict binary packet header.
* We check for captured and not reported length because:
* - We need to check the content to verify validity;
* - We must not have exception in heuristic dissector.
* Due to that, we might have false negative if the capture is too much shorten
* but it would have been useless anyway.
*/
static bool
test_thrift_strict(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree _U_, thrift_option_data_t *thrift_opt)
{
int tframe_length = 0;
int offset = 0;
unsigned length = tvb_captured_length(tvb);
int32_t str_len;
/* This heuristic only detects strict binary protocol, possibly framed.
* Detection of old binary protocol is tricky due to the lack of fixed data.
* TODO: Maybe by assuming a maximum size for the method name like 1kB… or less.
*
* In order to avoid false positive, the first packet is expected to contain:
* 1. Possibly Frame size (4 bytes, if MSb of first byte is 0),
* 2. Thrift "version" (4 bytes = 0x8001..0m, containing protocol id, version, and method type),
* 3. Method length (4 bytes),
* 4. Method name (method length bytes, verified as acceptable UTF-8),
* 5. Sequence ID (4 bytes, content not verified),
* 6. First field type (1 byte, content not verified). */
/* Enough data for elements 2 to 6? */
if (length < (unsigned)TBP_THRIFT_STRICT_HEADER_LEN) {
return false;
}
/* 1. Check if it is framed (and if the frame length is large enough for a complete message). */
if (tvb_get_int8(tvb, offset) >= 0) {
/* It is framed. */
tframe_length = tvb_get_ntohil(tvb, offset);
if (tframe_length < TBP_THRIFT_STRICT_MIN_MESSAGE_LEN) {
return false;
}
offset = TBP_THRIFT_LENGTH_LEN; /* Strict header starts after frame length. */
if (length < (unsigned)(offset + TBP_THRIFT_STRICT_HEADER_LEN)) {
return false;
}
}
if (thrift_opt) {
thrift_opt->canary = THRIFT_OPTION_DATA_CANARY;
/* Set the protocol used since we now have enough information. */
thrift_opt->tprotocol = PROTO_THRIFT_STRICT;
if (tframe_length > 0) {
thrift_opt->tprotocol = (thrift_protocol_enum_t)(thrift_opt->tprotocol | PROTO_THRIFT_FRAMED);
}
} else REPORT_DISSECTOR_BUG("%s called without data structure.", G_STRFUNC);
/* 2. Thrift version & method type (heuristic does /not/ ignore the message type). */
if (!is_thrift_strict_version(tvb_get_ntohl(tvb, offset), false)) {
return false;
}
offset += TBP_THRIFT_VERSION_LEN;
/* 3. Get method name length and check against what we have. */
str_len = tvb_get_ntohil(tvb, offset);
if ((tframe_length > 0) && (tframe_length < TBP_THRIFT_STRICT_MIN_MESSAGE_LEN + str_len)) {
/* The frame cannot even contain an empty Thrift message (no data, only T_STOP after the sequence id). */
return false;
}
offset += TBP_THRIFT_LENGTH_LEN;
/* 4. Check method name itself. */
if (tvb_captured_length_remaining(tvb, offset) < str_len) {
/* Method name is no entirely captured, we cannot check it. */
return false;
}
if (thrift_binary_utf8_isprint(tvb, offset, str_len, false) < str_len) {
return false;
}
offset += str_len;
/* 5 & 6. Check that there is enough data remaining for a sequence ID and a field type (but no need for it to be captured). */
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_LENGTH_LEN + TBP_THRIFT_TYPE_LEN) {
return false;
}
thrift_opt->canary = THRIFT_OPTION_DATA_CANARY;
return true;
}
/* Test if the captured packet matches a Thrift compact packet header.
* Same comments as for test_thrift_strict.
*/
static bool
test_thrift_compact(tvbuff_t *tvb, packet_info *pinfo _U_, proto_tree *tree _U_, thrift_option_data_t *thrift_opt)
{
int tframe_length = 0;
int offset = 0;
unsigned length = tvb_captured_length(tvb);
int len_len;
int32_t str_len = 0;
uint64_t seq_id;
/* This heuristic detects compact protocol, possibly framed.
* Note: It assumes a maximum size of 127 bytes for the method name.
* Increasing the limit would be easy but this is the heuristic.
*
* In order to avoid false positive, the first packet is expected to contain:
* 1. Possibly Frame size (4 bytes, if MSb of first byte is 0),
* 2. Thrift "version" (2 bytes = 0x82mv, containing protocol id, method type, and version),
* 3. Sequence ID (1 to 5 bytes, content not verified),
* 4. Method length (theoretically 1 to 5 bytes, in practice only 1 byte is accepted),
* 5. Method name (method length bytes, verified as acceptable UTF-8),
* 6. First field type (1 byte, content not verified). */
/* Enough data for elements 2 to 6? */
if (length < (unsigned)TCP_THRIFT_MIN_MESSAGE_LEN) {
return false;
}
/* 1. Check if it is framed (and if the frame length is large enough for a complete message). */
if (tvb_get_int8(tvb, offset) >= 0) {
/* It is framed. */
tframe_length = tvb_get_ntohil(tvb, offset);
if (tframe_length < TCP_THRIFT_MIN_MESSAGE_LEN) {
return false;
}
offset = TBP_THRIFT_LENGTH_LEN; /* Compact header starts after frame length. */
if (length < (unsigned)(offset + TCP_THRIFT_MIN_MESSAGE_LEN)) {
return false;
}
}
if (thrift_opt) {
thrift_opt->canary = THRIFT_OPTION_DATA_CANARY;
/* Set the protocol used since we now have enough information. */
if (tframe_length > 0) {
thrift_opt->tprotocol = (thrift_protocol_enum_t)(PROTO_THRIFT_COMPACT | PROTO_THRIFT_FRAMED);
} else {
thrift_opt->tprotocol = PROTO_THRIFT_COMPACT;
}
} else REPORT_DISSECTOR_BUG("%s called without data structure.", G_STRFUNC);
/* 2. Thrift version & method type (heuristic does /not/ ignore the message type). */
if (!is_thrift_compact_version(tvb_get_ntohs(tvb, offset), false)) {
return false;
}
offset += TCP_THRIFT_VERSION_LEN;
/* 3. Sequence id in varint encoding. We need to make sure we don't try to read not captured data. */
len_len = tvb_captured_length_remaining(tvb, offset);
if (len_len > TCP_THRIFT_MAX_I32_LEN) {
len_len = TCP_THRIFT_MAX_I32_LEN;
}
len_len = tvb_get_varint(tvb, offset, len_len, &seq_id, ENC_VARINT_ZIGZAG);
if (len_len == 0) return false;
offset += len_len;
/* 4. Get method name length and check against what we have. */
if ((unsigned)offset >= length) return false;
str_len = tvb_get_uint8(tvb, offset);
// MSb = 1 means the method length is greater than 127 bytes long.
if ((str_len & 0x80) != 0) {
return false; // Reject it to avoid too many false positive.
}
++offset;
if ((tframe_length > 0) && (TBP_THRIFT_LENGTH_LEN + tframe_length < offset + str_len)) {
/* The frame cannot even contain an empty Thrift message (no data, only T_STOP after the sequence id). */
return false;
}
/* 5. Check method name itself. */
if (tvb_captured_length_remaining(tvb, offset) < str_len) {
/* Method name is no entirely captured, we cannot check it. */
return false;
}
if (thrift_binary_utf8_isprint(tvb, offset, str_len, false) < str_len) {
return false;
}
offset += str_len;
/* 6. Check that there is enough data remaining for a field type (but no need for it to be captured). */
if (tvb_reported_length_remaining(tvb, offset) < TBP_THRIFT_TYPE_LEN) {
return false;
}
thrift_opt->canary = THRIFT_OPTION_DATA_CANARY;
return true;
}
/* Thrift heuristic dissection when the packet is not grabbed by another protocol dissector. */
static bool
dissect_thrift_heur(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data _U_)
{
thrift_option_data_t thrift_opt;
memset(&thrift_opt, 0, sizeof(thrift_option_data_t));
thrift_opt.nested_type_depth = nested_type_depth;
if (!test_thrift_strict(tvb, pinfo, tree, &thrift_opt) && !test_thrift_compact(tvb, pinfo, tree, &thrift_opt)) {
return false;
}
col_set_str(pinfo->cinfo, COL_PROTOCOL, "THRIFT");
col_clear(pinfo->cinfo, COL_INFO);
if (thrift_opt.tprotocol & PROTO_THRIFT_FRAMED) {
tcp_dissect_pdus(tvb, pinfo, tree, framed_desegment, TBP_THRIFT_LENGTH_LEN,
get_framed_thrift_pdu_len, dissect_thrift_framed, &thrift_opt);
} else {
dissect_thrift_loop(tvb, pinfo, tree, &thrift_opt);
}
return true;
}
static int
dissect_thrift_http(tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, void *data)
{
return dissect_thrift_heur(tvb, pinfo, tree, data) ? tvb_captured_length(tvb) : 0;
}
/*=====END HEADER GENERIC DISSECTION=====*/
void
proto_register_thrift(void)
{
static hf_register_info hf[] = {
{ &hf_thrift_frame_length,
{ "Frame length", "thrift.frame_len",
FT_INT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_exception,
{ "Exception", "thrift.exception",
FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_exception_message,
{ "Exception Message", "thrift.exception.message",
FT_STRING, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_exception_type,
{ "Exception Type", "thrift.exception.type",
FT_INT32, BASE_DEC, VALS(thrift_exception_type_vals), 0x0,
NULL, HFILL }
},
{ &hf_thrift_protocol_id,
{ "Protocol id", "thrift.protocol_id",
FT_UINT8, BASE_HEX, VALS(thrift_proto_vals), 0x0,
NULL, HFILL }
},
{ &hf_thrift_version,
{ "Version", "thrift.version",
FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_mtype,
{ "Message type", "thrift.mtype",
FT_UINT8, BASE_HEX, VALS(thrift_mtype_vals), 0x0,
NULL, HFILL }
},
{ &hf_thrift_str_len,
{ "Length", "thrift.str_len",
FT_INT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_method,
{ "Method", "thrift.method",
FT_STRING, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_seq_id,
{ "Sequence Id", "thrift.seq_id",
FT_INT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_type,
{ "Type", "thrift.type",
FT_UINT8, BASE_HEX, VALS(thrift_type_vals), 0x0,
NULL, HFILL }
},
{ &hf_thrift_key_type,
{ "Key Type", "thrift.type",
FT_UINT8, BASE_HEX, VALS(thrift_type_vals), 0x0,
NULL, HFILL }
},
{ &hf_thrift_value_type,
{ "Value Type", "thrift.type",
FT_UINT8, BASE_HEX, VALS(thrift_type_vals), 0x0,
NULL, HFILL }
},
{ &hf_thrift_compact_struct_type,
{ "Type", "thrift.type",
FT_UINT8, BASE_HEX, VALS(thrift_compact_type_vals), 0x0,
NULL, HFILL }
},
{ &hf_thrift_fid,
{ "Field Id", "thrift.fid",
FT_INT16, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_fid_delta,
{ "Field Id Delta", "thrift.fid_delta",
FT_UINT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_bool,
{ "Boolean", "thrift.bool",
FT_BOOLEAN, BASE_NONE, NULL, 0x0, /* libthrift (C++) also considers boolean value = (byte != 0x00) */
NULL, HFILL }
},
{ &hf_thrift_i8,
{ "Integer8", "thrift.i8",
FT_INT8, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_i16,
{ "Integer16", "thrift.i16",
FT_INT16, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_i32,
{ "Integer32", "thrift.i32",
FT_INT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_i64,
{ "Integer64", "thrift.i64",
FT_INT64, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_double,
{ "Double", "thrift.double",
FT_DOUBLE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_binary,
{ "Binary", "thrift.binary",
FT_BYTES, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_string,
{ "String", "thrift.string",
FT_STRING, BASE_NONE, NULL, 0x0,
"Binary field interpreted as a string.", HFILL }
},
{ &hf_thrift_struct,
{ "Struct", "thrift.struct",
FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_list,
{ "List", "thrift.list",
FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_set,
{ "Set", "thrift.set",
FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_map,
{ "Map", "thrift.map",
FT_NONE, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_num_set_item,
{ "Number of Set Items", "thrift.num_set_item",
FT_INT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_num_set_pos,
{ "Number of Set Items", "thrift.num_set_pos",
FT_UINT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_num_list_item,
{ "Number of List Items", "thrift.num_list_item",
FT_INT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_num_list_pos,
{ "Number of List Items", "thrift.num_list_pos",
FT_UINT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_num_map_item,
{ "Number of Map Items", "thrift.num_map_item",
FT_INT32, BASE_DEC, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_large_container,
{ "More than 14 items", "thrift.num_item",
FT_UINT8, BASE_HEX, NULL, 0x0,
NULL, HFILL }
},
{ &hf_thrift_uuid,
{ "UUID", "thrift.uuid",
FT_GUID, BASE_NONE, NULL, 0x0,
NULL, HFILL }
},
};
/* setup protocol subtree arrays */
static int *ett[] = {
&ett_thrift,
&ett_thrift_header,
&ett_thrift_params,
&ett_thrift_field,
&ett_thrift_struct,
&ett_thrift_list,
&ett_thrift_set,
&ett_thrift_map,
&ett_thrift_error,
&ett_thrift_exception,
};
static ei_register_info ei[] = {
{ &ei_thrift_wrong_type, { "thrift.wrong_type", PI_PROTOCOL, PI_ERROR, "Type value not expected.", EXPFILL } },
{ &ei_thrift_wrong_field_id, { "thrift.wrong_field_id", PI_PROTOCOL, PI_WARN, "Field id different from value provided by sub-dissector.", EXPFILL } },
{ &ei_thrift_negative_length, { "thrift.negative_length", PI_PROTOCOL, PI_ERROR, "Length greater than 2 GiB not supported.", EXPFILL } },
{ &ei_thrift_wrong_proto_version, { "thrift.wrong_proto_version", PI_MALFORMED, PI_ERROR, "Protocol version invalid or unsupported.", EXPFILL } },
{ &ei_thrift_struct_fid_not_in_seq, { "thrift.struct_fid_not_in_seq", PI_PROTOCOL, PI_ERROR, "Missing mandatory field id in struct.", EXPFILL } },
{ &ei_thrift_not_enough_data, { "thrift.not_enough_data", PI_PROTOCOL, PI_WARN, "Not enough data to decode.", EXPFILL } },
{ &ei_thrift_frame_too_short, { "thrift.frame_too_short", PI_MALFORMED, PI_ERROR, "Thrift frame shorter than data.", EXPFILL } },
{ &ei_thrift_frame_too_long, { "thrift.frame_too_long", PI_PROTOCOL, PI_WARN, "Thrift frame longer than data.", EXPFILL } },
{ &ei_thrift_varint_too_large, { "thrift.varint_too_large", PI_PROTOCOL, PI_ERROR, "Thrift varint value too large for target integer type.", EXPFILL } },
{ &ei_thrift_undefined_field_id, { "thrift.undefined_field_id", PI_PROTOCOL, PI_NOTE, "Field id not defined by sub-dissector, using generic Thrift dissector.", EXPFILL } },
{ &ei_thrift_negative_field_id, { "thrift.negative_field_id", PI_PROTOCOL, PI_NOTE, "Encountered unexpected negative field id, possibly an old application.", EXPFILL } },
{ &ei_thrift_unordered_field_id, { "thrift.unordered_field_id", PI_PROTOCOL, PI_WARN, "Field id not in strictly increasing order.", EXPFILL } },
{ &ei_thrift_application_exception, { "thrift.application_exception", PI_PROTOCOL, PI_NOTE, "The application recognized the method but rejected the content.", EXPFILL } },
{ &ei_thrift_protocol_exception, { "thrift.protocol_exception", PI_PROTOCOL, PI_WARN, "The application was not able to handle the request.", EXPFILL } },
{ &ei_thrift_too_many_subtypes, { "thrift.too_many_subtypes", PI_PROTOCOL, PI_ERROR, "Too many level of sub-types nesting.", EXPFILL } },
};
module_t *thrift_module;
expert_module_t *expert_thrift;
/* Register protocol name and description */
proto_thrift = proto_register_protocol("Thrift Protocol", "Thrift", "thrift");
expert_thrift = expert_register_protocol(proto_thrift);
/* register field array */
proto_register_field_array(proto_thrift, hf, array_length(hf));
/* register subtree array */
proto_register_subtree_array(ett, array_length(ett));
expert_register_field_array(expert_thrift, ei, array_length(ei));
/* register dissector */
thrift_handle = register_dissector("thrift", dissect_thrift_transport, proto_thrift);
thrift_http_handle = register_dissector("thrift.http", dissect_thrift_http, proto_thrift);
thrift_module = prefs_register_protocol(proto_thrift, proto_reg_handoff_thrift);
thrift_method_name_dissector_table = register_dissector_table("thrift.method_names", "Thrift Method names",
proto_thrift, FT_STRING, STRING_CASE_SENSITIVE); /* Thrift is case-sensitive. */
prefs_register_enum_preference(thrift_module, "decode_binary",
"Display binary as bytes or strings",
"How the binary should be decoded",
&binary_decode, binary_display_options, false);
prefs_register_uint_preference(thrift_module, "tls.port",
"Thrift TLS port",
"Thrift TLS port",
10, &thrift_tls_port);
prefs_register_bool_preference(thrift_module, "show_internal",
"Show internal Thrift fields in the dissection tree",
"Whether the Thrift dissector should display Thrift internal fields for sub-dissectors.",
&show_internal_thrift_fields);
prefs_register_bool_preference(thrift_module, "fallback_on_generic",
"Fallback to generic Thrift dissector if sub-dissector fails.",
"Whether the Thrift dissector should try to dissect the data if the sub-dissector failed."
" This option can be useful if the data is well-formed but the sub-dissector is expecting different type/content.",
&try_generic_if_sub_dissector_fails);
prefs_register_uint_preference(thrift_module, "nested_type_depth",
"Thrift nested types depth",
"Maximum expected depth of nested types in the Thrift structures and containers."
" A Thrift-based protocol using no parameter and void return types only uses a depth of 0."
" A Thrift-based protocol using only simple types as parameters or return values uses a depth of 1.",
10, &nested_type_depth);
prefs_register_bool_preference(thrift_module, "desegment_framed",
"Reassemble Framed Thrift messages spanning multiple TCP segments",
"Whether the Thrift dissector should reassemble framed messages spanning multiple TCP segments."
" To use this option, you must also enable \"Allow subdissectors to reassemble TCP streams\" in the TCP protocol settings.",
&framed_desegment);
}
void
proto_reg_handoff_thrift(void)
{
static unsigned saved_thrift_tls_port;
static bool thrift_initialized = false;
if (!thrift_initialized) {
thrift_initialized = true;
heur_dissector_add("tcp", dissect_thrift_heur, "Thrift over TCP", "thrift_tcp", proto_thrift, HEURISTIC_ENABLE);
heur_dissector_add("udp", dissect_thrift_heur, "Thrift over UDP", "thrift_udp", proto_thrift, HEURISTIC_ENABLE);
heur_dissector_add("usb.bulk", dissect_thrift_heur, "Thrift over USB", "thrift_usb_bulk", proto_thrift, HEURISTIC_ENABLE);
dissector_add_for_decode_as_with_preference("tcp.port", thrift_handle);
dissector_add_for_decode_as_with_preference("udp.port", thrift_handle);
dissector_add_string("media_type", "application/x-thrift", thrift_http_handle); /* Obsolete but still in use. */
dissector_add_string("media_type", "application/vnd.apache.thrift.binary", thrift_http_handle); /* Officially registered. */
} else {
ssl_dissector_delete(saved_thrift_tls_port, thrift_handle);
}
ssl_dissector_add(thrift_tls_port, thrift_handle);
saved_thrift_tls_port = thrift_tls_port;
}
/*
* Editor modelines - https://www.wireshark.org/tools/modelines.html
*
* Local variables:
* c-basic-offset: 4
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* vi: set shiftwidth=4 tabstop=8 expandtab:
* :indentSize=4:tabSize=8:noTabs=true:
*/
|