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
|
/*
* Copyright (c) 2003 Endace Technology Ltd, Hamilton, New Zealand.
* All rights reserved.
*
* This software and documentation has been developed by Endace Technology Ltd.
* along with the DAG PCI network capture cards. For further information please
* visit http://www.endace.com/.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
/*
* erf - Endace ERF (Extensible Record Format)
*
* Rev A:
* http://web.archive.org/web/20050829051042/http://www.endace.com/support/EndaceRecordFormat.pdf
* Version 1:
* http://web.archive.org/web/20061111014023/http://www.endace.com/support/EndaceRecordFormat.pdf
* Version 8:
* https://gitlab.com/wireshark/wireshark/uploads/f694bfee494784425b6545892180a8b2/Endace_ERF_Types.pdf
* (bug #4484)
* Current version (version 21, as of 2023-03-28):
* https://www.endace.com/erf-extensible-record-format-types.pdf
*
* Note that version 17 drops descriptions of records for no-longer-supported
* DAG cards. Version 16 is probably the best version to use for those
* older record types, but it's not in any obvious location in the Wayback
* Machine.
*/
#include "config.h"
#include "erf.h"
#include <stdlib.h>
#include <string.h>
#include <glib.h>
#include <wsutil/crc32.h>
#include <wsutil/pint.h>
#include <wsutil/strtoi.h>
#include <wsutil/glib-compat.h>
#include <wsutil/ws_padding_to.h>
#include "wtap-int.h"
#include "file_wrappers.h"
#include "erf_record.h"
#include "erf-common.h"
struct erf_anchor_mapping {
uint64_t host_id;
uint64_t anchor_id;
uint64_t gen_time;
char *comment;
};
static const unsigned erf_header_size = (unsigned)sizeof(erf_header_t);
static const unsigned erf_mc_header_size = (unsigned)sizeof(erf_mc_header_t);
static const unsigned erf_eth_hdr_size = (unsigned)sizeof(erf_eth_header_t);
static bool erf_read_header(wtap *wth, FILE_T fh,
wtap_rec *rec,
erf_header_t *erf_header,
int *err,
char **err_info,
uint32_t *bytes_read,
uint32_t *packet_size,
GPtrArray *anchor_mappings_to_update);
static bool erf_read(wtap *wth, wtap_rec *rec,
int *err, char **err_info, int64_t *data_offset);
static bool erf_seek_read(wtap *wth, int64_t seek_off,
wtap_rec *rec,
int *err, char **err_info);
static void erf_close(wtap *wth);
static int populate_summary_info(erf_t *erf_priv, wtap *wth, wtap_rec *rec, uint32_t packet_size, GPtrArray *anchor_mappings_to_update, int *err, char **err_info);
static int erf_update_anchors_from_header(erf_t *erf_priv, wtap_rec *rec, union wtap_pseudo_header *pseudo_header, uint64_t host_id, GPtrArray *anchor_mappings_to_update);
static int erf_get_source_from_header(union wtap_pseudo_header *pseudo_header, uint64_t *host_id, uint8_t *source_id);
static int erf_populate_interface(erf_t* erf_priv, wtap *wth, union wtap_pseudo_header *pseudo_header, uint64_t host_id, uint8_t source_id, uint8_t if_num, int *err, char **err_info);
typedef struct {
bool write_next_extra_meta;
bool last_meta_periodic;
uint64_t host_id;
uint64_t implicit_host_id;
uint64_t prev_frame_ts;
uint8_t prev_erf_type;
uint64_t gen_time;
time_t first_frame_time_sec;
time_t prev_inserted_time_sec;
char* user_comment_ptr;
GPtrArray* periodic_sections;
GArray *periodic_extra_ehdrs;
GRand *rand;
} erf_dump_t;
static erf_dump_t* erf_dump_priv_create(void);
static void erf_dump_priv_free(erf_dump_t *dump_priv);
static bool erf_dump_priv_compare_capture_comment(wtap_dumper *wdh, erf_dump_t *dump_priv,const union wtap_pseudo_header *pseudo_header, const uint8_t *pd);
static bool erf_comment_to_sections(wtap_dumper *wdh, uint16_t section_type, uint16_t section_id, char *comment, GPtrArray *sections);
static bool erf_wtap_info_to_sections(wtap_dumper *wdh, GPtrArray *sections);
static bool get_user_comment_string(wtap_dumper *wdh, char** user_comment_ptr);
static bool erf_write_meta_record(wtap_dumper *wdh, erf_dump_t *dump_priv, uint64_t timestamp, GPtrArray *sections, GArray *extra_ehdrs, int *err);
static const struct {
int erf_encap_value;
int wtap_encap_value;
} erf_to_wtap_map[] = {
{ ERF_TYPE_HDLC_POS, WTAP_ENCAP_CHDLC },
{ ERF_TYPE_HDLC_POS, WTAP_ENCAP_HHDLC },
{ ERF_TYPE_HDLC_POS, WTAP_ENCAP_CHDLC_WITH_PHDR },
{ ERF_TYPE_HDLC_POS, WTAP_ENCAP_PPP },
{ ERF_TYPE_HDLC_POS, WTAP_ENCAP_FRELAY },
{ ERF_TYPE_HDLC_POS, WTAP_ENCAP_MTP2 },
{ ERF_TYPE_ETH, WTAP_ENCAP_ETHERNET },
{ 99, WTAP_ENCAP_ERF }, /*this type added so WTAP_ENCAP_ERF will work and then be treated at ERF->ERF*/
};
#define NUM_ERF_ENCAPS array_length(erf_to_wtap_map)
#define ERF_META_TAG_HEADERLEN 4
#define ERF_META_TAG_TOTAL_ALIGNED_LENGTH(taglength) ((((uint32_t)taglength + 0x3U) & ~0x3U) + ERF_META_TAG_HEADERLEN)
#define ERF_META_TAG_ALIGNED_LENGTH(taglength) ((((uint32_t)taglength + 0x3U) & ~0x3U))
struct erf_if_info {
int if_index;
char *name;
char *descr;
int stream_num;
struct {
unsigned filter:1;
unsigned fcs_len:1;
unsigned snaplen:1;
} set_flags;
};
struct erf_if_mapping {
uint64_t host_id;
uint8_t source_id;
struct erf_if_info interfaces[ERF_MAX_INTERFACES];
char *module_filter_str;
/*here because we could have captures from multiple hosts in the file*/
char *capture_filter_str;
int8_t module_fcs_len;
uint32_t module_snaplen;
int interface_metadata;
uint64_t interface_gentime;
uint64_t module_gentime;
};
struct erf_meta_section {
uint16_t type;
uint16_t section_id;
uint16_t section_length;
GPtrArray *tags;
};
struct erf_meta_tag {
uint16_t type;
uint16_t length;
uint8_t *value;
};
struct erf_meta_read_state {
uint8_t *tag_ptr;
uint32_t remaining_len;
struct erf_if_mapping *if_map;
uint16_t sectiontype;
uint16_t sectionid;
uint16_t parentsectiontype;
uint16_t parentsectionid;
uint64_t gen_time;
int interface_metadata;
};
static bool erf_wtap_blocks_to_erf_sections(wtap_block_t block, GPtrArray *sections, uint16_t section_type, uint16_t section_id, wtap_block_foreach_func func);
static uint32_t erf_meta_read_tag(struct erf_meta_tag*, uint8_t*, uint32_t);
static int erf_file_type_subtype = -1;
void register_erf(void);
static unsigned erf_anchor_mapping_hash(const void *key) {
const struct erf_anchor_mapping *anchor_map = (const struct erf_anchor_mapping*) key;
return ((uint32_t)anchor_map->host_id ^ (uint32_t)anchor_map->anchor_id);
}
static gboolean erf_anchor_mapping_equal(const void *a, const void *b) {
const struct erf_anchor_mapping *anchor_map_a = (const struct erf_anchor_mapping*) a ;
const struct erf_anchor_mapping *anchor_map_b = (const struct erf_anchor_mapping*) b ;
return (anchor_map_a->host_id) == (anchor_map_b->host_id) &&
(anchor_map_a->anchor_id & ERF_EXT_HDR_TYPE_ANCHOR_ID) == (anchor_map_b->anchor_id & ERF_EXT_HDR_TYPE_ANCHOR_ID);
}
static void erf_anchor_mapping_destroy(void *key) {
struct erf_anchor_mapping *anchor_map = (struct erf_anchor_mapping*) key;
if(anchor_map->comment != NULL) {
g_free(anchor_map->comment);
anchor_map->comment = NULL;
}
g_free(anchor_map);
anchor_map = NULL;
}
static gboolean erf_if_mapping_equal(const void *a, const void *b)
{
const struct erf_if_mapping *if_map_a = (const struct erf_if_mapping*) a;
const struct erf_if_mapping *if_map_b = (const struct erf_if_mapping*) b;
return if_map_a->source_id == if_map_b->source_id && if_map_a->host_id == if_map_b->host_id;
}
static unsigned erf_if_mapping_hash(const void *key)
{
const struct erf_if_mapping *if_map = (const struct erf_if_mapping*) key;
return (((unsigned) if_map->host_id) << 16) | if_map->source_id;
}
static void erf_if_mapping_destroy(void *key)
{
int i = 0;
struct erf_if_mapping *if_map = (struct erf_if_mapping*) key;
for (i = 0; i < ERF_MAX_INTERFACES; i++) {
g_free(if_map->interfaces[i].name);
g_free(if_map->interfaces[i].descr);
}
g_free(if_map->module_filter_str);
g_free(if_map);
}
static struct erf_if_mapping* erf_if_mapping_create(uint64_t host_id, uint8_t source_id)
{
int i = 0;
struct erf_if_mapping *if_map = NULL;
if_map = g_new0(struct erf_if_mapping, 1);
if_map->host_id = host_id;
if_map->source_id = source_id;
for (i = 0; i < ERF_MAX_INTERFACES; i++) {
if_map->interfaces[i].if_index = -1;
if_map->interfaces[i].stream_num = -1;
}
if_map->module_fcs_len = -1;
if_map->module_snaplen = (uint32_t) -1;
/* everything else 0 by g_malloc0*/
return if_map;
}
erf_t *erf_priv_create(void)
{
erf_t *erf_priv;
erf_priv = g_new(erf_t, 1);
erf_priv->anchor_map = g_hash_table_new_full(erf_anchor_mapping_hash, erf_anchor_mapping_equal, erf_anchor_mapping_destroy, NULL);
erf_priv->if_map = g_hash_table_new_full(erf_if_mapping_hash, erf_if_mapping_equal, erf_if_mapping_destroy, NULL);
erf_priv->implicit_host_id = ERF_META_HOST_ID_IMPLICIT;
erf_priv->capture_gentime = 0;
erf_priv->host_gentime = 0;
return erf_priv;
}
erf_t* erf_priv_free(erf_t* erf_priv)
{
if (erf_priv)
{
g_hash_table_destroy(erf_priv->anchor_map);
g_hash_table_destroy(erf_priv->if_map);
g_free(erf_priv);
}
return NULL;
}
static void erf_dump_priv_free(erf_dump_t *dump_priv) {
if(dump_priv) {
if(dump_priv->periodic_sections) {
g_ptr_array_free(dump_priv->periodic_sections, true);
}
if(dump_priv->periodic_extra_ehdrs) {
g_array_free(dump_priv->periodic_extra_ehdrs, true);
}
if(dump_priv->user_comment_ptr) {
g_free(dump_priv->user_comment_ptr);
}
g_free(dump_priv->rand);
g_free(dump_priv);
}
}
static void erf_meta_section_free(void *data) {
struct erf_meta_section *section_ptr = (struct erf_meta_section*) data;
if (section_ptr) {
g_ptr_array_free(section_ptr->tags, true);
section_ptr->tags = NULL;
}
g_free(section_ptr);
}
static void erf_meta_tag_free(void *data) {
struct erf_meta_tag *tag_ptr = (struct erf_meta_tag*) data;
if (tag_ptr) {
g_free(tag_ptr->value);
tag_ptr->value = NULL;
}
g_free(tag_ptr);
}
static bool erf_dump_finish(struct wtap_dumper *wdh, int *err, char **err_info _U_) {
erf_dump_t *dump_priv = (erf_dump_t*)wdh->priv;
bool ret = true;
/* Write final metadata record. There are some corner cases where we should
* do this (file <1 second, last record was ERF_TYPE_META with an out of date
* comment) and there is no harm doing this always if we have already written
* some metadata. */
if(dump_priv->write_next_extra_meta) {
if (!dump_priv->periodic_sections) {
dump_priv->periodic_sections = g_ptr_array_new_with_free_func(erf_meta_section_free);
if (dump_priv->prev_erf_type == ERF_TYPE_META && dump_priv->last_meta_periodic) {
erf_comment_to_sections(wdh, ERF_META_SECTION_CAPTURE, 0, dump_priv->user_comment_ptr, dump_priv->periodic_sections);
} else {
/* If we get here, metadata record was not found in the first ~1 sec
* but we have either a capture comment or a non-ERF file (see
* erf_dump_open) */
erf_wtap_info_to_sections(wdh, dump_priv->periodic_sections);
}
}
if (!erf_write_meta_record(wdh, dump_priv, dump_priv->prev_frame_ts, dump_priv->periodic_sections, dump_priv->periodic_extra_ehdrs, err)) ret = false;
}
/* Clean up */
erf_dump_priv_free(dump_priv);
/* Avoid double freeing by setting it to NULL*/
wdh->priv = NULL;
return ret;
}
static void
erf_free_data(void *data, void *user_data _U_)
{
g_free(data);
}
extern wtap_open_return_val erf_open(wtap *wth, int *err, char **err_info)
{
int i, n, records_for_erf_check = RECORDS_FOR_ERF_CHECK;
int valid_prev = 0;
char *s;
erf_timestamp_t prevts,ts;
erf_header_t header;
uint32_t mc_hdr;
struct erf_eth_hdr eth_hdr;
uint32_t packet_size;
uint16_t rlen;
uint64_t erf_ext_header;
unsigned erf_ext_header_size = (unsigned)sizeof(erf_ext_header);
uint8_t type;
prevts = 0;
/* number of records to scan before deciding if this really is ERF */
if ((s = getenv("ERF_RECORDS_TO_CHECK")) != NULL) {
if (ws_strtoi32(s, NULL, &n) && n >= 0 && n < 101) {
records_for_erf_check = n;
}
}
/*
* ERF is a little hard because there's no magic number; we look at
* the first few records and see if they look enough like ERF
* records.
*/
for (i = 0; i < records_for_erf_check; i++) { /* records_for_erf_check */
if (!wtap_read_bytes_or_eof(wth->fh,&header,erf_header_size,err,err_info)) {
if (*err == 0) {
/* EOF - all records have been successfully checked, accept the file */
break;
}
if (*err == WTAP_ERR_SHORT_READ) {
/* ERF header too short accept the file,
only if the very first records have been successfully checked */
if (i < MIN_RECORDS_FOR_ERF_CHECK) {
return WTAP_OPEN_NOT_MINE;
} else {
/* BREAK, the last record is too short, and will be ignored */
break;
}
} else {
return WTAP_OPEN_ERROR;
}
}
rlen=g_ntohs(header.rlen);
/* fail on invalid record type, invalid rlen, timestamps decreasing, or incrementing too far */
/* Test valid rlen >= 16 */
if (rlen < 16) {
return WTAP_OPEN_NOT_MINE;
}
packet_size = rlen - erf_header_size;
if (packet_size > WTAP_MAX_PACKET_SIZE_STANDARD) {
/*
* Probably a corrupt capture file or a file that's not an ERF file
* but that passed earlier tests.
*/
return WTAP_OPEN_NOT_MINE;
}
/* Skip PAD records, timestamps may not be set */
if ((header.type & 0x7F) == ERF_TYPE_PAD) {
if (!wtap_read_bytes(wth->fh, NULL, packet_size, err, err_info)) {
if (*err != WTAP_ERR_SHORT_READ) {
/* A real error */
return WTAP_OPEN_ERROR;
}
/* ERF record too short, accept the file,
only if the very first records have been successfully checked */
if (i < MIN_RECORDS_FOR_ERF_CHECK) {
return WTAP_OPEN_NOT_MINE;
}
}
continue;
}
/* ERF Type 0 is reserved for ancient legacy records which are not supported, probably not ERF */
if ((header.type & 0x7F) == 0) {
return WTAP_OPEN_NOT_MINE;
}
/* fail on decreasing timestamps */
if ((ts = pletohu64(&header.ts)) < prevts) {
/* reassembled AALx records may not be in time order, also records are not in strict time order between physical interfaces, so allow 1 sec fudge */
if ( ((prevts-ts)>>32) > 1 ) {
return WTAP_OPEN_NOT_MINE;
}
}
/* Check to see if timestamp increment is > 1 year */
if ( (valid_prev) && (ts > prevts) && (((ts-prevts)>>32) > 3600*24*365) ) {
return WTAP_OPEN_NOT_MINE;
}
prevts = ts;
/* Read over the extension headers */
type = header.type;
while (type & 0x80){
if (!wtap_read_bytes(wth->fh,&erf_ext_header,erf_ext_header_size,err,err_info)) {
if (*err == WTAP_ERR_SHORT_READ) {
/* Extension header missing, not an ERF file */
return WTAP_OPEN_NOT_MINE;
}
return WTAP_OPEN_ERROR;
}
if (packet_size < erf_ext_header_size)
return WTAP_OPEN_NOT_MINE;
packet_size -= erf_ext_header_size;
memcpy(&type, &erf_ext_header, sizeof(type));
}
/* Read over MC or ETH subheader */
switch(header.type & 0x7F) {
case ERF_TYPE_MC_HDLC:
case ERF_TYPE_MC_RAW:
case ERF_TYPE_MC_ATM:
case ERF_TYPE_MC_RAW_CHANNEL:
case ERF_TYPE_MC_AAL5:
case ERF_TYPE_MC_AAL2:
case ERF_TYPE_COLOR_MC_HDLC_POS:
case ERF_TYPE_AAL2: /* not an MC type but has a similar 'AAL2 ext' header */
if (!wtap_read_bytes(wth->fh,&mc_hdr,erf_mc_header_size,err,err_info)) {
if (*err == WTAP_ERR_SHORT_READ) {
/* Subheader missing, not an ERF file */
return WTAP_OPEN_NOT_MINE;
}
return WTAP_OPEN_ERROR;
}
if (packet_size < erf_mc_header_size)
return WTAP_OPEN_NOT_MINE;
packet_size -= erf_mc_header_size;
break;
case ERF_TYPE_ETH:
case ERF_TYPE_COLOR_ETH:
case ERF_TYPE_DSM_COLOR_ETH:
case ERF_TYPE_COLOR_HASH_ETH:
if (!wtap_read_bytes(wth->fh,ð_hdr,erf_eth_hdr_size,err,err_info)) {
if (*err == WTAP_ERR_SHORT_READ) {
/* Subheader missing, not an ERF file */
return WTAP_OPEN_NOT_MINE;
}
return WTAP_OPEN_ERROR;
}
if (packet_size < erf_eth_hdr_size)
return WTAP_OPEN_NOT_MINE;
packet_size -= erf_eth_hdr_size;
break;
default:
break;
}
if (!wtap_read_bytes(wth->fh, NULL, packet_size, err, err_info)) {
if (*err != WTAP_ERR_SHORT_READ) {
/* A real error */
return WTAP_OPEN_ERROR;
}
/* ERF record too short, accept the file,
only if the very first records have been successfully checked */
if (i < MIN_RECORDS_FOR_ERF_CHECK) {
return WTAP_OPEN_NOT_MINE;
}
}
valid_prev = 1;
} /* records_for_erf_check */
if (file_seek(wth->fh, 0L, SEEK_SET, err) == -1) { /* rewind */
return WTAP_OPEN_ERROR;
}
/* This is an ERF file */
wth->file_type_subtype = erf_file_type_subtype;
wth->snapshot_length = 0; /* not available in header, only in frame */
/*
* Use the encapsulation for ERF records.
*/
wth->file_encap = WTAP_ENCAP_ERF;
wth->subtype_read = erf_read;
wth->subtype_seek_read = erf_seek_read;
wth->subtype_close = erf_close;
wth->file_tsprec = WTAP_TSPREC_NSEC;
wth->priv = erf_priv_create();
return WTAP_OPEN_MINE;
}
/* Read the next packet */
static bool erf_read(wtap *wth, wtap_rec *rec,
int *err, char **err_info, int64_t *data_offset)
{
erf_header_t erf_header;
uint32_t packet_size, bytes_read;
GPtrArray *anchor_mappings_to_update;
*data_offset = file_tell(wth->fh);
anchor_mappings_to_update = g_ptr_array_new_with_free_func(erf_anchor_mapping_destroy);
do {
if (!erf_read_header(wth, wth->fh, rec, &erf_header,
err, err_info, &bytes_read, &packet_size,
anchor_mappings_to_update)) {
g_ptr_array_free(anchor_mappings_to_update, true);
return false;
}
if (!wtap_read_bytes_buffer(wth->fh, &rec->data, packet_size, err, err_info)) {
g_ptr_array_free(anchor_mappings_to_update, true);
return false;
}
/*
* If Provenance metadata record, frame buffer could hold the meta erf tags.
* It can also contain per packet comments which can be associated to another
* frame.
*/
if ((erf_header.type & 0x7F) == ERF_TYPE_META && packet_size > 0)
{
if (populate_summary_info((erf_t*) wth->priv, wth, rec, packet_size, anchor_mappings_to_update, err, err_info) < 0) {
g_ptr_array_free(anchor_mappings_to_update, true);
return false;
}
}
} while ( erf_header.type == ERF_TYPE_PAD );
g_ptr_array_free(anchor_mappings_to_update, true);
return true;
}
static bool erf_seek_read(wtap *wth, int64_t seek_off,
wtap_rec *rec,
int *err, char **err_info)
{
erf_header_t erf_header;
uint32_t packet_size;
GPtrArray *anchor_mappings_to_update;
if (file_seek(wth->random_fh, seek_off, SEEK_SET, err) == -1)
return false;
anchor_mappings_to_update = g_ptr_array_new_with_free_func(erf_anchor_mapping_destroy);
do {
if (!erf_read_header(wth, wth->random_fh, rec, &erf_header,
err, err_info, NULL, &packet_size, anchor_mappings_to_update)) {
g_ptr_array_free(anchor_mappings_to_update, true);
return false;
}
} while ( erf_header.type == ERF_TYPE_PAD );
g_ptr_array_free(anchor_mappings_to_update, true);
return wtap_read_bytes_buffer(wth->random_fh, &rec->data, packet_size,
err, err_info);
}
static struct erf_anchor_mapping* erf_find_anchor_mapping(erf_t *priv,
uint64_t host_id,
uint64_t anchor_id)
{
struct erf_anchor_mapping mapping = {
host_id,
anchor_id,
0,
NULL
};
if (!priv) {
return NULL;
}
return (struct erf_anchor_mapping*)g_hash_table_lookup(priv->anchor_map, &mapping);
}
static bool erf_read_header(wtap *wth, FILE_T fh,
wtap_rec *rec,
erf_header_t *erf_header,
int *err,
char **err_info,
uint32_t *bytes_read,
uint32_t *packet_size,
GPtrArray *anchor_mappings_to_update)
{
union wtap_pseudo_header *pseudo_header = &rec->rec_header.packet_header.pseudo_header;
uint8_t erf_exhdr[8];
uint64_t erf_exhdr_sw;
uint8_t type = 0;
uint32_t mc_hdr;
uint32_t aal2_hdr;
struct wtap_erf_eth_hdr eth_hdr;
uint32_t skiplen = 0;
int i = 0;
int max = array_length(pseudo_header->erf.ehdr_list);
erf_t *priv = (erf_t*)wth->priv;
int interface_id;
uint64_t host_id = ERF_META_HOST_ID_IMPLICIT;
uint8_t source_id = 0;
uint8_t if_num = 0;
bool host_id_found = false;
if (!wtap_read_bytes_or_eof(fh, erf_header, sizeof(*erf_header), err, err_info)) {
return false;
}
if (bytes_read != NULL) {
*bytes_read = sizeof(*erf_header);
}
*packet_size = g_ntohs(erf_header->rlen) - (uint32_t)sizeof(*erf_header);
if (*packet_size > WTAP_MAX_PACKET_SIZE_STANDARD) {
/*
* Probably a corrupt capture file; don't blow up trying
* to allocate space for an immensely-large packet.
*/
*err = WTAP_ERR_BAD_FILE;
*err_info = ws_strdup_printf("erf: File has %u-byte packet, bigger than maximum of %u",
*packet_size, WTAP_MAX_PACKET_SIZE_STANDARD);
return false;
}
if (*packet_size == 0) {
/* If this isn't a pad record, it's a corrupt packet; bail out */
if ((erf_header->type & 0x7F) != ERF_TYPE_PAD) {
*err = WTAP_ERR_BAD_FILE;
*err_info = g_strdup("erf: File has 0 byte packet");
return false;
}
}
{
uint64_t ts = pletohu64(&erf_header->ts);
/*if ((erf_header->type & 0x7f) != ERF_TYPE_META || wth->file_type_subtype != file_type_subtype_erf) {*/
wtap_setup_packet_rec(rec, wth->file_encap);
rec->block = wtap_block_create(WTAP_BLOCK_PACKET);
/*
* XXX: ERF_TYPE_META records should ideally be FT_SPECIFIC for display
* purposes, but currently ft_specific_record_phdr clashes with erf_mc_phdr
* and the pcapng dumper assumes it is a pcapng block type. Ideally we
* would register a block handler with pcapng and write out the closest
* pcapng block, or a custom block/Provenance record.
*
*/
#if 0
} else {
/*
* TODO: how to identify, distinguish and timestamp events?
* What to do about ENCAP_ERF in pcap/pcapng? Filetype dissector is
* chosen by wth->file_type_subtype?
*/
/* For now just treat all Provenance records as reports */
wtap_setup_ft_specific_report_rec(rec, erf_file_type_subtype,
0x00000000); /* XXX - record type */
rec->block = wtap_block_create(WTAP_BLOCK_FT_SPECIFIC_REPORT);
/* XXX: phdr ft_specific_record_phdr? */
}
#endif
rec->presence_flags = WTAP_HAS_TS|WTAP_HAS_CAP_LEN|WTAP_HAS_INTERFACE_ID;
rec->ts.secs = (long) (ts >> 32);
ts = ((ts & 0xffffffff) * 1000 * 1000 * 1000);
ts += (ts & 0x80000000) << 1; /* rounding */
rec->ts.nsecs = ((int) (ts >> 32));
if (rec->ts.nsecs >= 1000000000) {
rec->ts.nsecs -= 1000000000;
rec->ts.secs += 1;
}
if_num = erf_interface_id_from_flags(erf_header->flags);
}
/* Copy the ERF pseudo header */
memset(&pseudo_header->erf, 0, sizeof(pseudo_header->erf));
pseudo_header->erf.phdr.ts = pletohu64(&erf_header->ts);
pseudo_header->erf.phdr.type = erf_header->type;
pseudo_header->erf.phdr.flags = erf_header->flags;
pseudo_header->erf.phdr.rlen = g_ntohs(erf_header->rlen);
pseudo_header->erf.phdr.lctr = g_ntohs(erf_header->lctr);
pseudo_header->erf.phdr.wlen = g_ntohs(erf_header->wlen);
/* Copy the ERF extension header into the pseudo header */
type = erf_header->type;
while (type & 0x80){
if (!wtap_read_bytes(fh, &erf_exhdr, sizeof(erf_exhdr),
err, err_info))
return false;
if (bytes_read != NULL)
*bytes_read += (uint32_t)sizeof(erf_exhdr);
*packet_size -= (uint32_t)sizeof(erf_exhdr);
skiplen += (uint32_t)sizeof(erf_exhdr);
erf_exhdr_sw = pntohu64(erf_exhdr);
if (i < max)
memcpy(&pseudo_header->erf.ehdr_list[i].ehdr, &erf_exhdr_sw, sizeof(erf_exhdr_sw));
type = erf_exhdr[0];
/*
* XXX: Only want first Source ID and Host ID, and want to preserve HID n SID 0 (see
* erf_populate_interface)
*/
switch (type & 0x7FU) {
case ERF_EXT_HDR_TYPE_HOST_ID:
if (!host_id_found)
host_id = erf_exhdr_sw & ERF_EHDR_HOST_ID_MASK;
host_id_found = true;
/* Fall through */
case ERF_EXT_HDR_TYPE_FLOW_ID:
/* Source ID is present in both Flow ID and Host ID extension headers */
if (!source_id)
source_id = (erf_exhdr_sw >> 48) & 0xff;
break;
case ERF_EXT_HDR_TYPE_ANCHOR_ID:
/* handled below*/
break;
}
i++;
}
interface_id = erf_populate_interface((erf_t*) wth->priv, wth, pseudo_header, host_id, source_id, if_num, err, err_info);
if (interface_id < 0) {
return false;
}
rec->rec_header.packet_header.interface_id = (unsigned) interface_id;
/* Try to find comment links using Anchor ID. Done here after we found the first Host ID and have updated the implicit Host ID. */
erf_update_anchors_from_header(priv, rec, pseudo_header, host_id, anchor_mappings_to_update);
switch (erf_header->type & 0x7F) {
case ERF_TYPE_IPV4:
case ERF_TYPE_IPV6:
case ERF_TYPE_RAW_LINK:
case ERF_TYPE_INFINIBAND:
case ERF_TYPE_INFINIBAND_LINK:
case ERF_TYPE_META:
case ERF_TYPE_OPA_SNC:
case ERF_TYPE_OPA_9B:
#if 0
{
rec->rec_header.packet_header.len = g_htons(erf_header->wlen);
rec->rec_header.packet_header.caplen = g_htons(erf_header->wlen);
}
return true;
#endif
break;
case ERF_TYPE_PAD:
case ERF_TYPE_HDLC_POS:
case ERF_TYPE_COLOR_HDLC_POS:
case ERF_TYPE_DSM_COLOR_HDLC_POS:
case ERF_TYPE_COLOR_HASH_POS:
case ERF_TYPE_ATM:
case ERF_TYPE_AAL5:
break;
case ERF_TYPE_ETH:
case ERF_TYPE_COLOR_ETH:
case ERF_TYPE_DSM_COLOR_ETH:
case ERF_TYPE_COLOR_HASH_ETH:
if (!wtap_read_bytes(fh, ð_hdr, sizeof(eth_hdr), err, err_info))
return false;
if (bytes_read != NULL)
*bytes_read += (uint32_t)sizeof(eth_hdr);
*packet_size -= (uint32_t)sizeof(eth_hdr);
skiplen += (uint32_t)sizeof(eth_hdr);
pseudo_header->erf.subhdr.eth_hdr = eth_hdr;
break;
case ERF_TYPE_MC_HDLC:
case ERF_TYPE_MC_RAW:
case ERF_TYPE_MC_ATM:
case ERF_TYPE_MC_RAW_CHANNEL:
case ERF_TYPE_MC_AAL5:
case ERF_TYPE_MC_AAL2:
case ERF_TYPE_COLOR_MC_HDLC_POS:
if (!wtap_read_bytes(fh, &mc_hdr, sizeof(mc_hdr), err, err_info))
return false;
if (bytes_read != NULL)
*bytes_read += (uint32_t)sizeof(mc_hdr);
*packet_size -= (uint32_t)sizeof(mc_hdr);
skiplen += (uint32_t)sizeof(mc_hdr);
pseudo_header->erf.subhdr.mc_hdr = g_ntohl(mc_hdr);
break;
case ERF_TYPE_AAL2:
if (!wtap_read_bytes(fh, &aal2_hdr, sizeof(aal2_hdr), err, err_info))
return false;
if (bytes_read != NULL)
*bytes_read += (uint32_t)sizeof(aal2_hdr);
*packet_size -= (uint32_t)sizeof(aal2_hdr);
skiplen += (uint32_t)sizeof(aal2_hdr);
pseudo_header->erf.subhdr.aal2_hdr = g_ntohl(aal2_hdr);
break;
case ERF_TYPE_IP_COUNTER:
case ERF_TYPE_TCP_FLOW_COUNTER:
/* unsupported, continue with default: */
default:
/* let the dissector dissect as unknown record type for forwards compatibility */
break;
}
{
rec->rec_header.packet_header.len = g_ntohs(erf_header->wlen);
rec->rec_header.packet_header.caplen = MIN( g_ntohs(erf_header->wlen),
g_ntohs(erf_header->rlen) - (uint32_t)sizeof(*erf_header) - skiplen );
}
if (*packet_size > WTAP_MAX_PACKET_SIZE_STANDARD) {
/*
* Probably a corrupt capture file; don't blow up trying
* to allocate space for an immensely-large packet.
*/
*err = WTAP_ERR_BAD_FILE;
*err_info = ws_strdup_printf("erf: File has %u-byte packet, bigger than maximum of %u",
*packet_size, WTAP_MAX_PACKET_SIZE_STANDARD);
return false;
}
return true;
}
static int wtap_wtap_encap_to_erf_encap(int encap)
{
unsigned int i;
for(i = 0; i < NUM_ERF_ENCAPS; i++){
if(erf_to_wtap_map[i].wtap_encap_value == encap)
return erf_to_wtap_map[i].erf_encap_value;
}
return -1;
}
static bool erf_write_phdr(wtap_dumper *wdh, int encap, const union wtap_pseudo_header *pseudo_header, int * err)
{
uint8_t erf_hdr[sizeof(struct erf_mc_phdr)];
uint8_t erf_subhdr[sizeof(union erf_subhdr)];
uint8_t ehdr[8*MAX_ERF_EHDR];
size_t size = 0;
size_t subhdr_size = 0;
int i = 0;
uint8_t has_more = 0;
switch(encap){
case WTAP_ENCAP_ERF:
memset(&erf_hdr, 0, sizeof(erf_hdr));
phtoleu64(&erf_hdr[0], pseudo_header->erf.phdr.ts);
erf_hdr[8] = pseudo_header->erf.phdr.type;
erf_hdr[9] = pseudo_header->erf.phdr.flags;
phtonu16(&erf_hdr[10], pseudo_header->erf.phdr.rlen);
phtonu16(&erf_hdr[12], pseudo_header->erf.phdr.lctr);
phtonu16(&erf_hdr[14], pseudo_header->erf.phdr.wlen);
size = sizeof(struct erf_phdr);
switch(pseudo_header->erf.phdr.type & 0x7F) {
case ERF_TYPE_MC_HDLC:
case ERF_TYPE_MC_RAW:
case ERF_TYPE_MC_ATM:
case ERF_TYPE_MC_RAW_CHANNEL:
case ERF_TYPE_MC_AAL5:
case ERF_TYPE_MC_AAL2:
case ERF_TYPE_COLOR_MC_HDLC_POS:
phtonu32(&erf_subhdr[0], pseudo_header->erf.subhdr.mc_hdr);
subhdr_size += (int)sizeof(struct erf_mc_hdr);
break;
case ERF_TYPE_AAL2:
phtonu32(&erf_subhdr[0], pseudo_header->erf.subhdr.aal2_hdr);
subhdr_size += (int)sizeof(struct erf_aal2_hdr);
break;
case ERF_TYPE_ETH:
case ERF_TYPE_COLOR_ETH:
case ERF_TYPE_DSM_COLOR_ETH:
case ERF_TYPE_COLOR_HASH_ETH:
memcpy(&erf_subhdr[0], &pseudo_header->erf.subhdr.eth_hdr, sizeof pseudo_header->erf.subhdr.eth_hdr);
subhdr_size += erf_eth_hdr_size;
break;
default:
break;
}
break;
default:
return false;
}
if (!wtap_dump_file_write(wdh, erf_hdr, size, err))
return false;
/*write out up to MAX_ERF_EHDR extension headers*/
has_more = pseudo_header->erf.phdr.type & 0x80;
if(has_more){ /*we have extension headers*/
do{
phtonu64(ehdr+(i*8), pseudo_header->erf.ehdr_list[i].ehdr);
if(i == MAX_ERF_EHDR-1) ehdr[i*8] = ehdr[i*8] & 0x7F;
has_more = ehdr[i*8] & 0x80;
i++;
}while(has_more && i < MAX_ERF_EHDR);
if (!wtap_dump_file_write(wdh, ehdr, 8*i, err))
return false;
}
if(!wtap_dump_file_write(wdh, erf_subhdr, subhdr_size, err))
return false;
return true;
}
static void erf_dump_priv_init_gen_time(erf_dump_t *dump_priv) {
int64_t real_time;
real_time = g_get_real_time();
/* Convert TimeVal to ERF timestamp */
dump_priv->gen_time = ((real_time / G_USEC_PER_SEC) << 32) + ((real_time % G_USEC_PER_SEC) << 32) / 1000 / 1000;
}
static bool erf_write_wtap_option_to_capture_tag(wtap_block_t block _U_,
unsigned option_id,
wtap_opttype_e option_type _U_,
wtap_optval_t *optval,
void* user_data) {
struct erf_meta_section *section_ptr = (struct erf_meta_section*) user_data;
struct erf_meta_tag *tag_ptr = NULL;
tag_ptr = g_new0(struct erf_meta_tag, 1);
switch(option_id) {
case OPT_SHB_USERAPPL:
tag_ptr->type = ERF_META_TAG_app_name;
tag_ptr->value = (uint8_t*)g_strdup(optval->stringval);
tag_ptr->length = (uint16_t)strlen((char*)tag_ptr->value);
break;
case OPT_COMMENT:
tag_ptr->type = ERF_META_TAG_comment;
tag_ptr->value = (uint8_t*)g_strdup(optval->stringval);
tag_ptr->length = (uint16_t)strlen((char*)tag_ptr->value);
break;
default:
erf_meta_tag_free(tag_ptr);
tag_ptr = NULL;
break;
}
if (tag_ptr)
g_ptr_array_add(section_ptr->tags, tag_ptr);
return true; /* we always succeed */
}
static bool erf_write_wtap_option_to_host_tag(wtap_block_t block _U_,
unsigned option_id,
wtap_opttype_e option_type _U_,
wtap_optval_t *optval,
void* user_data) {
struct erf_meta_section *section_ptr = (struct erf_meta_section*) user_data;
struct erf_meta_tag *tag_ptr = NULL;
tag_ptr = g_new0(struct erf_meta_tag, 1);
switch(option_id) {
case OPT_SHB_HARDWARE:
tag_ptr->type = ERF_META_TAG_cpu;
tag_ptr->value = (uint8_t*)g_strdup(optval->stringval);
tag_ptr->length = (uint16_t)strlen((char*)tag_ptr->value);
break;
case OPT_SHB_OS:
tag_ptr->type = ERF_META_TAG_os;
tag_ptr->value = (uint8_t*)g_strdup(optval->stringval);
tag_ptr->length = (uint16_t)strlen((char*)tag_ptr->value);
break;
default:
erf_meta_tag_free(tag_ptr);
tag_ptr = NULL;
break;
}
if (tag_ptr)
g_ptr_array_add(section_ptr->tags, tag_ptr);
return true; /* we always succeed */
}
static bool erf_write_wtap_option_to_interface_tag(wtap_block_t block _U_,
unsigned option_id,
wtap_opttype_e option_type _U_,
wtap_optval_t *optval,
void* user_data) {
struct erf_meta_section *section_ptr = (struct erf_meta_section*) user_data;
struct erf_meta_tag *tag_ptr = NULL;
tag_ptr = g_new0(struct erf_meta_tag, 1);
switch(option_id) {
case OPT_COMMENT:
tag_ptr->type = ERF_META_TAG_comment;
tag_ptr->value = (uint8_t*)g_strdup(optval->stringval);
tag_ptr->length = (uint16_t)strlen((char*)tag_ptr->value);
break;
case OPT_IDB_NAME:
tag_ptr->type = ERF_META_TAG_name;
tag_ptr->value = (uint8_t*)g_strdup(optval->stringval);
tag_ptr->length = (uint16_t)strlen((char*)tag_ptr->value);
break;
case OPT_IDB_DESCRIPTION:
tag_ptr->type = ERF_META_TAG_descr;
tag_ptr->value = (uint8_t*)g_strdup(optval->stringval);
tag_ptr->length = (uint16_t)strlen((char*)tag_ptr->value);
break;
case OPT_IDB_OS:
tag_ptr->type = ERF_META_TAG_os;
tag_ptr->value = (uint8_t*)g_strdup(optval->stringval);
tag_ptr->length = (uint16_t)strlen((char*)tag_ptr->value);
break;
case OPT_IDB_TSOFFSET:
tag_ptr->type = ERF_META_TAG_ts_offset;
tag_ptr->length = 8;
tag_ptr->value = (uint8_t*)g_malloc(sizeof(optval->uint64val));
/* convert to relative ERF timestamp */
phtoleu64(tag_ptr->value, optval->uint64val << 32);
break;
case OPT_IDB_SPEED:
tag_ptr->type = ERF_META_TAG_if_speed;
tag_ptr->length = 8;
tag_ptr->value = (uint8_t*)g_malloc(sizeof(optval->uint64val));
phtonu64(tag_ptr->value, optval->uint64val);
break;
case OPT_IDB_IP4ADDR:
tag_ptr->type = ERF_META_TAG_if_ipv4;
tag_ptr->length = 4;
tag_ptr->value = (uint8_t*)g_malloc(sizeof(optval->ipv4val));
memcpy(tag_ptr->value, &optval->ipv4val, sizeof(optval->ipv4val));
break;
case OPT_IDB_IP6ADDR:
tag_ptr->type = ERF_META_TAG_if_ipv6;
tag_ptr->length = 16;
tag_ptr->value = (uint8_t*)g_malloc(sizeof(optval->ipv6val));
memcpy(tag_ptr->value, &optval->ipv6val, sizeof(optval->ipv6val));
break;
case OPT_IDB_FILTER:
{
if_filter_opt_t *filter;
filter = &optval->if_filterval;
tag_ptr->type = 0xF800;
if(filter->type == if_filter_pcap) {
tag_ptr->type = ERF_META_TAG_filter;
tag_ptr->value = (uint8_t*)g_strdup(filter->data.filter_str);
tag_ptr->length = (uint16_t)strlen((char*)tag_ptr->value);
}
}
break;
case OPT_IDB_FCSLEN:
tag_ptr->type = ERF_META_TAG_fcs_len;
tag_ptr->length = 4;
tag_ptr->value = (uint8_t*)g_malloc(tag_ptr->length);
phtonu32(tag_ptr->value, (uint32_t)optval->uint8val);
break;
/* TODO: Don't know what to do with these yet */
case OPT_IDB_EUIADDR:
#if 0
tag_ptr->type = ERF_META_TAG_if_eui;
tag_ptr->length = 8;
tag_ptr->value = (uint8_t*)g_malloc(sizeof(optval->eui64val));
memcpy(tag_ptr->value, &optval->euival, sizeof(optval->eui64val));
break;
#endif
case OPT_IDB_MACADDR:
#if 0
tag_ptr->type = ERF_META_TAG_if_mac;
tag_ptr->length = 6;
/*value same format as pcapng (6-byte canonical, padded by write
* function automatically to 32-bit boundary)*/
tag_ptr->value = (uint8_t*)g_malloc(sizeof(optval->macval));
memcpy(tag_ptr->value, &optval->macval, sizeof(optval->macval));
break;
#endif
case OPT_IDB_TSRESOL:
case OPT_IDB_TZONE:
/* Fall through */
default:
erf_meta_tag_free(tag_ptr);
tag_ptr = NULL;
break;
}
if (tag_ptr)
g_ptr_array_add(section_ptr->tags, tag_ptr);
return true; /* we always succeed */
}
static void erf_populate_section_length_by_tags(struct erf_meta_section *section_ptr) {
unsigned i = 0;
struct erf_meta_tag *tag_ptr;
section_ptr->section_length = 8;
for(;i < section_ptr->tags->len; i++) {
tag_ptr = (struct erf_meta_tag*)g_ptr_array_index(section_ptr->tags, i);
section_ptr->section_length += ERF_META_TAG_TOTAL_ALIGNED_LENGTH(tag_ptr->length);
}
}
/**
* @brief Converts a wtap_block_t block to ERF metadata sections
* @param block a wtap_block_t block
* @param sections pointer to a GPtrArray containing pointers to sections
* @param section_type the pre-specified section_type
* @param section_id Section ID to assign
* @param func a wtap_block_foreach_func call back function to specify
* what needs to be done on the block
* @return true if success, false if failed
*/
static bool erf_wtap_blocks_to_erf_sections(wtap_block_t block, GPtrArray *sections, uint16_t section_type, uint16_t section_id, wtap_block_foreach_func func) {
if(!block || !sections || !func) {
return false;
}
struct erf_meta_section *section_ptr;
section_ptr = g_new(struct erf_meta_section, 1);
section_ptr->tags = g_ptr_array_new_with_free_func(erf_meta_tag_free);
section_ptr->type = section_type;
section_ptr->section_id = section_id;
wtap_block_foreach_option(block, func, (void*)section_ptr);
erf_populate_section_length_by_tags(section_ptr);
g_ptr_array_add(sections, section_ptr);
return true;
}
static bool erf_meta_write_tag(wtap_dumper *wdh, struct erf_meta_tag *tag_ptr, int *err) {
uint16_t data[2];
unsigned pad = 0;
/* we only need to pad up to 32 bits*/
uint32_t padbuf = 0;
pad = ERF_META_TAG_ALIGNED_LENGTH(tag_ptr->length) - tag_ptr->length;
data[0] = g_htons(tag_ptr->type);
data[1] = g_htons(tag_ptr->length);
if(!wtap_dump_file_write(wdh, data, sizeof(data), err)) return false;
if(!wtap_dump_file_write(wdh, tag_ptr->value, tag_ptr->length, err)) return false;
if(pad) {
if(!wtap_dump_file_write(wdh, &padbuf, pad, err)) return false;
}
return true;
}
static bool erf_meta_write_section(wtap_dumper *wdh, struct erf_meta_section *section_ptr, int *err) {
struct erf_meta_tag *tag_ptr;
unsigned i;
uint16_t data[4];
data[0] = g_htons(section_ptr->type);
data[1] = g_htons(4); /*section header length*/
data[2] = g_htons(section_ptr->section_id);
data[3] = g_htons(section_ptr->section_length);
if(!wtap_dump_file_write(wdh, data, sizeof(data), err)) return false;
for(i = 0; i < section_ptr->tags->len; i++) {
tag_ptr = (struct erf_meta_tag*)g_ptr_array_index(section_ptr->tags, i);
if(!erf_meta_write_tag(wdh, tag_ptr, err)) return false;
}
return true;
}
static bool erf_wtap_info_to_sections(wtap_dumper *wdh, GPtrArray *sections) {
wtap_block_t block;
unsigned i = 0;
block = g_array_index(wdh->shb_hdrs, wtap_block_t, 0);
erf_wtap_blocks_to_erf_sections(block, sections, ERF_META_SECTION_CAPTURE, 0, erf_write_wtap_option_to_capture_tag);
block = g_array_index(wdh->shb_hdrs, wtap_block_t, 0);
erf_wtap_blocks_to_erf_sections(block, sections, ERF_META_SECTION_HOST, 0, erf_write_wtap_option_to_host_tag);
/*TODO: support >4 interfaces by using more Source IDs. Affects more than this
* function as need more metadata records. Just dump them all out for now. */
for(i = 0; i < wdh->interface_data->len; i++) {
block = g_array_index(wdh->interface_data, wtap_block_t, i);
erf_wtap_blocks_to_erf_sections(block, sections, ERF_META_SECTION_INTERFACE, (int16_t)i+1, erf_write_wtap_option_to_interface_tag);
}
return true;
}
static bool erf_comment_to_sections(wtap_dumper *wdh _U_, uint16_t section_type, uint16_t section_id, char *comment, GPtrArray *sections){
struct erf_meta_section *section_ptr;
struct erf_meta_tag *comment_tag_ptr = NULL;
struct erf_meta_tag *user_tag_ptr = NULL;
const char *user = NULL;
/* Generate the section */
section_ptr = g_new(struct erf_meta_section, 1);
section_ptr->type = section_type;
section_ptr->section_id = section_id;
section_ptr->tags = g_ptr_array_new_with_free_func(erf_meta_tag_free);
/* Generate the comment tag */
comment_tag_ptr = g_new(struct erf_meta_tag, 1);
comment_tag_ptr->type = ERF_META_TAG_comment;
/* XXX: if the comment has been cleared write the empty string (which
* conveniently is all a zero length tag which means the value is
* invalidated) */
comment_tag_ptr->value = (uint8_t*)g_strdup(comment ? comment : "");
comment_tag_ptr->length = (uint16_t)strlen((char*)comment_tag_ptr->value);
g_ptr_array_add(section_ptr->tags, comment_tag_ptr);
user = g_get_user_name();
if (user) {
/* Generate username tag */
user_tag_ptr = g_new(struct erf_meta_tag, 1);
user_tag_ptr->type = ERF_META_TAG_user;
user_tag_ptr->value = (uint8_t*)g_strdup(user);
user_tag_ptr->length = (uint16_t)strlen((char*)user_tag_ptr->value);
g_ptr_array_add(section_ptr->tags, user_tag_ptr);
}
erf_populate_section_length_by_tags(section_ptr);
g_ptr_array_add(sections, section_ptr);
return true;
}
static uint64_t erf_get_random_anchor_id(erf_dump_t *dump_priv) {
return (((uint64_t)g_rand_int(dump_priv->rand) << 32) | (uint64_t)g_rand_int(dump_priv->rand)) >> 16;
}
static uint64_t erf_metaid_ext_hdr(uint8_t exthdr_type, uint64_t id, uint8_t srcid_flags) {
uint64_t ext_hdr;
ext_hdr = id & ERF_EHDR_HOST_ID_MASK;
ext_hdr |= ((uint64_t)srcid_flags) << 48;
ext_hdr |= ((uint64_t)exthdr_type) << 56;
return ext_hdr;
}
#define erf_host_id_ext_hdr(host_id, source_id) erf_metaid_ext_hdr(ERF_EXT_HDR_TYPE_HOST_ID, host_id, source_id)
#define erf_anchor_id_ext_hdr(anchor_id, flags) erf_metaid_ext_hdr(ERF_EXT_HDR_TYPE_ANCHOR_ID, anchor_id, flags)
static inline bool erf_add_ext_hdr_to_list(uint64_t ext_hdr, uint64_t comparison_mask, GArray *extra_ehdrs) {
/* check for existing Host ID in set and add */
unsigned i = 0;
struct erf_ehdr ehdr_tmp;
struct erf_ehdr *ehdr_ptr = NULL;
if (!extra_ehdrs)
return false;
ext_hdr = ext_hdr & ~ERF_EHDR_MORE_EXTHDR_MASK;
if (comparison_mask == 0)
comparison_mask = UINT64_MAX;
comparison_mask &= ~ERF_EHDR_MORE_EXTHDR_MASK;
for (i = 0; i < extra_ehdrs->len; i++) {
ehdr_ptr = &g_array_index(extra_ehdrs, struct erf_ehdr, i);
/* Check if we already have this Host ID extension header */
if (ext_hdr == (ehdr_ptr->ehdr & comparison_mask)) {
return true;
}
}
/* set more flag on last extension header */
if (ehdr_ptr) {
ehdr_ptr->ehdr |= ERF_EHDR_MORE_EXTHDR_MASK;
}
ehdr_tmp.ehdr = ext_hdr; /*more flag already cleared above*/
g_array_append_val(extra_ehdrs, ehdr_tmp);
return true;
}
static inline bool erf_append_ext_hdr_to_list(uint64_t ext_hdr, GArray *extra_ehdrs) {
struct erf_ehdr ehdr_tmp;
if (!extra_ehdrs)
return false;
ehdr_tmp.ehdr = ext_hdr & ~ERF_EHDR_MORE_EXTHDR_MASK;
/* set more flag on last extension header */
if (extra_ehdrs->len) {
g_array_index(extra_ehdrs, struct erf_ehdr, extra_ehdrs->len - 1).ehdr |= ERF_EHDR_MORE_EXTHDR_MASK;
}
g_array_append_val(extra_ehdrs, ehdr_tmp);
return true;
}
static bool erf_update_host_id_ext_hdrs_list(erf_dump_t *dump_priv, const union wtap_pseudo_header *pseudo_header, GArray *extra_ehdrs) {
uint8_t type;
uint8_t erf_type;
int has_more;
uint64_t hdr;
int i = 0;
uint8_t source_id = 0;
uint64_t host_id = 0;
bool host_id_found = false;
if (!extra_ehdrs)
return false;
erf_type = pseudo_header->erf.phdr.type & 0x7f;
has_more = pseudo_header->erf.phdr.type & 0x80;
while (has_more && i < MAX_ERF_EHDR) {
hdr = pseudo_header->erf.ehdr_list[i].ehdr;
type = (uint8_t) (hdr >> 56);
switch (type & 0x7f) {
case ERF_EXT_HDR_TYPE_HOST_ID:
host_id = hdr & ERF_EHDR_HOST_ID_MASK;
source_id = (hdr >> 48) & 0xff;
/* Don't add the wireshark Host ID Source ID 0 twice since we already add it to metadata records */
if (host_id != dump_priv->host_id || source_id != 0)
if (!erf_add_ext_hdr_to_list(hdr, 0, extra_ehdrs)) return false;
if (!host_id_found) {
/* XXX: Take the opportunity to update the implicit Host ID if we
* don't know it yet. Ideally we should pass this through from the
* reader as a custom option or similar. */
if (erf_type == ERF_TYPE_META && ((hdr >> 48) & 0xff) > 0) {
if (dump_priv->implicit_host_id == ERF_META_HOST_ID_IMPLICIT) {
dump_priv->implicit_host_id = host_id;
}
}
}
host_id_found = true;
break;
case ERF_EXT_HDR_TYPE_FLOW_ID:
if (source_id == 0) /* If no Host ID extension header use the first Source ID only */
source_id = (hdr >> 48) & 0xff;
break;
}
has_more = type & 0x80;
i++;
}
/* Add Source ID with implicit Host ID if not found */
if (!host_id_found) {
uint64_t implicit_host_id = dump_priv->implicit_host_id == ERF_META_HOST_ID_IMPLICIT ? 0 : dump_priv->implicit_host_id;
/* Don't add the wireshark Host ID Source ID 0 twice since we already add it to metadata records */
if (implicit_host_id != dump_priv->host_id || source_id != 0)
if (!erf_add_ext_hdr_to_list(erf_host_id_ext_hdr(implicit_host_id, source_id), 0, extra_ehdrs)) return false;
}
return true;
}
/**
* Writes a metadata record with a randomly generated Anchor ID with the
* user comment attached to its comment section, also updates the
* modified frame header to include a Host ID extension header and
* a Anchor ID extension header to link the records together.
* @param wdh the wtap_dumper structure
* @param dump_priv private data for the dump stream
* @param rec record metadata from which to get user comment
* @param mutable_hdr pseudo_header to update with Anchor ID for comment record
* @param err the error value
* @return A bool value to indicate whether the dump was successful
*/
static bool erf_write_anchor_meta_update_phdr(wtap_dumper *wdh, erf_dump_t *dump_priv, const wtap_rec *rec, union wtap_pseudo_header *mutable_hdr, int *err) {
GArray *meta_ehdrs;
GPtrArray* sections = NULL;
uint8_t has_more;
uint8_t i = 0;
uint8_t ext_hdr_count = 0;
uint8_t j = 0;
uint64_t host_id_src_hdr = ERF_META_HOST_ID_IMPLICIT;
uint64_t host_id_own_hdr = erf_host_id_ext_hdr(dump_priv->host_id, 0);
uint64_t flow_id_hdr = 0;
uint64_t anchor_id_hdr = 0;
bool found_host_id = false;
bool found_own_host_id = false;
bool found_flow_id = false;
int new_ext_hdrs = 0;
uint8_t insert_idx = 0;
uint8_t source_id = 0;
bool ret = false;
uint64_t implicit_host_id = dump_priv->implicit_host_id == ERF_META_HOST_ID_IMPLICIT ? 0 : dump_priv->implicit_host_id;
char *pkt_comment;
/*
* There are 3 possible scenarios:
* a. The record has a source Host ID but not our Host ID. We need to add our
* Host ID extension header then our Anchor ID extension header.
* b. The record already has our Host ID extension header on it. We should
* insert the Anchor ID at the end of the list for that Host ID just
* before the next Host ID extension header.
* c. The record has no Host ID extension header at all. We need to add the Host ID
* extension header making the Implicit Host ID explicit before we add our
* one to avoid claiming the packet was captured by us.
*/
/*
* Extract information from the packet extension header stack
* 1. original source Host ID extension header.
* 2. Anchor ID extension header insertion point (see b., above).
* 3. Flow ID extension header so we can add it for reference to the metadata
* record.
* 4. Enough information to generate an explicit Host ID extension header if
* there wasn't one (see erf_get_source_from_header).
*/
has_more = mutable_hdr->erf.phdr.type & 0x80;
while (has_more && (i < MAX_ERF_EHDR)) {
uint64_t hdr = mutable_hdr->erf.ehdr_list[i].ehdr;
uint8_t type = (uint8_t) (hdr >> 56);
switch (type & 0x7f) {
case ERF_EXT_HDR_TYPE_HOST_ID:
/* Set insertion point of anchor ID to be at end of Host ID list (i.e.
* just before the next one). */
if (found_own_host_id && !insert_idx)
insert_idx = i;
if ((hdr & ERF_EHDR_HOST_ID_MASK) == dump_priv->host_id){
found_own_host_id = true;
}
if (!found_host_id)
host_id_src_hdr = hdr;
found_host_id = true;
break;
case ERF_EXT_HDR_TYPE_FLOW_ID:
/*XXX: we only use this when making the implicit host id explicit,
* otherwise we'd need to check the one in Host ID header too*/
if (source_id == 0)
source_id = (uint8_t)(hdr >> 48);
if (!found_flow_id)
flow_id_hdr = hdr;
found_flow_id = true;
break;
}
has_more = type & 0x80;
i += 1;
}
ext_hdr_count = i;
if (!insert_idx)
insert_idx = i;
/* Don't need to add our own Host ID twice if it is the same as the implicit*/
if (!found_host_id && implicit_host_id == dump_priv->host_id) {
found_own_host_id = true;
}
/*
* Update the packet record pseudo_header with Anchor ID and extension header(s)
*/
new_ext_hdrs = 1 /*anchor id*/ + (found_own_host_id?0:1) + (found_host_id?0:1);
if(ext_hdr_count + new_ext_hdrs > MAX_ERF_EHDR
|| mutable_hdr->erf.phdr.rlen + new_ext_hdrs * 8 > 65535) {
/* Not enough extension header slots to add Anchor ID */
*err = WTAP_ERR_PACKET_TOO_LARGE;
return false;
}
mutable_hdr->erf.phdr.rlen += new_ext_hdrs * 8;
/* Set the more extension headers flag */
mutable_hdr->erf.phdr.type |= 0x80;
if (insert_idx > 0) {
mutable_hdr->erf.ehdr_list[insert_idx-1].ehdr |= ERF_EHDR_MORE_EXTHDR_MASK;
}
/* Generate the Anchor ID extension header */
anchor_id_hdr = erf_anchor_id_ext_hdr(erf_get_random_anchor_id(dump_priv), 0);
/* Either we can insert Anchor ID at the end of the list for our Host ID or we
* need to append the Host ID(s) and Anchor ID */
if (insert_idx < ext_hdr_count) {
/* shuffle up any following extension headers FIRST - we know we have room now */
for (j = ext_hdr_count; j > insert_idx; j--) {
mutable_hdr->erf.ehdr_list[j].ehdr = mutable_hdr->erf.ehdr_list[j-1].ehdr;
}
/* copy more extension headers bit from previous extension header */
anchor_id_hdr |= ERF_EHDR_MORE_EXTHDR_MASK;
}
if(!found_host_id) {
/* No Host ID extension header found and we have an implicit Host ID which
* we want to make explicit */
/* XXX: it is important that we know the implicit Host ID here or we end
* up semi-permentantly associating the packet with Host 0 (unknown), we should
* pass it through from the reader. In theory we should be on the
* original capture machine if we have no Host ID extension headers. */
host_id_src_hdr = erf_host_id_ext_hdr(implicit_host_id, source_id);
mutable_hdr->erf.ehdr_list[insert_idx++].ehdr = ERF_EHDR_SET_MORE_EXTHDR(host_id_src_hdr);
}
if(!found_own_host_id) {
/* Add our Host ID extension header */
mutable_hdr->erf.ehdr_list[insert_idx++].ehdr = ERF_EHDR_SET_MORE_EXTHDR(host_id_own_hdr);
}
/*Add the Anchor ID extension header */
mutable_hdr->erf.ehdr_list[insert_idx].ehdr = anchor_id_hdr;
/*
* Now construct the metadata Anchor record with the same Anchor ID
*/
meta_ehdrs = g_array_new(false, false, sizeof(struct erf_ehdr));
/* We need up to 4 extension headers on the Provenance metadata record */
/*Required*/
/* 1. Added by erf_write_meta_record: HostID exthdr to indicate this Anchor
* record was generated by this host. Source ID 0 to avoid changing the
* implicit Host ID. */
/* 2. AnchorID exthdr with 'unique' per-host Anchor ID assigned by this host
* (in this case Wireshark). Anchor definition flag set to 1 to indicate this
* record contains a definition of the ID, in this case a comment on a single
* packet. Tied to above extension header by ordering like a list */
erf_append_ext_hdr_to_list(anchor_id_hdr | ERF_EHDR_ANCHOR_ID_DEFINITION_MASK, meta_ehdrs);
/*Helpful for indexing*/
/* 3. HostID exthdr with the original Source (first Host ID extension header) of the packet record */
erf_append_ext_hdr_to_list(host_id_src_hdr, meta_ehdrs);
/* Flow ID extension header from the packet record if we have one */
if (found_flow_id) {
/* 4. FlowID exthdr with Flow ID from the packet so a flow search will find the comment
* record too. Must come here so the (redundant here) Source ID is scoped to the
* correct Host ID. */
/* Clear the stack type just in case something tries to assume we're an IP
* packet without looking at the ERF type. Clear Source ID too just in case
* we're trying to associate with the wrong Host ID. */
erf_append_ext_hdr_to_list(flow_id_hdr & ~(ERF_EHDR_FLOW_ID_STACK_TYPE_MASK|ERF_EHDR_FLOW_ID_SOURCE_ID_MASK), meta_ehdrs);
}
/* Generate the metadata payload with the packet comment */
/* XXX - can ERF have more than one comment? */
sections = g_ptr_array_new_with_free_func(erf_meta_section_free);
if (WTAP_OPTTYPE_SUCCESS != wtap_block_get_nth_string_option_value(rec->block, OPT_COMMENT, 0, &pkt_comment)) {
pkt_comment = NULL;
}
erf_comment_to_sections(wdh, ERF_META_SECTION_INFO, 0x8000 /*local to record*/, pkt_comment, sections);
/* Write the metadata record, but not the packet record as what we do depends
* on the WTAP_ENCAP */
ret = erf_write_meta_record(wdh, dump_priv, mutable_hdr->erf.phdr.ts, sections, meta_ehdrs, err);
g_ptr_array_free(sections, true);
g_array_free(meta_ehdrs, true);
return ret;
}
static bool erf_write_meta_record(wtap_dumper *wdh, erf_dump_t *dump_priv, uint64_t timestamp, GPtrArray *sections, GArray *extra_ehdrs, int *err) {
union wtap_pseudo_header other_header;
struct erf_meta_tag gen_time_tag;
struct erf_meta_section *section_ptr;
unsigned total_wlen = 0;
unsigned total_rlen = 0;
int64_t alignbytes = 0;
unsigned i;
unsigned num_extra_ehdrs = 0;
if(!sections || sections->len <= 0)
return false;
for(i = 0; i < sections->len; i++) {
section_ptr = (struct erf_meta_section*)g_ptr_array_index(sections, i);
total_wlen += section_ptr->section_length;
}
gen_time_tag.type = ERF_META_TAG_gen_time;
gen_time_tag.length = 8U;
gen_time_tag.value = (uint8_t*)&dump_priv->gen_time;
total_wlen += gen_time_tag.length + 4;
total_rlen = total_wlen + 24; /* 24 is the header + extension header length */
if (extra_ehdrs) {
/*
* These will be appended to the first extension header in
* other_header.erf.ehdr_list. There are a total of MAX_ERF_EHDR
* extension headers in that array, so we can append no more than
* MAX_ERF_EHDR - 1 extension headeers.
*/
num_extra_ehdrs = MIN(extra_ehdrs->len, MAX_ERF_EHDR - 1);
total_rlen += num_extra_ehdrs * 8;
}
/*padding to 8 byte alignment*/
total_rlen += WS_PADDING_TO_8(total_rlen);
if(total_rlen > 65535) {
*err = WTAP_ERR_PACKET_TOO_LARGE;
return false;
}
other_header.erf.phdr.ts = timestamp;
other_header.erf.phdr.type = ERF_TYPE_META | 0x80;
other_header.erf.phdr.flags = 0x04; /* Varying record length */
other_header.erf.phdr.lctr = 0;
other_header.erf.phdr.wlen = (uint16_t)total_wlen;
other_header.erf.phdr.rlen = (uint16_t)total_rlen;
/*Add our Host ID in Host ID extension header indicating we generated this
* record. Source ID 0 to avoid affecting implicit Host ID. */
other_header.erf.ehdr_list[0].ehdr = erf_host_id_ext_hdr(dump_priv->host_id, 0);
/*Additional extension headers*/
/*XXX: If we end up cutting the list short, erf_write_phdr will correct the
* unterminated extension header list*/
if (num_extra_ehdrs > 0) {
other_header.erf.ehdr_list[0].ehdr |= ERF_EHDR_MORE_EXTHDR_MASK;
memcpy(&other_header.erf.ehdr_list[1], extra_ehdrs->data, sizeof(struct erf_ehdr) * num_extra_ehdrs);
}
/* Make sure we always write out rlen, regardless of what happens */
alignbytes = wdh->bytes_dumped + other_header.erf.phdr.rlen;
if(!erf_write_phdr(wdh, WTAP_ENCAP_ERF, &other_header, err)) return false;
/* Generation time */
erf_meta_write_tag(wdh, &gen_time_tag, err);
/* Section(s) */
for(i = 0; i < sections->len; i++) {
section_ptr = (struct erf_meta_section*)g_ptr_array_index(sections, i);
erf_meta_write_section(wdh, section_ptr, err);
}
while(wdh->bytes_dumped < alignbytes){
if(!wtap_dump_file_write(wdh, "", 1, err)) return false;
}
/* We wrote new packets, reloading is required */
wdh->needs_reload = true;
return true;
}
static erf_dump_t *erf_dump_priv_create(void) {
erf_dump_t *dump_priv;
dump_priv = g_new(erf_dump_t, 1);
dump_priv->write_next_extra_meta = false;
dump_priv->last_meta_periodic = false;
dump_priv->gen_time = 0;
dump_priv->host_id = ERF_WS_DEFAULT_HOST_ID;
dump_priv->implicit_host_id = ERF_META_HOST_ID_IMPLICIT;
dump_priv->first_frame_time_sec = 0;
dump_priv->prev_inserted_time_sec = 0;
dump_priv->prev_frame_ts = 0;
dump_priv->prev_erf_type = 0;
dump_priv->user_comment_ptr = NULL;
dump_priv->periodic_sections = NULL;
dump_priv->periodic_extra_ehdrs = g_array_new(false, false, sizeof(struct erf_ehdr));
dump_priv->rand = g_rand_new();
return dump_priv;
}
static bool erf_dump(
wtap_dumper *wdh,
const wtap_rec *rec,
int *err,
char **err_info _U_)
{
const union wtap_pseudo_header *pseudo_header = &rec->rec_header.packet_header.pseudo_header;
union wtap_pseudo_header other_phdr;
const uint8_t *pd = ws_buffer_start_ptr(&rec->data);
int erf_type;
int64_t alignbytes = 0;
unsigned padbytes = 0;
int round_down = 0;
bool must_add_crc = false;
uint32_t crc32 = 0x00000000;
erf_dump_t *dump_priv = (erf_dump_t*)wdh->priv;
/* Host ID extension header with Host ID 0 (unknown). For now use Source ID 1. */
/* TODO: How to know if record was captured by this Wireshark? */
uint64_t non_erf_host_id_ehdr = erf_host_id_ext_hdr(0, 1);
/* Don't write anything bigger than we're willing to read. */
if(rec->rec_header.packet_header.caplen > WTAP_MAX_PACKET_SIZE_STANDARD) {
*err = WTAP_ERR_PACKET_TOO_LARGE;
return false;
}
if(!dump_priv->gen_time) {
erf_dump_priv_init_gen_time(dump_priv);
dump_priv->first_frame_time_sec = rec->ts.secs;
}
/*
* ERF doesn't have a per-file encapsulation type, and it
* doesn't have a pcapng-style notion of interfaces that
* support a per-interface encapsulation type. Therefore,
* we can just use this particular packet's encapsulation
* without checking whether it's the encapsulation for the
* dump file (as there isn't an encapsulation for an ERF
* file, unless you count WTAP_ENCAP_ERF as the encapsulation
* for all files, but we add ERF metadata if a packet is
* written with an encapsulation other than WTAP_ENCAP_ERF).
*
* We will check whether the encapsulation is something we
* support later.
*/
if (rec->rec_header.packet_header.pkt_encap != WTAP_ENCAP_ERF) {
unsigned int total_rlen;
unsigned int total_wlen;
/* Non-ERF encapsulation; generate ERF metadata */
total_rlen = rec->rec_header.packet_header.caplen+16;
total_wlen = rec->rec_header.packet_header.len;
/* We can only convert packet records. */
if (rec->rec_type != REC_TYPE_PACKET) {
*err = WTAP_ERR_UNWRITABLE_REC_TYPE;
*err_info = wtap_unwritable_rec_type_err_string(rec);
return false;
}
erf_type = wtap_wtap_encap_to_erf_encap(rec->rec_header.packet_header.pkt_encap);
if (erf_type == -1) {
*err = WTAP_ERR_UNWRITABLE_ENCAP;
return false;
}
/* Generate a fake header in other_phdr using data that we know*/
memset(&other_phdr, 0, sizeof(union wtap_pseudo_header));
/* Convert time erf timestamp format*/
other_phdr.erf.phdr.ts = ((uint64_t) rec->ts.secs << 32) + (((uint64_t) rec->ts.nsecs <<32) / 1000 / 1000 / 1000);
other_phdr.erf.phdr.type = (uint8_t)erf_type;
/* Support up to 4 interfaces */
/* TODO: use multiple Source IDs and metadata records to support >4 interfaces */
other_phdr.erf.phdr.flags = rec->rec_header.packet_header.interface_id % ERF_MAX_INTERFACES;
other_phdr.erf.phdr.flags |= 0x4; /*vlen flag set because we're creating variable length records*/
other_phdr.erf.phdr.lctr = 0;
/*now we work out rlen, accounting for all the different headers and missing fcs(eth)*/
switch(other_phdr.erf.phdr.type & 0x7F){
case ERF_TYPE_ETH:
total_rlen += 2; /*2 bytes for erf eth_type*/
if (pseudo_header->eth.fcs_len != 4) {
/* Either this packet doesn't include the FCS
(pseudo_header->eth.fcs_len = 0), or we don't
know whether it has an FCS (= -1). We have to
synthesize an FCS.*/
if(!(rec->rec_header.packet_header.caplen < rec->rec_header.packet_header.len)){ /*don't add FCS if packet has been snapped off*/
crc32 = crc32_ccitt_seed(pd, rec->rec_header.packet_header.caplen, 0xFFFFFFFF);
total_rlen += 4; /*4 bytes for added checksum*/
total_wlen += 4;
must_add_crc = true;
}
}
break;
case ERF_TYPE_HDLC_POS:
/*we assume that it's missing a FCS checksum, make one up*/
if(!(rec->rec_header.packet_header.caplen < rec->rec_header.packet_header.len)){ /*unless of course, the packet has been snapped off*/
crc32 = crc32_ccitt_seed(pd, rec->rec_header.packet_header.caplen, 0xFFFFFFFF);
total_rlen += 4; /*4 bytes for added checksum*/
total_wlen += 4;
must_add_crc = true; /* XXX - these never have an FCS? */
}
break;
default:
break;
}
/* Add Host ID extension header with Host ID 0 (unknown). For now use Source ID 1. */
other_phdr.erf.phdr.type |= 0x80;
other_phdr.erf.ehdr_list[0].ehdr = non_erf_host_id_ehdr;
total_rlen += 8;
padbytes = WS_PADDING_TO_8(total_rlen); /*calculate how much padding will be required */
if(rec->rec_header.packet_header.caplen < rec->rec_header.packet_header.len){ /*if packet has been snapped, we need to round down what we output*/
round_down = (8 - padbytes) % 8;
total_rlen -= round_down;
}else{
total_rlen += padbytes;
}
if (total_rlen > UINT16_MAX || total_wlen > UINT16_MAX) {
*err = WTAP_ERR_PACKET_TOO_LARGE;
return false;
}
other_phdr.erf.phdr.rlen = (uint16_t)total_rlen;
other_phdr.erf.phdr.wlen = (uint16_t)total_wlen;
pseudo_header = &other_phdr;
} else if (rec->presence_flags & WTAP_HAS_TS) {
// Update timestamp if changed.
time_t secs;
int nsecs;
uint64_t ts = pseudo_header->erf.phdr.ts;
secs = (long) (ts >> 32);
ts = ((ts & 0xffffffff) * 1000 * 1000 * 1000);
ts += (ts & 0x80000000) << 1; /* rounding */
nsecs = ((int) (ts >> 32));
if (nsecs >= 1000000000) {
nsecs -= 1000000000;
secs += 1;
}
if (secs != rec->ts.secs || nsecs != rec->ts.nsecs) {
other_phdr = *pseudo_header;
other_phdr.erf.phdr.ts = ((uint64_t) rec->ts.secs << 32) + (((uint64_t) rec->ts.nsecs <<32) / 1000 / 1000 / 1000);
pseudo_header = &other_phdr;
}
}
/* We now have a (real or fake) ERF record */
erf_type = pseudo_header->erf.phdr.type & 0x7FU;
/* Accumulate Host ID/Source ID to put in updated periodic metadata */
/* TODO: pass these through from read interface list instead? */
/* Note: this includes the one we made for the fake ERF header */
erf_update_host_id_ext_hdrs_list(dump_priv, pseudo_header, dump_priv->periodic_extra_ehdrs);
/* Insert new metadata record depending on whether the capture comment has
* changed. Write metadata each second at boundaries. If there is metadata
* write at the end of each of metadata records so we update the metadata. */
if (erf_type == ERF_TYPE_META) {
/* Check whether the capture comment string has changed */
/* Updates write_next_extra_meta */
dump_priv->last_meta_periodic = erf_dump_priv_compare_capture_comment(wdh, dump_priv, pseudo_header, pd);
} else { /* don't want to insert a new metadata record while looking at another */
if (dump_priv->prev_erf_type == ERF_TYPE_META && dump_priv->last_meta_periodic) {
/* Last frame was a periodic (non-comment) metadata record (and this frame is not), check if we
* need to insert one to update metadata. */
if(dump_priv->write_next_extra_meta) {
if (!dump_priv->periodic_sections) {
/* If we've seen metadata just insert the capture comment and not the
* rest of the metadata */
dump_priv->periodic_sections = g_ptr_array_new_with_free_func(erf_meta_section_free);
erf_comment_to_sections(wdh, ERF_META_SECTION_CAPTURE, 0, dump_priv->user_comment_ptr, dump_priv->periodic_sections);
}
if (!erf_write_meta_record(wdh, dump_priv, dump_priv->prev_frame_ts, dump_priv->periodic_sections, dump_priv->periodic_extra_ehdrs, err)) return false;
dump_priv->prev_inserted_time_sec = rec->ts.secs;
/*TODO: clear accumulated existing extension headers here?*/
}
/* If we have seen a metadata record in the first ~1 second it
* means that we are dealing with an ERF file with metadata already in them.
* We don't want to write extra metadata if nothing has changed. We can't
* trust the Wireshark representation since we massage the fields on
* read. */
/* restart searching for next meta record to update capture comment at */
dump_priv->write_next_extra_meta = false;
} else if (rec->ts.secs > dump_priv->first_frame_time_sec + 1
&& dump_priv->prev_inserted_time_sec != rec->ts.secs) {
/* For compatibility, don't insert metadata for older ERF files with no changed metadata */
if (dump_priv->write_next_extra_meta) {
if (!dump_priv->periodic_sections) {
/* If we get here, metadata record was not found in the first ~1 sec
* but we have either a capture comment or a non-ERF file (see
* erf_dump_open) */
/* Start inserting metadata records from wtap data at second boundaries */
dump_priv->periodic_sections = g_ptr_array_new_with_free_func(erf_meta_section_free);
erf_wtap_info_to_sections(wdh, dump_priv->periodic_sections);
}
}
/* At second boundaries insert either the updated comment (if we've seen some metadata records
* already) or the full metadata */
if (dump_priv->periodic_sections) {
if (!erf_write_meta_record(wdh, dump_priv, (uint64_t)(rec->ts.secs) << 32, dump_priv->periodic_sections, dump_priv->periodic_extra_ehdrs, err)) return false;
dump_priv->prev_inserted_time_sec = rec->ts.secs;
}
}
}
/* If the packet user comment has changed, we need to
* construct a new header with additional Host ID and Anchor ID
* and insert a metadata record before that frame */
/*XXX: The user may have changed the comment to cleared! */
if(rec->block_was_modified) {
if (rec->rec_header.packet_header.pkt_encap == WTAP_ENCAP_ERF) {
/* XXX: What about ERF-in-pcapng with existing comment (that wasn't
* modified)? */
if(rec->block_was_modified) {
memmove(&other_phdr, pseudo_header, sizeof(union wtap_pseudo_header));
if(!erf_write_anchor_meta_update_phdr(wdh, dump_priv, rec, &other_phdr, err)) return false;
pseudo_header = &other_phdr;
}
} else {
/* Always write the comment if non-ERF */
if(!erf_write_anchor_meta_update_phdr(wdh, dump_priv, rec, &other_phdr, err)) return false;
}
}
/* Make sure we always write out rlen, regardless of what happens */
alignbytes = wdh->bytes_dumped + pseudo_header->erf.phdr.rlen;
if(!erf_write_phdr(wdh, WTAP_ENCAP_ERF, pseudo_header, err)) return false;
if(!wtap_dump_file_write(wdh, pd, rec->rec_header.packet_header.caplen - round_down, err)) return false;
/*add the 4 byte CRC if necessary*/
if(must_add_crc){
if(!wtap_dump_file_write(wdh, &crc32, 4, err)) return false;
}
/*XXX: In the case of ENCAP_ERF, this pads the record to its original length, which is fine in most
* cases. However with >MAX_ERF_EHDR unnecessary padding will be added, and
* if the record was truncated this will be incorrectly treated as payload.
* More than 8 extension headers is unusual though, only the first 8 are
* written out anyway and fixing properly would require major refactor.*/
/*records should be 8byte aligned, so we add padding to our calculated rlen */
while(wdh->bytes_dumped < alignbytes){
if(!wtap_dump_file_write(wdh, "", 1, err)) return false;
}
dump_priv->prev_erf_type = pseudo_header->erf.phdr.type & 0x7FU;
dump_priv->prev_frame_ts = pseudo_header->erf.phdr.ts;
return true;
}
static int erf_dump_can_write_encap(int encap)
{
if(encap == WTAP_ENCAP_PER_PACKET)
return 0;
if (wtap_wtap_encap_to_erf_encap(encap) == -1)
return WTAP_ERR_UNWRITABLE_ENCAP;
return 0;
}
static bool erf_dump_open(wtap_dumper *wdh, int *err _U_, char **err_info _U_)
{
erf_dump_t *dump_priv;
char *s;
uint64_t host_id;
char *first_shb_comment = NULL;
dump_priv = erf_dump_priv_create();
wdh->subtype_write = erf_dump;
wdh->priv = dump_priv;
wdh->subtype_finish = erf_dump_finish;
/* Get the first capture comment string */
get_user_comment_string(wdh, &first_shb_comment);
/* Save a copy of it */
dump_priv->user_comment_ptr = g_strdup(first_shb_comment);
/* XXX: If we have a capture comment or a non-ERF file assume we need to
* write metadata unless we see existing metadata in the first second. */
if (dump_priv->user_comment_ptr || wdh->file_encap != WTAP_ENCAP_ERF)
dump_priv->write_next_extra_meta = true;
/* Read Host ID from environment variable */
/* TODO: generate one from MAC address? */
if ((s = getenv("ERF_HOST_ID")) != NULL) {
/* TODO: support both decimal and hex strings (base 0)? */
if (ws_hexstrtou64(s, NULL, &host_id)) {
dump_priv->host_id = host_id & ERF_EHDR_HOST_ID_MASK;
}
}
return true;
}
static int erf_get_source_from_header(union wtap_pseudo_header *pseudo_header, uint64_t *host_id, uint8_t *source_id)
{
uint8_t type;
uint8_t has_more;
uint64_t hdr;
int i = 0;
bool host_id_found = false;
if (!pseudo_header || !host_id || !source_id)
return -1;
*host_id = ERF_META_HOST_ID_IMPLICIT;
*source_id = 0;
has_more = pseudo_header->erf.phdr.type & 0x80;
while (has_more && (i < MAX_ERF_EHDR)) {
hdr = pseudo_header->erf.ehdr_list[i].ehdr;
type = (uint8_t) (hdr >> 56);
/*
* XXX: Only want first Source ID and Host ID, and want to preserve HID n SID 0 (see
* erf_populate_interface)
*/
switch (type & 0x7f) {
case ERF_EXT_HDR_TYPE_HOST_ID:
if (!host_id_found)
*host_id = hdr & ERF_EHDR_HOST_ID_MASK;
host_id_found = true;
/* Fall through */
case ERF_EXT_HDR_TYPE_FLOW_ID:
if (*source_id == 0)
*source_id = (hdr >> 48) & 0xff;
break;
}
if (host_id_found)
break;
has_more = type & 0x80;
i += 1;
}
return 0;
}
int erf_populate_interface_from_header(erf_t *erf_priv, wtap *wth, union wtap_pseudo_header *pseudo_header, int *err, char **err_info)
{
uint64_t host_id;
uint8_t source_id;
uint8_t if_num;
if (!pseudo_header)
return -1;
if_num = (pseudo_header->erf.phdr.flags & 0x03) | ((pseudo_header->erf.phdr.flags & 0x40)>>4);
erf_get_source_from_header(pseudo_header, &host_id, &source_id);
return erf_populate_interface(erf_priv, wth, pseudo_header, host_id, source_id, if_num, err, err_info);
}
static struct erf_if_mapping* erf_find_interface_mapping(erf_t *erf_priv, uint64_t host_id, uint8_t source_id)
{
struct erf_if_mapping if_map_lookup;
/* XXX: erf_priv should never be NULL here */
if (!erf_priv)
return NULL;
if_map_lookup.host_id = host_id;
if_map_lookup.source_id = source_id;
return (struct erf_if_mapping*) g_hash_table_lookup(erf_priv->if_map, &if_map_lookup);
}
static void erf_set_interface_descr(wtap_block_t block, unsigned option_id, uint64_t host_id, uint8_t source_id, uint8_t if_num, const char *descr)
{
/* Source XXX,*/
char sourceid_buf[16];
/* Host XXXXXXXXXXXX,*/
char hostid_buf[24];
sourceid_buf[0] = '\0';
hostid_buf[0] = '\0';
/* Implicit Host ID defaults to 0 */
if (host_id == ERF_META_HOST_ID_IMPLICIT) {
host_id = 0;
}
if (host_id > 0) {
snprintf(hostid_buf, sizeof(hostid_buf), " Host %012" PRIx64 ",", host_id);
}
if (source_id > 0) {
snprintf(sourceid_buf, sizeof(sourceid_buf), " Source %u,", source_id);
}
if (descr) {
wtap_block_set_string_option_value_format(block, option_id, "%s (ERF%s%s Interface %d)", descr, hostid_buf, sourceid_buf, if_num);
} else {
wtap_block_set_string_option_value_format(block, option_id, "Port %c (ERF%s%s Interface %d)", 'A'+if_num, hostid_buf, sourceid_buf, if_num);
}
}
static int erf_update_anchors_from_header(erf_t *erf_priv, wtap_rec *rec, union wtap_pseudo_header *pseudo_header, uint64_t host_id, GPtrArray *anchor_mappings_to_update)
{
uint8_t type;
uint8_t has_more;
uint64_t hdr;
uint64_t comment_gen_time = 0;
uint64_t host_id_current;
uint64_t anchor_id_current = 0;
int i = 0;
char *comment = NULL;
if (!rec || !pseudo_header)
return -1;
/* Start with the first Host ID that was found on the record
* as the Anchor ID isn't required to be the first extension header' */
host_id_current = host_id == ERF_META_HOST_ID_IMPLICIT ? erf_priv->implicit_host_id : host_id;
has_more = pseudo_header->erf.phdr.type & 0x80;
while (has_more && (i < MAX_ERF_EHDR)) {
hdr = pseudo_header->erf.ehdr_list[i].ehdr;
type = (uint8_t) (hdr >> 56);
switch (type & 0x7f) {
case ERF_EXT_HDR_TYPE_HOST_ID:
host_id_current = hdr & ERF_EHDR_HOST_ID_MASK;
break;
case ERF_EXT_HDR_TYPE_ANCHOR_ID:
{
anchor_id_current = hdr & ERF_EHDR_ANCHOR_ID_MASK;
if (!(ERF_ANCHOR_ID_IS_DEFINITION(hdr))) {
/*
* Anchor definition flag is 0, attempt to associate a comment with this record
* XXX: currently the comment count may be wrong on the first pass!
*/
/* We may not have found the implicit Host ID yet, if so we are unlikely to find anything */
struct erf_anchor_mapping* lookup_result;
lookup_result = erf_find_anchor_mapping(erf_priv, host_id_current, anchor_id_current);
if (lookup_result) {
if (lookup_result->gen_time > comment_gen_time) {
/* XXX: we might have a comment that clears the comment (i.e.
* empty string)! */
if (lookup_result->comment && lookup_result->comment[0] != '\0') {
comment = lookup_result->comment;
}
comment_gen_time = lookup_result->gen_time;
}
}
}
else {
if (anchor_mappings_to_update && (pseudo_header->erf.phdr.type & 0x7f) == ERF_TYPE_META) {
/*
* Anchor definition flag is 1, put the mapping in an array
* which we will later update when we walk through
* the metadata tags
*/
/* Only Provenance record can contain the information we need */
struct erf_anchor_mapping *mapping_ptr =
g_new0(struct erf_anchor_mapping, 1);
/* May be ERF_META_HOST_ID_IMPLICIT */
mapping_ptr->host_id = host_id_current;
mapping_ptr->anchor_id = anchor_id_current;
g_ptr_array_add(anchor_mappings_to_update, mapping_ptr);
}
}
break;
}
}
has_more = type & 0x80;
i += 1;
}
if (comment) {
wtap_block_add_string_option(rec->block, OPT_COMMENT, comment, strlen(comment));
}
return 0;
}
/**
* @brief Update the implicit Host ID and Anchor Mapping information
*/
static int erf_update_implicit_host_id(erf_t *erf_priv, wtap *wth, uint64_t implicit_host_id)
{
GHashTableIter iter;
void *iter_value;
GList* implicit_list = NULL;
GList* item = NULL;
wtap_block_t int_data;
struct erf_if_mapping* if_map = NULL;
struct erf_if_mapping* if_map_other = NULL;
struct erf_if_info* if_info = NULL;
struct erf_anchor_mapping* anchor_mapping = NULL;
struct erf_anchor_mapping* anchor_mapping_other = NULL;
char *oldstr = NULL;
char portstr_buf[16];
int i;
if (!erf_priv)
return -1;
erf_priv->implicit_host_id = implicit_host_id;
/*
* We need to update the descriptions of all the interfaces with no Host
* ID to the correct Host ID.
*/
g_hash_table_iter_init(&iter, erf_priv->if_map);
/* Remove the implicit mappings from the mapping table */
while (g_hash_table_iter_next(&iter, &iter_value, NULL)) {
if_map = (struct erf_if_mapping*) iter_value;
if (if_map->host_id == ERF_META_HOST_ID_IMPLICIT) {
/* Check we don't have an existing interface that matches */
if_map_other = erf_find_interface_mapping(erf_priv, implicit_host_id, if_map->source_id);
if (!if_map_other) {
/* Pull mapping for update */
/* XXX: Can't add while iterating hash table so use list instead */
g_hash_table_iter_steal(&iter);
implicit_list = g_list_prepend(implicit_list, if_map);
} else {
/*
* XXX: We have duplicate interfaces in this case, but not much else we
* can do since we have already dissected the earlier packets. Expected
* to be unusual as it reqires a mix of explicit and implicit Host ID
* (e.g. FlowID extension header only) packets with the same effective
* Host ID before the first ERF_TYPE_META record.
*/
/*
* Update the description of the ERF_META_HOST_ID_IMPLICIT interface(s)
* for the first records in one pass mode. In 2 pass mode (Wireshark
* initial open, TShark in 2 pass mode) we will update the interface
* mapping for the frames on the second pass. Relatively consistent
* with the dissector behaviour.
*
* TODO: Can we delete this interface on the second (or even first)
* pass? Should we try to merge in other metadata?
* Needs a wtap_block_copy() that supports overwriting and/or expose
* custom option copy and do with wtap_block_foreach_option().
*/
for (i = 0; i < ERF_MAX_INTERFACES; i++) {
if_info = &if_map->interfaces[i];
if (if_info->if_index >= 0) {
/* XXX: this is a pointer! */
int_data = g_array_index(wth->interface_data, wtap_block_t, if_info->if_index);
snprintf(portstr_buf, sizeof(portstr_buf), "Port %c", 'A'+i);
oldstr = if_info->name;
if_info->name = g_strconcat(oldstr ? oldstr : portstr_buf, " [unmatched implicit]", NULL);
g_free(oldstr); /* probably null, but g_free doesn't care */
oldstr = if_info->descr;
if_info->descr = g_strconcat(oldstr ? oldstr : portstr_buf, " [unmatched implicit]", NULL);
g_free(oldstr);
erf_set_interface_descr(int_data, OPT_IDB_NAME, implicit_host_id, if_map->source_id, (uint8_t) i, if_info->name);
erf_set_interface_descr(int_data, OPT_IDB_DESCRIPTION, implicit_host_id, if_map->source_id, (uint8_t) i, if_info->descr);
}
}
}
}
}
/* Re-add the non-clashing items under the real implicit Host ID */
if (implicit_list) {
item = implicit_list;
do {
if_map = (struct erf_if_mapping*) item->data;
for (i = 0; i < ERF_MAX_INTERFACES; i++) {
if_info = &if_map->interfaces[i];
if (if_info->if_index >= 0) {
/* XXX: this is a pointer! */
int_data = g_array_index(wth->interface_data, wtap_block_t, if_info->if_index);
erf_set_interface_descr(int_data, OPT_IDB_NAME, implicit_host_id, if_map->source_id, (uint8_t) i, if_info->name);
erf_set_interface_descr(int_data, OPT_IDB_DESCRIPTION, implicit_host_id, if_map->source_id, (uint8_t) i, if_info->descr);
}
}
if_map->host_id = implicit_host_id;
/* g_hash_table_add() only exists since 2.32. */
g_hash_table_replace(erf_priv->if_map, if_map, if_map);
} while ((item = g_list_next(item)));
g_list_free(implicit_list);
implicit_list = NULL;
}
/*
* We also need to update the anchor comment mappings
* to the correct Host ID.
*/
g_hash_table_iter_init(&iter, erf_priv->anchor_map);
/* Remove the implicit mappings from the mapping table */
while (g_hash_table_iter_next(&iter, &iter_value, NULL)) {
anchor_mapping = (struct erf_anchor_mapping*) iter_value;
if (anchor_mapping->host_id == ERF_META_HOST_ID_IMPLICIT) {
/* Check we don't have an existing anchor that matches */
anchor_mapping_other = erf_find_anchor_mapping(erf_priv, implicit_host_id,
anchor_mapping->anchor_id);
if (anchor_mapping_other && anchor_mapping_other->gen_time >= anchor_mapping->gen_time) {
/*
* XXX: Duplicate entry of anchor mapping, keep the one with newer
* gen_time.
*/
g_hash_table_iter_remove(&iter);
} else {
/* Pull mapping for update */
/* XXX: Can't add while iterating hash table so use list instead */
g_hash_table_iter_steal(&iter);
implicit_list = g_list_prepend(implicit_list, anchor_mapping);
/* existing entry (if any) will be removed by g_hash_table_replace */
}
}
}
/* Re-add the non-clashing items under the real implicit Host ID */
if (implicit_list) {
item = implicit_list;
do {
anchor_mapping = (struct erf_anchor_mapping*) item->data;
anchor_mapping->host_id = implicit_host_id;
g_hash_table_replace(erf_priv->anchor_map, anchor_mapping, anchor_mapping);
} while ((item = g_list_next(item)));
g_list_free(implicit_list);
implicit_list = NULL;
}
return 0;
}
static int erf_populate_interface(erf_t *erf_priv, wtap *wth, union wtap_pseudo_header *pseudo_header, uint64_t host_id, uint8_t source_id, uint8_t if_num, int *err, char **err_info)
{
wtap_block_t int_data;
wtapng_if_descr_mandatory_t* int_data_mand;
struct erf_if_mapping* if_map = NULL;
if (!wth) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: erf_populate_interface called with wth NULL");
return -1;
}
if (!pseudo_header) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: erf_populate_interface called with pseudo_header NULL");
return -1;
}
if (!erf_priv) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: erf_populate_interface called with erf_priv NULL");
return -1;
}
if (if_num > ERF_MAX_INTERFACES-1) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: erf_populate_interface called with if_num %u > %u",
if_num, ERF_MAX_INTERFACES-1);
return -1;
}
if (host_id == ERF_META_HOST_ID_IMPLICIT) {
/* Defaults to ERF_META_HOST_ID_IMPLICIT so we can update mapping later */
host_id = erf_priv->implicit_host_id;
} else if ((pseudo_header->erf.phdr.type & 0x7f) == ERF_TYPE_META) {
/*
* XXX: We assume there is only one Implicit Host ID. As a special case a first
* Host ID extension header with Source ID 0 on a record does not change
* the implicit Host ID. We respect this even though we support only one
* Implicit Host ID.
*/
if (erf_priv->implicit_host_id == ERF_META_HOST_ID_IMPLICIT && source_id > 0) {
erf_update_implicit_host_id(erf_priv, wth, host_id);
}
}
if_map = erf_find_interface_mapping(erf_priv, host_id, source_id);
if (!if_map) {
if_map = erf_if_mapping_create(host_id, source_id);
/* g_hash_table_add() only exists since 2.32. */
g_hash_table_replace(erf_priv->if_map, if_map, if_map);
}
/* Return the existing interface if we have it */
if (if_map->interfaces[if_num].if_index >= 0) {
return if_map->interfaces[if_num].if_index;
}
int_data = wtap_block_create(WTAP_BLOCK_IF_ID_AND_INFO);
int_data_mand = (wtapng_if_descr_mandatory_t*)wtap_block_get_mandatory_data(int_data);
int_data_mand->wtap_encap = WTAP_ENCAP_ERF;
/* int_data.time_units_per_second = (1LL<<32); ERF format resolution is 2^-32, capture resolution is unknown */
int_data_mand->time_units_per_second = 1000000000; /* XXX Since Wireshark only supports down to nanosecond resolution we have to dilute to this */
int_data_mand->tsprecision = WTAP_TSPREC_NSEC;
int_data_mand->snap_len = 65535; /* ERF max length */
/* XXX: if_IPv4addr opt 4 Interface network address and netmask.*/
/* XXX: if_IPv6addr opt 5 Interface network address and prefix length (stored in the last byte).*/
/* XXX: if_MACaddr opt 6 Interface Hardware MAC address (48 bits).*/
/* XXX: if_EUIaddr opt 7 Interface Hardware EUI address (64 bits)*/
/* XXX: if_speed opt 8 Interface speed (in bits per second)*/
/* int_data.if_tsresol = 0xa0; ERF format resolution is 2^-32 = 0xa0, capture resolution is unknown */
wtap_block_add_uint8_option(int_data, OPT_IDB_TSRESOL, 0x09); /* XXX Since Wireshark only supports down to nanosecond resolution we have to dilute to this */
/* XXX: if_tzone 10 Time zone for GMT support (TODO: specify better). */
/* XXX if_tsoffset; opt 14 A 64 bits integer value that specifies an offset (in seconds)...*/
/* Interface statistics */
int_data_mand->num_stat_entries = 0;
int_data_mand->interface_statistics = NULL;
erf_set_interface_descr(int_data, OPT_IDB_NAME, host_id, source_id, if_num, NULL);
erf_set_interface_descr(int_data, OPT_IDB_DESCRIPTION, host_id, source_id, if_num, NULL);
if_map->interfaces[if_num].if_index = (int) wth->interface_data->len;
wtap_add_idb(wth, int_data);
return if_map->interfaces[if_num].if_index;
}
static uint32_t erf_meta_read_tag(struct erf_meta_tag* tag, uint8_t *tag_ptr, uint32_t remaining_len)
{
uint16_t tagtype;
uint16_t taglength;
uint32_t tagtotallength;
if (!tag_ptr || !tag || remaining_len < ERF_META_TAG_HEADERLEN)
return 0;
/* tagtype (2 bytes) */
tagtype = pntohu16(&tag_ptr[0]);
/* length (2 bytes) */
taglength = pntohu16(&tag_ptr[2]);
tagtotallength = ERF_META_TAG_TOTAL_ALIGNED_LENGTH(taglength);
if (remaining_len < tagtotallength) {
return 0;
}
tag->type = tagtype;
tag->length = taglength;
tag->value = &tag_ptr[4];
return tagtotallength;
}
static int populate_capture_host_info(erf_t *erf_priv, wtap *wth, union wtap_pseudo_header *pseudo_header _U_, struct erf_meta_read_state *state, int *err, char **err_info)
{
struct erf_meta_tag tag = {0, 0, NULL};
wtap_block_t shb_hdr;
char* tmp;
char* app_name = NULL;
char* app_version = NULL;
char* model = NULL;
char* descr = NULL;
char* cpu = NULL;
char* modelcpu = NULL;
uint32_t tagtotallength;
if (!wth) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_capture_host_info called with wth NULL");
return -1;
}
if (!state) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_capture_host_info called with state NULL");
return -1;
}
if (!wth->shb_hdrs) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_capture_host_info called with wth->shb_hdrs NULL");
return -1;
}
if (wth->shb_hdrs->len == 0) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_capture_host_info called with wth->shb_hdrs->len 0");
return -1;
}
/* XXX: wth->shb_hdr is already created by different layer, using directly for now. */
/* XXX: Only one section header is supported at this time */
shb_hdr = g_array_index(wth->shb_hdrs, wtap_block_t, 0);
while ((tagtotallength = erf_meta_read_tag(&tag, state->tag_ptr, state->remaining_len)) && !ERF_META_IS_SECTION(tag.type)) {
switch (state->sectiontype) {
case ERF_META_SECTION_CAPTURE:
{
if (erf_priv->capture_gentime > state->gen_time) {
return 0;
}
switch (tag.type) {
case ERF_META_TAG_comment:
{
char *existing_comment = NULL;
/*XXX: hack to make changing capture comment work since Wireshark only
* displays one. For now just overwrite the comment as we won't
* pick up all of them yet due to the gen_time check above */
if (wtap_block_get_nth_string_option_value(shb_hdr, OPT_COMMENT, 0, &existing_comment) == WTAP_OPTTYPE_SUCCESS) {
wtap_block_set_nth_string_option_value(shb_hdr, OPT_COMMENT, 0, tag.value, tag.length);
} else {
wtap_block_add_string_option(shb_hdr, OPT_COMMENT, tag.value, tag.length);
}
break;
}
}
}
/* Fall through */
case ERF_META_SECTION_HOST:
{
if (erf_priv->host_gentime > state->gen_time) {
return 0;
}
switch (tag.type) {
case ERF_META_TAG_model:
g_free(model);
model = g_strndup((char*) tag.value, tag.length);
break;
case ERF_META_TAG_cpu:
g_free(cpu);
cpu = g_strndup((char*) tag.value, tag.length);
break;
case ERF_META_TAG_descr:
g_free(descr);
descr = g_strndup((char*) tag.value, tag.length);
break;
case ERF_META_TAG_os:
wtap_block_set_string_option_value(shb_hdr, OPT_SHB_OS, tag.value, tag.length);
break;
case ERF_META_TAG_app_name:
g_free(app_name);
app_name = g_strndup((char*) tag.value, tag.length);
break;
case ERF_META_TAG_app_version:
g_free(app_version);
app_version = g_strndup((char*) tag.value, tag.length);
break;
/* TODO: dag_version? */
/* TODO: could concatenate comment(s)? */
case ERF_META_TAG_filter:
g_free(state->if_map->capture_filter_str);
state->if_map->capture_filter_str = g_strndup((char*) tag.value, tag.length);
break;
default:
break;
}
}
break;
}
state->tag_ptr += tagtotallength;
state->remaining_len -= tagtotallength;
}
/* Post processing */
if (app_name || app_version) {
/*
* If we have no app_name, we use "(Unknown application)".
*
* If we have no app_version, this will just use app_name.
*/
tmp = g_strjoin(" ", app_name ? app_name : "(Unknown application)", app_version, NULL);
wtap_block_set_string_option_value(shb_hdr, OPT_SHB_USERAPPL, tmp, strlen(tmp));
g_free(tmp);
g_free(app_name);
g_free(app_version);
app_name = NULL;
app_version = NULL;
}
/* For the hardware field show description followed by (model; cpu) */
/* Build "Model; CPU" part */
if (model || cpu) {
/* g_strjoin() would be nice to use here if the API didn't stop on the first NULL... */
if (model && cpu) {
modelcpu = g_strconcat(model, "; ", cpu, NULL);
} else if (cpu) {
modelcpu = cpu;
/* avoid double-free */
cpu = NULL;
} else {
modelcpu = model;
/* avoid double-free */
model = NULL;
}
}
/* Combine into "Description (Model; CPU)" */
if (state->sectiontype == ERF_META_SECTION_HOST && descr) {
if (modelcpu) {
wtap_block_set_string_option_value_format(shb_hdr, OPT_SHB_HARDWARE, "%s (%s)", descr, modelcpu);
} else {
wtap_block_set_string_option_value(shb_hdr, OPT_SHB_HARDWARE, descr, strlen(descr));
/*descr = NULL;*/
}
} else if (modelcpu) {
wtap_block_set_string_option_value(shb_hdr, OPT_SHB_HARDWARE, modelcpu, strlen(modelcpu));
/*modelcpu = NULL;*/
}
/* Free the fields we didn't end up using */
g_free(modelcpu);
g_free(model);
g_free(descr);
g_free(cpu);
if (state->sectiontype == ERF_META_SECTION_CAPTURE) {
erf_priv->capture_gentime = state->gen_time;
} else {
erf_priv->host_gentime = state->gen_time;
}
return 1;
}
static int populate_module_info(erf_t *erf_priv _U_, wtap *wth, union wtap_pseudo_header *pseudo_header _U_, struct erf_meta_read_state *state, int *err, char **err_info)
{
struct erf_meta_tag tag = {0, 0, NULL};
uint32_t tagtotallength;
if (!wth) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_module_info called with wth NULL");
return -1;
}
if (!state) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_module_info called with stat NULL");
return -1;
}
if (state->if_map->module_gentime > state->gen_time) {
return 0;
}
while ((tagtotallength = erf_meta_read_tag(&tag, state->tag_ptr, state->remaining_len)) && !ERF_META_IS_SECTION(tag.type)) {
switch (tag.type) {
case ERF_META_TAG_fcs_len:
if (tag.length >= 4) {
state->if_map->module_fcs_len = (int8_t) pntohu32(tag.value);
}
break;
case ERF_META_TAG_snaplen:
/* XXX: this is generally per stream */
if (tag.length >= 4) {
state->if_map->module_snaplen = pntohu32(tag.value);
}
break;
case ERF_META_TAG_filter:
g_free(state->if_map->module_filter_str);
state->if_map->module_filter_str = g_strndup((char*) tag.value, tag.length);
break;
}
state->tag_ptr += tagtotallength;
state->remaining_len -= tagtotallength;
}
state->if_map->module_gentime = state->gen_time;
return 1;
}
static int populate_interface_info(erf_t *erf_priv, wtap *wth, union wtap_pseudo_header *pseudo_header, struct erf_meta_read_state *state, int *err, char **err_info)
{
struct erf_meta_tag tag = {0, 0, NULL};
uint32_t tagtotallength;
int interface_index = -1;
wtap_block_t int_data = NULL;
wtapng_if_descr_mandatory_t* int_data_mand = NULL;
if_filter_opt_t if_filter;
uint32_t if_num = 0;
struct erf_if_info* if_info = NULL;
if (!wth) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_interface_info called with wth NULL");
return -1;
}
if (!state) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_interface_info called with state NULL");
return -1;
}
if (!pseudo_header) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_interface_info called with pseudo_header NULL");
return -1;
}
if (!state->if_map) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_interface_info called with state->if_map NULL");
return -1;
}
/* Section ID of interface is defined to match ERF interface id. */
if_num = state->sectionid - 1;
/*
* Get or create the interface (there can be multiple interfaces in
* a Provenance record).
*/
if (if_num < ERF_MAX_INTERFACES) { /* Note: -1u > ERF_MAX_INTERFACES */
if_info = &state->if_map->interfaces[if_num];
interface_index = if_info->if_index;
/* Check if the interface information is still uninitialized */
if (interface_index == -1) {
uint8_t *tag_ptr_tmp = state->tag_ptr;
uint32_t remaining_len_tmp = state->remaining_len;
/* First iterate tags, checking we aren't looking at a timing port */
/*
* XXX: we deliberately only do this logic here rather than the per-packet
* population function so that if somehow we do see packets for an
* 'invalid' port the interface will be created at that time.
*/
while ((tagtotallength = erf_meta_read_tag(&tag, tag_ptr_tmp, remaining_len_tmp)) && !ERF_META_IS_SECTION(tag.type)) {
if (tag.type == ERF_META_TAG_if_port_type) {
if (tag.length >= 4 && pntohu32(tag.value) == 2) {
/* This is a timing port, skip it from now on */
/* XXX: should we skip all non-capture ports instead? */
if_info->if_index = -2;
interface_index = -2;
}
} else if (tag.type == ERF_META_TAG_stream_num) {
if (tag.length >= 4) {
if_info->stream_num = (int32_t) pntohu32(tag.value);
}
}
tag_ptr_tmp += tagtotallength;
remaining_len_tmp -= tagtotallength;
}
/* If the interface is valid but uninitialized, create it */
if (interface_index == -1) {
interface_index = erf_populate_interface(erf_priv, wth, pseudo_header, state->if_map->host_id, state->if_map->source_id, (uint8_t) if_num, err, err_info);
if (interface_index == -1) {
return -1;
}
}
}
/* Get the wiretap interface metadata */
if (interface_index >= 0) {
int_data = g_array_index(wth->interface_data, wtap_block_t, interface_index);
int_data_mand = (wtapng_if_descr_mandatory_t*)wtap_block_get_mandatory_data(int_data);
} else if (interface_index == -2) {
/* timing/unknown port */
return 0;
} else {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_interface_info got interface_index %d < 0 and != -2", interface_index);
return -1;
}
}
/*
* Bail if already have interface metadata or no interface to associate with.
* We also don't support metadata for >ERF_MAX_INTERFACES interfaces per Host + Source
* as we only use interface ID.
*/
if (!int_data)
return 0;
if (state->if_map->interface_gentime > state->gen_time && state->if_map->interface_metadata & (1 << if_num))
return 0;
while ((tagtotallength = erf_meta_read_tag(&tag, state->tag_ptr, state->remaining_len)) && !ERF_META_IS_SECTION(tag.type)) {
switch (tag.type) {
case ERF_META_TAG_name:
/* TODO: fall back to module "dev_name Port N"? */
if (!if_info->name) {
if_info->name = g_strndup((char*) tag.value, tag.length);
erf_set_interface_descr(int_data, OPT_IDB_NAME, state->if_map->host_id, state->if_map->source_id, (uint8_t) if_num, if_info->name);
/* If we have no description, also copy to wtap if_description */
if (!if_info->descr) {
erf_set_interface_descr(int_data, OPT_IDB_DESCRIPTION, state->if_map->host_id, state->if_map->source_id, (uint8_t) if_num, if_info->name);
}
}
break;
case ERF_META_TAG_descr:
if (!if_info->descr) {
if_info->descr = g_strndup((char*) tag.value, tag.length);
erf_set_interface_descr(int_data, OPT_IDB_DESCRIPTION, state->if_map->host_id, state->if_map->source_id, (uint8_t) if_num, if_info->descr);
/* If we have no name, also copy to wtap if_name */
if (!if_info->name) {
erf_set_interface_descr(int_data, OPT_IDB_NAME, state->if_map->host_id, state->if_map->source_id, (uint8_t) if_num, if_info->descr);
}
}
break;
case ERF_META_TAG_if_speed:
if (tag.length >= 8)
wtap_block_add_uint64_option(int_data, OPT_IDB_SPEED, pntohu64(tag.value));
break;
case ERF_META_TAG_if_num:
/*
* XXX: We ignore this as Section ID must match the ERF ifid and
* that is all we care about/have space for at the moment. if_num
* is only really useful with >ERF_MAX_INTERFACES interfaces.
*/
/* TODO: might want to put this number in description */
break;
case ERF_META_TAG_fcs_len:
if (tag.length >= 4) {
wtap_block_add_uint8_option(int_data, OPT_IDB_FCSLEN, (uint8_t) pntohu32(tag.value));
if_info->set_flags.fcs_len = 1;
}
break;
case ERF_META_TAG_snaplen:
/* XXX: this generally per stream */
if (tag.length >= 4) {
int_data_mand->snap_len = pntohu32(tag.value);
if_info->set_flags.snaplen = 1;
}
break;
case ERF_META_TAG_comment:
wtap_block_add_string_option(int_data, OPT_COMMENT, tag.value, tag.length);
break;
case ERF_META_TAG_filter:
if_filter.type = if_filter_pcap;
if_filter.data.filter_str = g_strndup((char*) tag.value, tag.length);
wtap_block_add_if_filter_option(int_data, OPT_IDB_FILTER, &if_filter);
g_free(if_filter.data.filter_str);
if_info->set_flags.filter = 1;
break;
default:
break;
}
state->tag_ptr += tagtotallength;
state->remaining_len -= tagtotallength;
}
/* Post processing */
/*
* XXX: Assumes module defined first. It is higher in hierarchy so only set
* if not already.
*/
/*
* XXX: Missing exposed existence/type-check. No way currently to check if
* been set in the optionblock.
*/
if (!if_info->set_flags.filter) {
if (state->if_map->module_filter_str) {
/* Duplicate because might use with multiple interfaces */
if_filter.type = if_filter_pcap;
if_filter.data.filter_str = state->if_map->module_filter_str;
wtap_block_add_if_filter_option(int_data, OPT_IDB_FILTER, &if_filter);
/*
* Don't set flag because stream is more specific than module.
*/
} else if (state->if_map->capture_filter_str) {
/* TODO: display separately? Note that we could have multiple captures
* from multiple hosts in the file */
if_filter.type = if_filter_pcap;
if_filter.data.filter_str = state->if_map->capture_filter_str;
wtap_block_add_if_filter_option(int_data, OPT_IDB_FILTER, &if_filter);
}
}
if (state->if_map->module_fcs_len != -1 && !if_info->set_flags.fcs_len) {
wtap_block_add_uint8_option(int_data, OPT_IDB_FCSLEN, (uint8_t) state->if_map->module_fcs_len);
if_info->set_flags.fcs_len = 1;
}
if (state->if_map->module_snaplen != (uint32_t) -1 && !if_info->set_flags.snaplen && tag.value) {
int_data_mand->snap_len = pntohu32(tag.value);
if_info->set_flags.snaplen = 1;
}
state->interface_metadata |= 1 << if_num;
return 1;
}
static int populate_stream_info(erf_t *erf_priv _U_, wtap *wth, union wtap_pseudo_header *pseudo_header, struct erf_meta_read_state *state, int *err, char **err_info)
{
struct erf_meta_tag tag = {0, 0, NULL};
uint32_t tagtotallength;
int interface_index = -1;
wtap_block_t int_data = NULL;
wtapng_if_descr_mandatory_t* int_data_mand = NULL;
if_filter_opt_t if_filter;
uint32_t if_num = 0;
int32_t stream_num = -1;
uint8_t *tag_ptr_tmp;
uint32_t remaining_len_tmp;
struct erf_if_info* if_info = NULL;
if (!wth) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_stream_info called with wth NULL");
return -1;
}
if (!pseudo_header) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_stream_info called with pseudo_header NULL");
return -1;
}
if (!state) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_stream_info called with state NULL");
return -1;
}
if (!state->if_map) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_stream_info called with state->if_map NULL");
return -1;
}
tag_ptr_tmp = state->tag_ptr;
remaining_len_tmp = state->remaining_len;
/*
* XXX: We ignore parent section ID because it doesn't represent the
* many-to-many relationship of interfaces and streams very well. The stream is
* associated with all interfaces in the record that don't have a stream_num
* that says otherwise.
*/
if (state->sectionid > 0 && state->sectionid != 0x7fff) {
/* Section ID of stream is supposed to match stream_num. */
stream_num = state->sectionid - 1;
} else {
/* First iterate tags, looking for the stream number interfaces might associate with. */
while ((tagtotallength = erf_meta_read_tag(&tag, tag_ptr_tmp, remaining_len_tmp)) && !ERF_META_IS_SECTION(tag.type)) {
if (tag.type == ERF_META_TAG_stream_num) {
if (tag.length >= 4) {
stream_num = (int32_t) pntohu32(tag.value);
}
}
tag_ptr_tmp += tagtotallength;
remaining_len_tmp -= tagtotallength;
}
}
/* Otherwise assume the stream applies to all interfaces in the record */
for (if_num = 0; if_num < ERF_MAX_INTERFACES; if_num++) {
tag_ptr_tmp = state->tag_ptr;
remaining_len_tmp = state->remaining_len;
if_info = &state->if_map->interfaces[if_num];
/* Check if we should be handling this interface */
/* XXX: currently skips interfaces that are not in the record. */
if (state->if_map->interface_metadata & (1 << if_num)
|| !(state->interface_metadata & (1 << if_num))) {
continue;
}
if (if_info->stream_num != -1
&& if_info->stream_num != stream_num) {
continue;
}
interface_index = if_info->if_index;
/* Get the wiretap interface metadata */
if (interface_index >= 0) {
int_data = g_array_index(wth->interface_data, wtap_block_t, interface_index);
int_data_mand = (wtapng_if_descr_mandatory_t*)wtap_block_get_mandatory_data(int_data);
}
if (!int_data) {
continue;
}
while ((tagtotallength = erf_meta_read_tag(&tag, tag_ptr_tmp, remaining_len_tmp)) && !ERF_META_IS_SECTION(tag.type)) {
switch (tag.type) {
case ERF_META_TAG_fcs_len:
if (tag.length >= 4) {
/* Use the largest fcslen of matching streams */
int8_t fcs_len = (int8_t) pntohu32(tag.value);
uint8_t old_fcs_len = 0;
switch (wtap_block_get_uint8_option_value(int_data, OPT_IDB_FCSLEN, &old_fcs_len)) {
case WTAP_OPTTYPE_SUCCESS:
/* We already have an FCS length option; update it. */
if (fcs_len > old_fcs_len || !if_info->set_flags.fcs_len) {
wtap_block_set_uint8_option_value(int_data, OPT_IDB_FCSLEN, (uint8_t) pntohu32(tag.value));
if_info->set_flags.fcs_len = 1;
}
break;
case WTAP_OPTTYPE_NOT_FOUND:
/* We don't have an FCS length option; add it. */
wtap_block_add_uint8_option(int_data, OPT_IDB_FCSLEN, (uint8_t) pntohu32(tag.value));
if_info->set_flags.fcs_len = 1;
break;
default:
/* "shouldn't happen" */
break;
}
}
break;
case ERF_META_TAG_snaplen:
if (tag.length >= 4) {
/* Use the largest snaplen of matching streams */
uint32_t snaplen = pntohu32(tag.value);
if (snaplen > int_data_mand->snap_len || !if_info->set_flags.snaplen) {
int_data_mand->snap_len = pntohu32(tag.value);
if_info->set_flags.snaplen = 1;
}
}
break;
case ERF_META_TAG_filter:
/* Override only if not set */
if (!if_info->set_flags.filter) {
if_filter.type = if_filter_pcap;
if_filter.data.filter_str = g_strndup((char*) tag.value, tag.length);
wtap_block_add_if_filter_option(int_data, OPT_IDB_FILTER, &if_filter);
g_free(if_filter.data.filter_str);
if_info->set_flags.filter = 1;
}
break;
default:
break;
}
tag_ptr_tmp += tagtotallength;
remaining_len_tmp -= tagtotallength;
}
}
state->tag_ptr = tag_ptr_tmp;
state->remaining_len = remaining_len_tmp;
return 1;
}
static int populate_anchor_info(erf_t *erf_priv, wtap *wth, union wtap_pseudo_header *pseudo_header, struct erf_meta_read_state *state, GPtrArray *anchor_mappings_to_update, int *err, char **err_info) {
struct erf_meta_tag tag = {0, 0, NULL};
uint32_t tagtotallength;
char *comment_ptr = NULL;
unsigned i = 0;
if (!wth) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_anchor_info called with wth NULL");
return -1;
}
if (!state) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_anchor_info called with state NULL");
return -1;
}
if (!pseudo_header) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_anchor_info called with pseudo_header NULL");
return -1;
}
if (!anchor_mappings_to_update || anchor_mappings_to_update->len == 0)
return 0;
while ((tagtotallength = erf_meta_read_tag(&tag, state->tag_ptr, state->remaining_len)) && !ERF_META_IS_SECTION(tag.type)) {
/* XXX:Always gets the first comment tag in the section */
switch(tag.type) {
case ERF_META_TAG_comment:
if(!comment_ptr) {
comment_ptr = g_strndup((char*)tag.value, tag.length);
}
break;
default:
break;
}
state->tag_ptr += tagtotallength;
state->remaining_len -= tagtotallength;
}
if(comment_ptr) {
for(i = 0; i < anchor_mappings_to_update->len; i++) {
struct erf_anchor_mapping *mapping;
struct erf_anchor_mapping *lookup_result;
mapping = (struct erf_anchor_mapping*)g_ptr_array_index(anchor_mappings_to_update, i);
lookup_result = (struct erf_anchor_mapping*)g_hash_table_lookup(erf_priv->anchor_map, mapping);
/* Use the most recent comment, across all anchors associated with the
* record. */
if(lookup_result) {
if(lookup_result->gen_time < state->gen_time) {
lookup_result->gen_time = state->gen_time;
g_free(lookup_result->comment);
lookup_result->comment = g_strdup(comment_ptr);
}
}
else {
/* !lookup_result */
struct erf_anchor_mapping *new_mapping;
new_mapping = g_new0(struct erf_anchor_mapping, 1);
new_mapping->anchor_id = mapping->anchor_id;
new_mapping->host_id = mapping->host_id;
new_mapping->gen_time = state->gen_time;
new_mapping->comment = g_strdup(comment_ptr);
g_hash_table_replace(erf_priv->anchor_map, new_mapping, new_mapping);
}
}
}
g_free(comment_ptr);
return 1;
}
/* Populates the capture and interface information for display on the Capture File Properties */
static int populate_summary_info(erf_t *erf_priv, wtap *wth, wtap_rec *rec, uint32_t packet_size, GPtrArray *anchor_mappings_to_update, int *err, char **err_info)
{
struct erf_meta_read_state state = {0};
struct erf_meta_read_state *state_post = NULL;
uint64_t host_id = 0;
uint8_t source_id = 0;
GList *post_list = NULL;
GList *item = NULL;
struct erf_meta_tag tag = {0, 0, NULL};
uint32_t tagtotallength;
if (!wth) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_summary_info called with wth NULL");
return -1;
}
if (!erf_priv) {
*err = WTAP_ERR_INTERNAL;
*err_info = ws_strdup_printf("erf: populate_summary_info called with erf_priv NULL");
return -1;
}
erf_get_source_from_header(&rec->rec_header.packet_header.pseudo_header, &host_id, &source_id);
if (host_id == 0) {
host_id = erf_priv->implicit_host_id;
}
state.if_map = erf_find_interface_mapping(erf_priv, host_id, source_id);
if (!state.if_map) {
state.if_map = erf_if_mapping_create(host_id, source_id);
/* g_hash_table_add() only exists since 2.32. */
g_hash_table_replace(erf_priv->if_map, state.if_map, state.if_map);
}
state.tag_ptr = rec->data.data;
state.remaining_len = packet_size;
/* Read until see next section tag */
while ((tagtotallength = erf_meta_read_tag(&tag, state.tag_ptr, state.remaining_len))) {
/*
* Obtain the gen_time from the non-section at the beginning of the record
*/
if (!ERF_META_IS_SECTION(tag.type)) {
if(state.gen_time == 0U
&& tag.type == ERF_META_TAG_gen_time
) {
memcpy(&state.gen_time, tag.value, sizeof(state.gen_time));
/*
* Since wireshark doesn't have a concept of different summary metadata
* over time, skip the record if metadata is older than what we already have.
*/
/* TODO: This doesn't work very well for some tags that map to
* pcapng options where the pcapng specification only allows one
* instance per block, which is the case for most options. The
* only current exxceptions are:
*
* comments;
* IPv4 and IPv6 addresses for an interface;
* hash values for a packet;
* custom options.
*
* For options where only one instance is allowed per block,
* wtap_block_add_XXX_option() is currently used to add a new
* instance of an option to a block that has no instance (it
* fails if there's already an instance), and
* wtap_block_set_XXX_optin() is currently used to change the
* value of an option in a block that has one instance (it fails
* if there isn't already an instance).
*
* For options where more than one instance is allowed per block,
* wtap_block_add_XXX_option() is used to add a new instance to
* a block, no matter how many instances it currently has, and
* wtap_block_set_nth_XXX_option() is used to change the value
* of the Nth instance of an option in a block (the block must
* *have* an Nth instance).
*
* Currently we only particularly care about updating the capture comment
* and a few counters anyway.
*/
if ((state.if_map->interface_metadata & 0xff)
&& state.gen_time < erf_priv->host_gentime && state.gen_time < erf_priv->capture_gentime
&& (!anchor_mappings_to_update || !anchor_mappings_to_update->len)) {
return 0;
}
}
/*
* Skip until we get to the next section tag (which could be the current tag
* after an empty section or successful parsing).
*/
/* adjust offset */
state.tag_ptr += tagtotallength;
state.remaining_len -= tagtotallength;
continue;
}
/*
* We are now looking at the next section (and would have exited the loop
* if we reached the end).
*/
/* Update parent section. Implicit grouping is by a change in section except Interface and Stream. */
if (tag.type != state.sectiontype) {
if ((tag.type == ERF_META_SECTION_STREAM && state.sectiontype == ERF_META_SECTION_INTERFACE) ||
(tag.type == ERF_META_SECTION_INTERFACE && state.sectiontype == ERF_META_SECTION_STREAM)) {
/* do nothing */
} else {
state.parentsectiontype = state.sectiontype;
state.parentsectionid = state.sectionid;
}
}
/* Update with new sectiontype */
state.sectiontype = tag.type;
if (tag.length >= 4) {
state.sectionid = pntohu16(tag.value);
} else {
state.sectionid = 0;
}
/* Adjust offset to that of first tag in section */
state.tag_ptr += tagtotallength;
state.remaining_len -= tagtotallength;
if (erf_meta_read_tag(&tag, state.tag_ptr, state.remaining_len)) {
/*
* Process parent section tag if present (which must be the first tag in
* the section).
*/
if (tag.type == ERF_META_TAG_parent_section && tag.length >= 4) {
state.parentsectiontype = pntohu16(tag.value);
state.parentsectionid = pntohu16(&tag.value[2]);
}
}
/* Skip empty sections (includes if above read fails) */
if (ERF_META_IS_SECTION(tag.type)) {
continue;
}
/*
* Skip sections that don't apply to the general set of records
* (extension point for per-packet/event metadata).
* Unless we need to update the anchor info
* in which case, read into it
*/
if (state.sectionid & 0x8000) {
if(state.sectiontype & (ERF_META_SECTION_INFO)) {
/* TODO: do we care if it returns 0 or 1? */
if (populate_anchor_info(erf_priv, wth, &rec->rec_header.packet_header.pseudo_header, &state, anchor_mappings_to_update, err, err_info) < 0) {
return -1;
}
}
continue;
}
/*
* Start at first tag in section, makes loop
* simpler in called functions too. Also makes iterating after failure
* much simpler.
*/
switch (state.sectiontype) {
case ERF_META_SECTION_CAPTURE:
case ERF_META_SECTION_HOST:
/* TODO: do we care if it returns 0 or 1? */
if (populate_capture_host_info(erf_priv, wth, &rec->rec_header.packet_header.pseudo_header, &state, err, err_info) < 0) {
return -1;
}
break;
case ERF_META_SECTION_MODULE:
/* TODO: do we care if it returns 0 or 1? */
if (populate_module_info(erf_priv, wth, &rec->rec_header.packet_header.pseudo_header, &state, err, err_info) < 0) {
return -1;
}
break;
case ERF_META_SECTION_INTERFACE:
/* TODO: do we care if it returns 0 or 1? */
if (populate_interface_info(erf_priv, wth, &rec->rec_header.packet_header.pseudo_header, &state, err, err_info) < 0) {
return -1;
}
break;
case ERF_META_SECTION_STREAM:
/*
* XXX: Treat streams specially in case the stream information appears
* before the interface information, as we associate them to interface
* data.
*/
post_list = g_list_append(post_list, g_memdup2(&state, sizeof(struct erf_meta_read_state)));
break;
case ERF_META_SECTION_SOURCE:
case ERF_META_SECTION_DNS:
default:
/* TODO: Not yet implemented */
break;
}
}
/* Process streams last */
if (post_list) {
item = post_list;
do {
state_post = (struct erf_meta_read_state*) item->data;
switch (state_post->sectiontype) {
case ERF_META_SECTION_STREAM:
if (populate_stream_info(erf_priv, wth, &rec->rec_header.packet_header.pseudo_header, state_post, err, err_info) < 0) {
g_list_foreach(post_list, erf_free_data, NULL);
g_list_free(post_list);
return -1;
}
break;
}
} while ((item = g_list_next(item)));
/* g_list_free_full() only exists since 2.28. */
g_list_foreach(post_list, erf_free_data, NULL);
g_list_free(post_list);
}
/*
* Update known metadata so we only examine the first set of metadata. Need to
* do this here so can have interface and stream in same record.
*/
if (state.interface_metadata) {
state.if_map->interface_metadata |= state.interface_metadata;
state.if_map->interface_gentime = state.gen_time;
}
return 0;
}
static bool get_user_comment_string(wtap_dumper *wdh, char** user_comment_ptr) {
wtap_block_t wtap_block;
wtap_opttype_return_val ret;
wtap_block = NULL;
if(wdh->shb_hdrs && (wdh->shb_hdrs->len > 0)) {
wtap_block = g_array_index(wdh->shb_hdrs, wtap_block_t, 0);
}
if(wtap_block != NULL) {
ret = wtap_block_get_nth_string_option_value(wtap_block, OPT_COMMENT, 0, user_comment_ptr);
if(ret != WTAP_OPTTYPE_SUCCESS) {
return false;
}
}
return true;
}
static bool erf_dump_priv_compare_capture_comment(wtap_dumper *wdh _U_, erf_dump_t *dump_priv, const union wtap_pseudo_header *pseudo_header, const uint8_t *pd){
struct erf_meta_read_state state = {0};
struct erf_meta_tag tag = {0, 0, NULL};
uint32_t tagtotallength;
bool found_capture_section = false;
bool found_normal_section = false;
char* comment_ptr = NULL;
state.remaining_len = pseudo_header->erf.phdr.wlen;
memcpy(&(state.tag_ptr), &pd, sizeof(pd));
while((tagtotallength = erf_meta_read_tag(&tag, state.tag_ptr, state.remaining_len))) {
if (ERF_META_IS_SECTION(tag.type)) {
state.sectiontype = tag.type;
if (tag.length >= 4) {
state.sectionid = pntohu16(tag.value);
} else {
state.sectionid = 0;
}
/* Skip sections that don't apply to the general set of records */
if (!(state.sectionid & 0x8000)) {
found_normal_section = true;
if(tag.type == ERF_META_SECTION_CAPTURE) {
/* Found the Capture Section */
found_capture_section = true;
}
}
} else {
if (state.sectiontype == ERF_META_SECTION_CAPTURE && !(state.sectionid & 0x8000)) {
if (tag.type == ERF_META_TAG_comment) {
/* XXX: Only compare the first comment tag */
if(!comment_ptr) {
comment_ptr = g_strndup((char*)tag.value, tag.length);
}
break;
}
}
}
/* Read until we have the Capture section */
state.tag_ptr += tagtotallength;
state.remaining_len -= tagtotallength;
}
if(found_capture_section && (comment_ptr || dump_priv->user_comment_ptr)) {
if(g_strcmp0(comment_ptr, dump_priv->user_comment_ptr)
&& !(dump_priv->user_comment_ptr == NULL && comment_ptr && comment_ptr[0] == '\0')) {
/* Also treat "" in ERF as equivalent to NULL as that is how we clear the comment on write. */
/* Comments are different, we should write extra metadata record at the end of the list */
dump_priv->write_next_extra_meta = true;
g_free(comment_ptr);
return true;
} else {
/* We have a capture comment but there is no change, we don't
* need to insert the 'changed' comment. This most likely happened
* because we were looking at list of periodic records and got up to the
* one where the comment was last set. */
dump_priv->write_next_extra_meta = false;
}
/* Otherwise no effect on whether we need to write extra metadata record */
}
/* We didn't find a capture section (e.g. looking at a comment Anchor
* record), or the comment hadn't changed. */
g_free(comment_ptr);
/* Return whether we found any non-local metadata (i.e. whether the record has
* metadata that is more than just packet 'comments') */
return found_normal_section;
}
static void erf_close(wtap *wth)
{
erf_t* erf_priv = (erf_t*)wth->priv;
erf_priv_free(erf_priv);
/* XXX: Prevent double free by wtap_close() */
wth->priv = NULL;
}
static const struct supported_option_type section_block_options_supported[] = {
{ OPT_COMMENT, ONE_OPTION_SUPPORTED }, /* XXX - multiple? */
{ OPT_SHB_USERAPPL, ONE_OPTION_SUPPORTED }
};
static const struct supported_option_type interface_block_options_supported[] = {
{ OPT_COMMENT, ONE_OPTION_SUPPORTED }, /* XXX - multiple? */
{ OPT_IDB_NAME, ONE_OPTION_SUPPORTED },
{ OPT_IDB_DESCRIPTION, ONE_OPTION_SUPPORTED },
{ OPT_IDB_OS, ONE_OPTION_SUPPORTED },
{ OPT_IDB_TSOFFSET, ONE_OPTION_SUPPORTED },
{ OPT_IDB_SPEED, ONE_OPTION_SUPPORTED },
{ OPT_IDB_IP4ADDR, ONE_OPTION_SUPPORTED }, /* XXX - multiple? */
{ OPT_IDB_IP6ADDR, ONE_OPTION_SUPPORTED }, /* XXX - multiple? */
{ OPT_IDB_FILTER, ONE_OPTION_SUPPORTED },
{ OPT_IDB_FCSLEN, ONE_OPTION_SUPPORTED }
};
static const struct supported_option_type packet_block_options_supported[] = {
{ OPT_COMMENT, ONE_OPTION_SUPPORTED } /* XXX - multiple? */
};
static const struct supported_block_type erf_blocks_supported[] = {
/*
* Per-file comments and application supported; section blocks
* are used for that.
* ERF files have only one section. (XXX - true?)
*/
{ WTAP_BLOCK_SECTION, ONE_BLOCK_SUPPORTED, OPTION_TYPES_SUPPORTED(section_block_options_supported) },
/*
* ERF supports multiple interfaces, with information, and
* supports associating packets with interfaces. Interface
* description blocks are used for that.
*/
{ WTAP_BLOCK_IF_ID_AND_INFO, MULTIPLE_BLOCKS_SUPPORTED, OPTION_TYPES_SUPPORTED(interface_block_options_supported) },
/*
* Name resolution is supported, but we don't support comments.
*/
{ WTAP_BLOCK_NAME_RESOLUTION, ONE_BLOCK_SUPPORTED, NO_OPTIONS_SUPPORTED },
/*
* ERF is a capture format, so it obviously supports packets.
*/
{ WTAP_BLOCK_PACKET, MULTIPLE_BLOCKS_SUPPORTED, OPTION_TYPES_SUPPORTED(packet_block_options_supported) }
};
static const struct file_type_subtype_info erf_info = {
"Endace ERF capture", "erf", "erf", NULL,
false, BLOCKS_SUPPORTED(erf_blocks_supported),
erf_dump_can_write_encap, erf_dump_open, NULL
};
void register_erf(void)
{
erf_file_type_subtype = wtap_register_file_type_subtype(&erf_info);
/*
* Register name for backwards compatibility with the
* wtap_filetypes table in Lua.
*/
wtap_register_backwards_compatibility_lua_name("ERF", erf_file_type_subtype);
}
/*
* Editor modelines - https://www.wireshark.org/tools/modelines.html
*
* Local Variables:
* c-basic-offset: 2
* tab-width: 8
* indent-tabs-mode: nil
* End:
*
* vi: set shiftwidth=2 tabstop=8 expandtab:
* :indentSize=2:tabSize=8:noTabs=true:
*/
|