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
|
// That's not a module as we do refactoring right now in small steps
// TODO: place make it proper module
void update_ipfix_sampling_rate(uint32_t sampling_rate, const std::string& client_addres_in_string_format);
// https://tools.ietf.org/html/rfc5101#page-18
bool process_ipfix_options_template(const uint8_t* pkt, size_t flowset_length, uint32_t source_id, const std::string& client_addres_in_string_format) {
const ipfix_options_header_common_t* options_template_header = (ipfix_options_header_common_t*)pkt;
if (flowset_length < sizeof(ipfix_options_header_common_t)) {
logger << log4cpp::Priority::ERROR << "Short IPFIX options template header " << flowset_length << " bytes. "
<< "Agent IP: " << client_addres_in_string_format;
return false;
}
uint16_t flowset_id = fast_ntoh(options_template_header->flowset_id);
// Yes, we have flow set length in options_template_header->length but we've read it on previous step and we can use it from argument of this function instead
if (flowset_id != IPFIX_OPTIONS_FLOWSET_ID) {
logger << log4cpp::Priority::ERROR << "For options template we expect " << IPFIX_OPTIONS_FLOWSET_ID
<< "flowset_id but got "
"another id: "
<< flowset_id << "Agent IP: " << client_addres_in_string_format;
return false;
}
// logger << log4cpp::Priority::INFO << "flowset_id " << flowset_id << " flowset_length: " << flowset_length;
const ipfix_options_header_t* options_nested_header =
(const ipfix_options_header_t*)(pkt + sizeof(ipfix_options_header_common_t));
// Check that we have enough space in packet to read ipfix_options_header_t
if (flowset_length < sizeof(ipfix_options_header_common_t) + sizeof(ipfix_options_header_t)) {
logger << log4cpp::Priority::ERROR << "Could not read specific header for IPFIX options template."
<< "Agent IP: " << client_addres_in_string_format;
return false;
}
// logger << log4cpp::Priority::INFO << "raw undecoded data template_id: " << options_nested_header->template_id <<
// " field_count: " << options_nested_header->field_count
// << " scope_field_count: " << options_nested_header->scope_field_count;
// Get all fields from options_nested_header
uint16_t template_id = fast_ntoh(options_nested_header->template_id);
uint16_t field_count = fast_ntoh(options_nested_header->field_count);
uint16_t scope_field_count = fast_ntoh(options_nested_header->scope_field_count);
// According to RFC scope_field_count must not be zero but I'll assume that some vendors may fail to implement it
// https://tools.ietf.org/html/rfc7011#page-24
// logger << log4cpp::Priority::INFO << "Options template id: " << template_id << " field_count: " << field_count
// << " scope_field_count: " << scope_field_count;
if (template_id <= 255) {
logger << log4cpp::Priority::ERROR << "Template ID for IPFIX options template should be bigger than 255, got "
<< template_id << " Agent IP: " << client_addres_in_string_format;
return false;
}
logger << log4cpp::Priority::DEBUG << "Options template id: " << template_id << " field_count: " << field_count
<< " scope_field_count: " << scope_field_count;
// According to RFC field_count includes scope_field_count
// https://tools.ietf.org/html/rfc7011#page-24 "Number of all fields in this Options Template Record, including the Scope Fields."
if (scope_field_count > field_count) {
logger << log4cpp::Priority::ERROR << "Number of scope fields " << scope_field_count
<< " cannot exceed number of all fields: " << field_count << " Agent IP: " << client_addres_in_string_format;
return false;
}
// Calculate number of all normal fields
uint16_t normal_field_count = field_count - scope_field_count;
// Shift our temporary pointer to place where scope section begins
const uint8_t* current_pointer_in_packet =
(const uint8_t*)(pkt + sizeof(ipfix_options_header_common_t) + sizeof(ipfix_options_header_t));
uint32_t scopes_total_size = 0;
uint32_t scopes_payload_total_size = 0;
// Then we have scope fields in packet, I'm not going to process them, I'll just skip them
for (int scope_index = 0; scope_index < scope_field_count; scope_index++) {
const ipfix_template_flowset_record_t* current_scopes_record =
(const ipfix_template_flowset_record_t*)(current_pointer_in_packet);
// Check that our attempt to read ipfix_template_flowset_record_t will not exceed packet length
if (flowset_length < sizeof(ipfix_options_header_common_t) + sizeof(ipfix_options_header_t) +
sizeof(ipfix_template_flowset_record_t)) {
logger << log4cpp::Priority::ERROR << "Attempt to read IPFIX flowset_record outside of packet. "
<< "Agent IP: " << client_addres_in_string_format;
return false;
}
uint16_t scope_field_size = fast_ntoh(current_scopes_record->length);
uint16_t scope_field_type = fast_ntoh(current_scopes_record->type);
logger << log4cpp::Priority::DEBUG << "Reading scope section with size " << scope_field_size << " and type: " << scope_field_type;
// Increment scopes size
scopes_total_size += sizeof(ipfix_template_flowset_record_t);
// Increment payload size
scopes_payload_total_size += scope_field_size;
// Shift pointer to the end of current scope field
current_pointer_in_packet = (const uint8_t*)(current_pointer_in_packet + sizeof(ipfix_template_flowset_record_t));
}
// We've reached normal fields section
uint32_t normal_fields_total_size = 0;
std::vector<template_record_t> template_records_map;
uint32_t normal_fields_payload_total_size = 0;
// Try to read all normal fields
for (int field_index = 0; field_index < normal_field_count; field_index++) {
const ipfix_template_flowset_record_t* current_normal_record =
(const ipfix_template_flowset_record_t*)(current_pointer_in_packet);
// Check that our attempt to read ipfix_template_flowset_record_t will not exceed packet length
if (flowset_length < sizeof(ipfix_options_header_common_t) + sizeof(ipfix_options_header_t) +
scopes_total_size + sizeof(ipfix_template_flowset_record_t)) {
logger << log4cpp::Priority::ERROR << "Attempt to read IPFIX flowset_record outside of packet for normal field. "
<< "Agent IP: " << client_addres_in_string_format;
return false;
}
uint16_t normal_field_size = fast_ntoh(current_normal_record->length);
uint16_t normal_field_type = fast_ntoh(current_normal_record->type);
template_record_t current_record;
current_record.record_type = normal_field_type;
current_record.record_length = normal_field_size;
template_records_map.push_back(current_record);
logger << log4cpp::Priority::DEBUG << "Reading IPFIX options field with size " << normal_field_size
<< " and type: " << normal_field_type;
// Increment total field size
normal_fields_total_size += sizeof(ipfix_template_flowset_record_t);
// Increment total payload size
normal_fields_payload_total_size += normal_field_size;
// Shift pointer to the end of current normal field
current_pointer_in_packet = (const uint8_t*)(current_pointer_in_packet + sizeof(ipfix_template_flowset_record_t));
}
template_t field_template{};
field_template.template_id = template_id;
field_template.records = template_records_map;
// I do not think that we use it in our logic but I think it's reasonable to set it to number of normal fields
field_template.num_records = normal_field_count;
field_template.total_length = normal_fields_payload_total_size + scopes_payload_total_size;
field_template.type = netflow_template_type_t::Options;
field_template.option_scope_length = scopes_payload_total_size;
// We need to know when we received it
field_template.timestamp = current_inaccurate_time;
// logger << log4cpp::Priority::INFO << "Read options template:" << print_template(field_template);
// Add/update template
bool updated = false;
bool updated_existing_template = false;
add_update_peer_template(netflow_protocol_version_t::ipfix, global_ipfix_templates, global_ipfix_templates_mutex, source_id,
template_id, client_addres_in_string_format, field_template, updated, updated_existing_template);
// This code is not perfect from locks perspective as we read global_ipfix_templates without any locks below
// NB! Please be careful with changing name of variable as it's part of serialisation protocol
if (updated_existing_template) {
ipfix_template_data_updates++;
}
return true;
}
bool process_ipfix_template(const uint8_t* pkt, size_t flowset_length, uint32_t source_id, const std::string& client_addres_in_string_format) {
const ipfix_flowset_header_common_t* template_header = (const ipfix_flowset_header_common_t*)pkt;
if (flowset_length < sizeof(*template_header)) {
logger << log4cpp::Priority::ERROR << "Short IPFIX flowset template header " << flowset_length
<< " bytes. Agent IP: " << client_addres_in_string_format;
return false;
}
if (ntohs(template_header->flowset_id) != IPFIX_TEMPLATE_FLOWSET_ID) {
logger << log4cpp::Priority::ERROR
<< "Function process_ipfix_template expects only "
"IPFIX_TEMPLATE_FLOWSET_ID but "
"got another id: "
<< ntohs(template_header->flowset_id) << " Agent IP: " << client_addres_in_string_format;
return false;
}
// These fields use quite complicated encoding and we need to identify them first
bool ipfix_variable_length_elements_used = false;
for (uint32_t offset = sizeof(*template_header); offset < flowset_length;) {
const ipfix_template_flowset_header_t* tmplh = (const ipfix_template_flowset_header_t*)(pkt + offset);
uint32_t template_id = ntohs(tmplh->template_id);
uint32_t record_count = ntohs(tmplh->record_count);
offset += sizeof(*tmplh);
std::vector<template_record_t> template_records_map;
uint32_t total_template_data_size = 0;
for (uint32_t i = 0; i < record_count; i++) {
if (offset >= flowset_length) {
logger << log4cpp::Priority::ERROR << "Short IPFIX flowset template. Agent IP: " << client_addres_in_string_format;
return false;
}
const ipfix_template_flowset_record_t* tmplr = (const ipfix_template_flowset_record_t*)(pkt + offset);
uint32_t record_type = ntohs(tmplr->type);
uint32_t record_length = ntohs(tmplr->length);
template_record_t current_record;
current_record.record_type = record_type;
current_record.record_length = record_length;
// it's special size which actually means that variable length encoding was used for this field
// https://datatracker.ietf.org/doc/html/rfc7011#page-37
if (record_length == 65535) {
ipfix_variable_length_elements_used = true;
}
template_records_map.push_back(current_record);
offset += sizeof(*tmplr);
if (record_type & IPFIX_ENTERPRISE) {
offset += sizeof(uint32_t); /* XXX -- ? */
}
total_template_data_size += record_length;
}
// We use same struct as Netflow v9 because Netflow v9 and IPFIX use similar fields
template_t field_template;
field_template.template_id = template_id;
field_template.num_records = record_count;
field_template.total_length = total_template_data_size;
field_template.records = template_records_map;
field_template.type = netflow_template_type_t::Data;
field_template.ipfix_variable_length_elements_used = ipfix_variable_length_elements_used;
// We need to know when we received it
field_template.timestamp = current_inaccurate_time;
bool updated = false;
bool updated_existing_template = false;
add_update_peer_template(netflow_protocol_version_t::ipfix, global_ipfix_templates,
global_ipfix_templates_mutex, source_id, template_id, client_addres_in_string_format,
field_template, updated, updated_existing_template);
if (updated_existing_template) {
ipfix_template_data_updates++;
}
}
return true;
}
bool ipfix_record_to_flow(uint32_t record_type, uint32_t record_length, const uint8_t* data, simple_packet_t& packet, netflow_meta_info_t& flow_meta) {
switch (record_type) {
case IPFIX_IN_BYTES:
if (record_length > sizeof(packet.length)) {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_IN_BYTES: " << record_length;
}
} else {
BE_COPY(packet.length);
// decode data in network byte order to host byte order
packet.length = fast_ntoh(packet.length);
// IPFIX carries only information about number of octets including IP headers and IP payload
// which is exactly what we need for ip_length field
packet.ip_length = packet.length;
}
break;
case IPFIX_IN_PACKETS:
if (record_length > sizeof(packet.number_of_packets)) {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_IN_PACKETS: " << record_length;
}
} else {
BE_COPY(packet.number_of_packets);
packet.number_of_packets = fast_ntoh(packet.number_of_packets);
}
break;
case IPFIX_IN_PROTOCOL:
if (record_length > sizeof(packet.protocol)) {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_IN_PROTOCOL: " << record_length;
}
} else {
BE_COPY(packet.protocol);
packet.protocol = fast_ntoh(packet.protocol);
}
break;
case IPFIX_TCP_FLAGS:
if (record_length == 1) {
BE_COPY(packet.flags);
} else if (record_length == 2) {
// If exported as a single octet with reduced-size encoding, this Information Element covers the low-order
// octet of this field (i.e, bits 0x80 to 0x01), omitting the ECN Nonce Sum and the three Future Use bits.
// https://www.iana.org/assignments/ipfix/ipfix.xhtml
// So we just copy second byte which carries same information as when it encoded with 1 byte
memcpy(&packet.flags, data + 1, 1);
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_TCP_FLAGS: " << record_length;
}
}
break;
case IPFIX_L4_SRC_PORT:
if (record_length > sizeof(packet.source_port)) {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_L4_SRC_PORT: " << record_length;
}
} else {
BE_COPY(packet.source_port);
// We should convert port to host byte order
packet.source_port = fast_ntoh(packet.source_port);
}
break;
case IPFIX_L4_DST_PORT:
if (record_length > sizeof(packet.destination_port)) {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_L4_DST_PORT: " << record_length;
}
} else {
BE_COPY(packet.destination_port);
// We should convert port to host byte order
packet.destination_port = fast_ntoh(packet.destination_port);
}
break;
case IPFIX_TCP_SOURCE_PORT:
// This is unusual encoding used only by AMD Pensando
// We enable it only we know that packet is TCP
if (packet.protocol == IPPROTO_TCP) {
if (record_length == 2) {
uint16_t port = 0;
memcpy(&port, data, record_length);
packet.source_port = fast_ntoh(port);
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_TCP_SOURCE_PORT: " << record_length;
}
}
}
break;
case IPFIX_TCP_DESTINATION_PORT:
// This is unusual encoding used only by AMD Pensando
// We enable it only we know that packet is TCP
if (packet.protocol == IPPROTO_TCP) {
if (record_length == 2) {
uint16_t port = 0;
memcpy(&port, data, record_length);
packet.destination_port = fast_ntoh(port);
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_TCP_DESTINATION_PORT: " << record_length;
}
}
}
break;
case IPFIX_UDP_SOURCE_PORT:
// This is unusual encoding used only by AMD Pensando
// We enable it only we know that packet is UDP
if (packet.protocol == IPPROTO_UDP) {
if (record_length == 2) {
uint16_t port = 0;
memcpy(&port, data, record_length);
packet.source_port = fast_ntoh(port);
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_UDP_SOURCE_PORT: " << record_length;
}
}
}
break;
case IPFIX_UDP_DESTINATION_PORT:
// This is unusual encoding used only by AMD Pensando
// We enable it only we know that packet is UDP
if (packet.protocol == IPPROTO_UDP) {
if (record_length == 2) {
uint16_t port = 0;
memcpy(&port, data, record_length);
packet.destination_port = fast_ntoh(port);
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_UDP_DESTINATION_PORT: " << record_length;
}
}
}
break;
case IPFIX_IPV4_SRC_ADDR:
if (record_length > sizeof(packet.src_ip)) {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_IPV4_SRC_ADDR: " << record_length;
}
} else {
memcpy(&packet.src_ip, data, record_length);
}
break;
case IPFIX_IPV4_DST_ADDR:
if (record_length > sizeof(packet.dst_ip)) {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_IPV4_DST_ADDR: " << record_length;
}
} else {
memcpy(&packet.dst_ip, data, record_length);
}
break;
// There is a similar field IPFIX_BGP_NEXT_HOP_IPV4_ADDRESS but with slightly different meaning
case IPFIX_IPV4_NEXT_HOP:
if (record_length == 4) {
uint32_t ip_next_hop_ipv4 = 0;
memcpy(&ip_next_hop_ipv4, data, record_length);
flow_meta.ip_next_hop_ipv4_set = true;
flow_meta.ip_next_hop_ipv4 = ip_next_hop_ipv4;
// std::cout << "IP next hop: " << convert_ip_as_uint_to_string(ip_next_hop_ipv4) << std::endl;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_IPV4_NEXT_HOP: " << record_length;
}
}
break;
// There is a similar field IPFIX_IPV4_NEXT_HOP but with slightly different meaning
case IPFIX_BGP_NEXT_HOP_IPV4_ADDRESS:
// Juniper MX uses this field
if (record_length == 4) {
uint32_t bgp_next_hop_ipv4 = 0;
memcpy(&bgp_next_hop_ipv4, data, record_length);
flow_meta.bgp_next_hop_ipv4_set = true;
flow_meta.bgp_next_hop_ipv4 = bgp_next_hop_ipv4;
// std::cout << "BGP next hop: " << convert_ip_as_uint_to_string(bgp_next_hop_ipv4) << std::endl;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_BGP_NEXT_HOP_IPV4_ADDRESS: " << record_length;
}
}
break;
case IPFIX_IPV6_NEXT_HOP:
// Juniper MX uses this field
if (record_length == 16) {
in6_addr bgp_next_hop_ipv6{};
memcpy(&bgp_next_hop_ipv6, data, record_length);
flow_meta.bgp_next_hop_ipv6_set = true;
flow_meta.bgp_next_hop_ipv6 = bgp_next_hop_ipv6;
// std::cout << "bgp next hop: " << print_ipv6_address(ipv6_next_hop) << std::endl;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_IPV6_NEXT_HOP: " << record_length;
}
}
break;
// According to https://www.iana.org/assignments/ipfix/ipfix.xhtml ASN can be 4 byte only
// Unfortunately, customer (Intermedia) shared pcap with ASNs encoded as 2 byte values :(
case IPFIX_SRC_AS:
if (record_length == 4) {
uint32_t src_asn = 0;
memcpy(&src_asn, data, record_length);
src_asn = fast_ntoh(src_asn);
packet.src_asn = src_asn;
} else if (record_length == 2) {
uint16_t src_asn = 0;
memcpy(&src_asn, data, record_length);
src_asn = fast_ntoh(src_asn);
packet.src_asn = src_asn;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_SRC_AS: " << record_length;
}
}
break;
case IPFIX_DST_AS:
if (record_length == 4) {
uint32_t dst_asn = 0;
memcpy(&dst_asn, data, record_length);
dst_asn = fast_ntoh(dst_asn);
packet.dst_asn = dst_asn;
} else if (record_length == 2) {
uint16_t dst_asn = 0;
memcpy(&dst_asn, data, record_length);
dst_asn = fast_ntoh(dst_asn);
packet.dst_asn = dst_asn;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_DST_AS: " << record_length;
}
}
break;
case IPFIX_SOURCE_MAC_ADDRESS:
if (record_length == 6) {
// Copy it directly to packet structure
memcpy(&packet.source_mac, data, record_length);
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Too large field for IPFIX_SOURCE_MAC_ADDRESS";
}
}
break;
case IPFIX_DESTINATION_MAC_ADDRESS:
if (record_length == 6) {
// Copy it directly to packet structure
memcpy(&packet.destination_mac, data, record_length);
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Too large field for IPFIX_DESTINATION_MAC_ADDRESS";
}
}
break;
// According to https://www.iana.org/assignments/ipfix/ipfix.xhtml interfaces can be 4 byte only
case IPFIX_INPUT_SNMP:
if (record_length == 4) {
uint32_t input_interface = 0;
memcpy(&input_interface, data, record_length);
input_interface = fast_ntoh(input_interface);
packet.input_interface = input_interface;
} else if (record_length == 2) {
uint16_t input_interface = 0;
memcpy(&input_interface, data, record_length);
input_interface = fast_ntoh(input_interface);
packet.input_interface = input_interface;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_INPUT_SNMP: " << record_length;
}
}
break;
case IPFIX_OUTPUT_SNMP:
if (record_length == 4) {
uint32_t output_interface = 0;
memcpy(&output_interface, data, record_length);
output_interface = fast_ntoh(output_interface);
packet.output_interface = output_interface;
} else if (record_length == 2) {
uint16_t output_interface = 0;
memcpy(&output_interface, data, record_length);
output_interface = fast_ntoh(output_interface);
packet.output_interface = output_interface;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_OUTPUT_SNMP: " << record_length;
}
}
break;
case IPFIX_IPV6_SRC_ADDR:
// It should be 16 bytes only
if (record_length == 16) {
memcpy(&packet.src_ipv6, data, record_length);
// Set protocol version to IPv6
packet.ip_protocol_version = 6;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_IPV6_SRC_ADDR: " << record_length;
}
}
break;
case IPFIX_IPV6_DST_ADDR:
// It should be 16 bytes only
if (record_length == 16) {
memcpy(&packet.dst_ipv6, data, record_length);
// Set protocol version to IPv6
packet.ip_protocol_version = 6;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_IPV6_DST_ADDR: " << record_length;
}
}
break;
case IPFIX_FIRST_SWITCHED:
// Mikrotik uses this encoding
if (record_length == 4) {
uint32_t flow_started = 0;
memcpy(&flow_started, data, record_length);
flow_started = fast_ntoh(flow_started);
packet.flow_start = flow_started;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_FIRST_SWITCHED: " << record_length;
}
}
break;
case IPFIX_LAST_SWITCHED:
// Mikrotik uses this encoding
if (record_length == 4) {
uint32_t flow_finished = 0;
memcpy(&flow_finished, data, record_length);
flow_finished = fast_ntoh(flow_finished);
packet.flow_end = flow_finished;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_LAST_SWITCHED: " << record_length;
}
}
break;
// Juniper uses IPFIX_FLOW_START_MILLISECONDS and IPFIX_FLOW_END_MILLISECONDS
case IPFIX_FLOW_START_MILLISECONDS:
if (record_length == 8) {
uint64_t flow_started = 0;
memcpy(&flow_started, data, record_length);
flow_started = fast_ntoh(flow_started);
// We cast unsigned to signed and it may cause issues
packet.flow_start = flow_started;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_FLOW_START_MILLISECONDS: " << record_length;
}
}
break;
case IPFIX_FLOW_END_MILLISECONDS:
if (record_length == 8) {
uint64_t flow_finished = 0;
memcpy(&flow_finished, data, record_length);
flow_finished = fast_ntoh(flow_finished);
// We cast unsigned to signed and it may cause issues
packet.flow_end = flow_finished;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_FLOW_END_MILLISECONDS: " << record_length;
}
}
break;
// Netgate TNSR uses IPFIX_FLOW_START_NANOSECONDS and IPFIX_FLOW_END_NANOSECONDS
case IPFIX_FLOW_START_NANOSECONDS:
if (record_length == 8) {
uint64_t flow_started = 0;
memcpy(&flow_started, data, record_length);
flow_started = fast_ntoh(flow_started);
// We cast unsigned to signed and it may cause issues
packet.flow_start = flow_started;
// Convert to milliseconds
packet.flow_start = packet.flow_start / 1000000;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_FLOW_START_NANOSECONDS: " << record_length;
}
}
break;
case IPFIX_FLOW_END_NANOSECONDS:
if (record_length == 8) {
uint64_t flow_finished = 0;
memcpy(&flow_finished, data, record_length);
flow_finished = fast_ntoh(flow_finished);
// We cast unsigned to signed and it may cause issues
packet.flow_end = flow_finished;
// Convert to milliseconds
packet.flow_end = packet.flow_end / 1000000;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_FLOW_END_NANOSECONDS: " << record_length;
}
}
break;
case IPFIX_FORWARDING_STATUS:
// TODO: we did using theoretical information and did not test it at all
// Documented here: https://www.iana.org/assignments/ipfix/ipfix.xhtml#forwarding-status
// Forwarding status is encoded on 1 byte with the 2 left bits giving the status and the 6 remaining bits giving the reason code.
if (record_length == 1) {
uint8_t forwarding_status = 0;
memcpy(&forwarding_status, data, record_length);
const netflow9_forwarding_status_t* forwarding_status_structure = (const netflow9_forwarding_status_t*)&forwarding_status;
// Decode numbers into forwarding statuses
packet.forwarding_status = forwarding_status_from_integer(forwarding_status_structure->status);
flow_meta.received_forwarding_status = true;
ipfix_forwarding_status++;
// logger << log4cpp::Priority::DEBUG << "Forwarding status: " << int(forwarding_status_structure->status) << " reason code: " << int(forwarding_status_structure->reason_code);
} else if (record_length == 4) {
// We received 4 byte encoding from Cisco ASR9006 running IOS XR 6.4.2
// It's new format which was added by RFC bugfix: https://datatracker.ietf.org/doc/draft-ietf-opsawg-ipfix-fixes/12/
// We still have only single byte with information but whole structure is larger
ipfix_forwarding_status_4_bytes_t forwarding_status{};
memcpy(&forwarding_status, data, record_length);
// Decode numbers into forwarding statuses
packet.forwarding_status = forwarding_status_from_integer(forwarding_status.status);
flow_meta.received_forwarding_status = true;
ipfix_forwarding_status++;
// logger << log4cpp::Priority::DEBUG << "Forwarding status: " << int(forwarding_status.status) << " reason code: " << int(forwarding_status.reason_code);
} else {
// It must be exactly one byte
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_FORWARDING_STATUS: " << record_length;
}
}
break;
case IPFIX_DATALINK_FRAME_SIZE:
if (record_length == 2) {
uint16_t datalink_frame_size = 0;
memcpy(&datalink_frame_size, data, record_length);
flow_meta.data_link_frame_size = fast_ntoh(datalink_frame_size);
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_DATALINK_FRAME_SIZE: " << record_length;
}
}
break;
case IPFIX_DATALINK_FRAME_SECTION: {
// Element 315: https://www.iana.org/assignments/ipfix/ipfix.xhtml
// It's packet header as is in variable length encoding
ipfix_inline_headers++;
// This packet is ended using IPFIX variable length encoding and it may have two possible ways of length
// encoding https://datatracker.ietf.org/doc/html/rfc7011#section-7
if (flow_meta.variable_field_length_encoding == variable_length_encoding_t::single_byte ||
flow_meta.variable_field_length_encoding == variable_length_encoding_t::two_byte) {
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Packet header length: " << flow_meta.variable_field_length;
}
if (flow_meta.variable_field_length != 0) {
bool read_packet_length_from_ip_header = true;
bool extract_tunnel_traffic = false;
const uint8_t* payload_shift = nullptr;
if (flow_meta.variable_field_length_encoding == variable_length_encoding_t::single_byte) {
payload_shift = data + sizeof(uint8_t);
} else if (flow_meta.variable_field_length_encoding == variable_length_encoding_t::two_byte) {
payload_shift = data + sizeof(uint8_t) + sizeof(uint16_t);
}
auto result =
parse_raw_packet_to_simple_packet_full_ng(payload_shift, flow_meta.variable_field_length,
flow_meta.variable_field_length, flow_meta.nested_packet,
extract_tunnel_traffic, read_packet_length_from_ip_header);
if (result != network_data_stuctures::parser_code_t::success) {
// Cannot decode data
ipfix_inline_header_parser_error++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Cannot parse packet header with error: "
<< network_data_stuctures::parser_code_to_string(result);
}
} else {
// Successfully decoded data
ipfix_inline_header_parser_success++;
flow_meta.nested_packet_parsed = true;
// logger << log4cpp::Priority::DEBUG << "IPFIX inline extracted packet: " << print_simple_packet(flow_meta.nested_packet);
}
} else {
ipfix_inline_encoding_error++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Zero length variable fields are not supported";
}
}
} else {
ipfix_inline_encoding_error++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unknown variable field encoding type";
}
}
break;
}
case IPFIX_FLOW_DIRECTION:
// It should be 1 byte value
if (record_length == 1) {
uint8_t flow_direction = 0;
memcpy(&flow_direction, data, record_length);
// According to RFC only two values possible: https://www.iana.org/assignments/ipfix/ipfix.xhtml
// 0x00: ingress flow
// 0x01: egress flow
// Juniper MX uses 255 to report unknown direction
// std::cout << "Flow direction: " << int(flow_direction) << std::endl;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_FLOW_DIRECTION: " << record_length;
}
}
break;
case IPFIX_FLOW_END_REASON:
// It should be 1 byte value
if (record_length == 1) {
uint8_t flow_end_reason = 0;
memcpy(&flow_end_reason, data, record_length);
// https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-flow-end-reason
if (flow_end_reason == 1) {
ipfix_flows_end_reason_idle_timeout++;
} else if (flow_end_reason == 2) {
ipfix_flows_end_reason_active_timeout++;
} else if (flow_end_reason == 3) {
ipfix_flows_end_reason_end_of_flow_timeout++;
} else if (flow_end_reason == 4) {
ipfix_flows_end_reason_force_end_timeout++;
} else if (flow_end_reason == 5) {
ipfix_flows_end_reason_lack_of_resource_timeout++;
}
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_FLOW_END_REASON: " << record_length;
}
}
break;
case IPFIX_FRAGMENT_IDENTIFICATION:
//
// Specification: https://www.rfc-editor.org/rfc/rfc5102.html#section-5.4.23
//
// IPFIX uses 32 bit values to accommodate following cases:
// - 16 bit IPv4 identification field https://www.rfc-editor.org/rfc/rfc791
// - 32 bit IPv6 identification field https://en.wikipedia.org/wiki/IPv6_packet#Fragment
//
// Juniper uses it on J MX platforms but they do not have much information about it:
// https://www.juniper.net/documentation/us/en/software/junos/flow-monitoring/topics/concept/inline-sampling-overview.html
// I asked https://t.me/dgubin about it
//
// I did review of dump from J MX and I can confirm that values for IPv4 do not exceed maximum value for uint16_t (65535)
//
// J MX is doing something fun with this field. I got dump in hands and in this dump of 42421 packets only 2337 have non zero value of this field.
// Clearly they violate RFC and do not populate this field unconditionally as RFC dictates.
//
// I see cases like this which is very likely non first fragment of fragmented series of packets as we do not have ports:
// Identification: 20203 ipv4:0 > ipv4:0 protocol: udp frag: 0 packets: 1 size: 352 bytes ip size: 352 bytes ttl: 0 sample ratio: 1
//
// And I see packets like this which may be first packet in fragmented series of packets as we do indeed have ports here and packet length is high:
// Identification: 2710 ipv4:53 > ipv4:45134 protocol: udp frag: 0 packets: 1 size: 1476 bytes ip size: 1476 bytes ttl: 0 sample ratio: 1
//
// And majority of packets looks this way:
// Identification: 0 ipv4:80 > ipv4:50179 protocol: tcp flags: ack frag: 0 packets: 1 size: 40 bytes ip size: 40 bytes ttl: 0 sample ratio: 1
//
// We clearly can distinguish first fragmented packet and non first fragmented packet
//
// TODO: this logic must be enabled via flag only as this is non RFC compliant behavior and we need to have confirmation from J
//
// We have this guide from J: https://www.juniper.net/documentation/us/en/software/junos/flow-monitoring/topics/concept/services-ipfix-flow-aggregation-ipv6-extended-attributes.html
// but it's written in exceptionally weird way and raises more questions then answers
//
// It's exactly 4 bytes
if (record_length == 4) {
uint32_t fragment_identification = 0;
memcpy(&fragment_identification, data, record_length);
fragment_identification = fast_ntoh(fragment_identification);
// logger << log4cpp::Priority::INFO << "Fragment identification: " << fragment_identification;
} else {
ipfix_too_large_field++;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_FRAGMENT_IDENTIFICATION: " << record_length;
}
}
break;
}
return true;
}
// Read options data packet with known template
bool ipfix_options_flowset_to_store(const uint8_t* pkt,
const ipfix_header_t* ipfix_header,
const template_t* flow_template,
const std::string& client_addres_in_string_format) {
// Skip scope fields, I really do not want to parse this information
pkt += flow_template->option_scope_length;
uint32_t sampling_rate = 0;
// Field shift in memory
uint32_t offset = 0;
// Sampling algorithm for exotic sampling types
uint16_t sampling_selector_algorithm = 0;
// We use these fields to work with systematic count-based Sampling Selector on Nokia
uint32_t sampling_packet_space = 0;
uint32_t sampling_packet_interval = 0;
device_timeouts_t device_timeouts{};
for (const auto& elem : flow_template->records) {
const uint8_t* data_shift = pkt + offset;
// Time to extract sampling rate
if (elem.record_type == IPFIX_SAMPLING_INTERVAL) {
// RFC suggest that this field is 4 byte: https://www.iana.org/assignments/ipfix/ipfix.xhtml
if (elem.record_length == 4) {
uint32_t current_sampling_rate = 0;
memcpy(¤t_sampling_rate, data_shift, elem.record_length);
// TODO: we do not convert value to little endian as sampling update function expects big endian / network byte order
sampling_rate = current_sampling_rate;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "4 byte encoded IPFIX_SAMPLING_INTERVAL sampling rate: " << sampling_rate
<< " from " << client_addres_in_string_format;
}
} else {
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpectedly big size for IPFIX_SAMPLING_INTERVAL: " << elem.record_length;
}
ipfix_too_large_field++;
}
} else if (elem.record_type == IPFIX_SAMPLING_PACKET_INTERVAL) {
// RFC suggest that this field is 4 byte: https://www.iana.org/assignments/ipfix/ipfix.xhtml
if (elem.record_length == 4) {
uint32_t current_sampling_packet_interval = 0;
memcpy(¤t_sampling_packet_interval, data_shift, elem.record_length);
current_sampling_packet_interval = fast_ntoh(current_sampling_packet_interval);
// Well, we need this information to deal with systematic count-based Sampling Selector on Nokia
sampling_packet_interval = current_sampling_packet_interval;
// And we need this value to use as regular sampling rate on Cisco NSC
// We need to return it to big endian again we sampling logic in IPFIX uses big endian / network byte order
sampling_rate = fast_hton(sampling_packet_interval);
} else {
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG
<< "Unexpectedly big size for IPFIX_SAMPLING_PACKET_INTERVAL: " << elem.record_length;
}
ipfix_too_large_field++;
}
} else if (elem.record_type == IPFIX_SAMPLING_PACKET_SPACE) {
// RFC requires this field to be 4 byte long
if (elem.record_length == 4) {
memcpy(&sampling_packet_space, data_shift, elem.record_length);
sampling_packet_space = fast_ntoh(sampling_packet_space);
} else {
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpected size for IPFIX_SAMPLING_PACKET_SPACE: " << elem.record_length;
}
ipfix_too_large_field++;
// We're OK to continue process, we should not stop it
}
} else if (elem.record_type == IPFIX_SAMPLING_SELECTOR_ALGORITHM) {
// RFC requires this field to be 2 byte long
// You can find all possible values for it here: https://www.iana.org/assignments/psamp-parameters/psamp-parameters.xhtml
if (elem.record_length == 2) {
memcpy(&sampling_selector_algorithm, data_shift, elem.record_length);
sampling_selector_algorithm = fast_ntoh(sampling_selector_algorithm);
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Decoded sampling selector algorithm " << sampling_selector_algorithm;
}
} else {
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG
<< "Unexpected size for IPFIX_SAMPLING_SELECTOR_ALGORITM: " << elem.record_length;
}
ipfix_too_large_field++;
// We're OK to continue process, we should not stop it
}
} else if (elem.record_type == IPFIX_ACTIVE_TIMEOUT) {
uint16_t active_timeout = 0;
// J MX204 with JunOS 19 encodes it with 2 bytes as RFC requires
if (elem.record_length == 2) {
memcpy(&active_timeout, data_shift, elem.record_length);
active_timeout = fast_ntoh(active_timeout);
ipfix_active_flow_timeout_received++;
device_timeouts.active_timeout = active_timeout;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Got active timeout: " << active_timeout << " seconds";
}
} else {
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpected size for IPFIX_ACTIVE_TIMEOUT: " << elem.record_length;
}
ipfix_too_large_field++;
}
} else if (elem.record_type == IPFIX_INACTIVE_TIMEOUT) {
uint16_t inactive_timeout = 0;
// J MX204 with JunOS 19 encodes it with 2 bytes as RFC requires
if (elem.record_length == 2) {
memcpy(&inactive_timeout, data_shift, elem.record_length);
inactive_timeout = fast_ntoh(inactive_timeout);
ipfix_inactive_flow_timeout_received++;
device_timeouts.inactive_timeout = inactive_timeout;
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Got inactive timeout: " << inactive_timeout << " seconds";
}
} else {
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Unexpected size for IPFIX_INACTIVE_TIMEOUT: " << elem.record_length;
}
ipfix_too_large_field++;
}
}
offset += elem.record_length;
}
// Additional logic to deal with systematic count-based Sampling Selector on Nokia Nokia 7750 SR
// https://www.rfc-editor.org/rfc/rfc5476.html#section-6.5.2.1
// We check that sampler selected non zero number of packets as additional sanity check that we deal with this
// specific type of sampler and to avoid division by zero
if (sampling_selector_algorithm == IPFIX_SAMPLER_TYPE_SYSTEMATIC_COUNT_BASED_SAMPLING && sampling_packet_interval != 0) {
// We have seen following cases from Nokia:
// Packet space: 999 packet interval 1
// Packet space: 9999 packet interval 1
//
// Packet interval is the number of packets selected from whole packet space
//
//
// We never seen packet interval which is not set to 1 but I prefer to cover this case too
// For values of packet interval after 1 we need to divide whole amount of observed packets
// (sampling_packet_space + sampling_packet_interval) by number of selected packets
//
uint32_t systematic_count_based_sampling_rate =
uint32_t(double(sampling_packet_space + sampling_packet_interval) / double(sampling_packet_interval));
// Update sampling rate
sampling_rate = fast_hton(systematic_count_based_sampling_rate);
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Packet space: " << sampling_packet_space << " packet interval "
<< sampling_packet_interval << " sampling " << systematic_count_based_sampling_rate;
}
}
update_ipfix_sampling_rate(sampling_rate, client_addres_in_string_format);
// Update flow timeouts in our store
update_device_flow_timeouts(device_timeouts, ipfix_per_device_flow_timeouts_mutex, ipfix_per_device_flow_timeouts,
client_addres_in_string_format, netflow_protocol_version_t::ipfix);
return true;
}
// This function reads flow set using passed template
// In case of irrecoverable errors it returns false
bool ipfix_flowset_to_store(const uint8_t* pkt,
const ipfix_header_t* ipfix_header,
ssize_t flowset_maximum_length,
const template_t* field_template,
uint32_t client_ipv4_address,
uint32_t& flowset_length,
const std::string& client_addres_in_string_format) {
simple_packet_t packet;
packet.source = NETFLOW;
packet.arrival_time = current_inaccurate_time;
packet.agent_ip_address = client_ipv4_address;
// We use shifted values and should process only zeroed values
// because we are working with little and big endian data in same time
packet.number_of_packets = 0;
packet.ts.tv_sec = ntohl(ipfix_header->time_sec);
{
std::lock_guard<std::mutex> lock(ipfix_sampling_rates_mutex);
auto itr = ipfix_sampling_rates.find(client_addres_in_string_format);
if (itr == ipfix_sampling_rates.end()) {
// Use global value
packet.sample_ratio = fastnetmon_global_configuration.netflow_sampling_ratio;
} else {
packet.sample_ratio = itr->second;
}
}
// By default, assume IPv4 traffic here
// But code below can switch it to IPv6
packet.ip_protocol_version = 4; //-V1048
// Place to keep meta information which is not needed in simple_simple_packet_t structure
netflow_meta_info_t flow_meta;
uint32_t offset = 0;
for (auto iter = field_template->records.begin(); iter != field_template->records.end(); iter++) {
uint32_t record_type = iter->record_type;
uint32_t record_length = iter->record_length;
// logger << log4cpp::Priority::DEBUG << "Reading record with type " << record_type << " and length " << record_length;
if (record_length == 65535) {
// OK, we're facing variable length field and it's damn complex
// It's not a perfect approach but I'm going to read field length right here as we need it for boundary checks
// We need to have at least one byte to read data
if (offset + sizeof(uint8_t) > flowset_maximum_length) {
logger << log4cpp::Priority::ERROR << "Attempt to read data after end of flowset for variable field length";
return false;
}
const uint8_t* field_length_ptr = (const uint8_t*)(pkt + offset);
if (*field_length_ptr == 0) {
logger << log4cpp::Priority::ERROR << "Zero length variable fields are not supported";
ipfix_inline_encoding_error++;
return false;
}
if (*field_length_ptr == 255) {
// 255 is special and it means that packet length is encoded in two following bytes
// Juniper PTX routers use this encoding even in case when packet length does not exceed 255 bytes
// RFC reference https://datatracker.ietf.org/doc/html/rfc7011#page-37
// In this case, the first octet of the
// Length field MUST be 255, and the length is carried in the second and
// third octets, as shown in Figure S.
// Read 2 byte length by skipping placeholder byte with 255
const uint16_t* two_byte_field_length_ptr = (const uint16_t*)(pkt + offset + sizeof(uint8_t));
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Two byte variable length encoding detected. Retrieved packet length: "
<< fast_ntoh(*two_byte_field_length_ptr);
}
// Pass variable payload length
flow_meta.variable_field_length = fast_ntoh(*two_byte_field_length_ptr);
// Override field length with length extracted from two bytes + length of placeholder byte itself
record_length = flow_meta.variable_field_length + sizeof(uint8_t) + sizeof(uint16_t);
// Pass variable payload length
flow_meta.variable_field_length = fast_ntoh(*two_byte_field_length_ptr);
// Specify length encoding type as it's required for payload retrieval process
flow_meta.variable_field_length_encoding = variable_length_encoding_t::two_byte;
} else {
// Pass variable payload length
flow_meta.variable_field_length = *field_length_ptr;
// Override field length with length extracted from leading byte
record_length = flow_meta.variable_field_length + sizeof(uint8_t);
// Specify length encoding type as it's required for payload retrieval process
flow_meta.variable_field_length_encoding = variable_length_encoding_t::single_byte;
}
}
// We do not need this check when we have only fixed length fields in template
// but this function is versatile and must handle all cases.
if (offset + record_length > flowset_maximum_length) {
logger << log4cpp::Priority::ERROR << "Attempt to read data after end of flowset. Offset: " << offset
<< " record length: " << record_length << " flowset_maximum_length: " << flowset_maximum_length;
return false;
}
bool ipfix_record_to_flow_result = ipfix_record_to_flow(record_type, record_length, pkt + offset, packet, flow_meta);
// In case of serious errors we stop loop completely
if (!ipfix_record_to_flow_result) {
return false;
}
offset += record_length;
}
// At this moment offset carries full length of all fields
flowset_length = offset;
// If we were able to decode nested packet then it means that it was Netflow Lite and we can overwrite information in packet
if (flow_meta.nested_packet_parsed) {
// Override most of the fields from nested packet as we need to use them instead
override_packet_fields_from_nested_packet(packet, flow_meta.nested_packet);
}
if (false) {
//
// For Juniper routers we need fancy logic to mark packets as dropped as it does not use RFC compliant IPFIX field for it
//
//
// The only reliable information we have from Juniper documentation is about Netflow v9
// https://apps.juniper.net/feature-explorer/feature-info.html?fKey=7679&fn=Enhancements%20to%20inline%20flow%20monitoring
// and we have no idea how it behaves in IPFIX mode.
//
// I think previously we had Juniper routers which set output interface to zero and both bgp_next_hop_ipv4 and
// ip_next_hop_ipv4 to zero values to report dropped and we checked only bgp_next_hop_ipv4 to identify dropped
// traffic. It worked well enough until we got flows explained below where bgp_next_hop_ipv4 is not 0.0.0.0 but
// ip_next_hop_ipv4 and output interface were set to zeroes.
//
// In May 2023 got dumps in Google drive "MX10003 and MX 480 dropped traffic" which confirms that Juniper MX
// 10003 / MX480 with JUNOS 20.4R3-S4.8 encode it using zero output interface and zero ip_next_hop_ipv4. In same
// time these dumps have bgp_next_hop_ipv4 set to real non zero value of next router. To address this issue we
// added alternative section to check for zeroe
//
// I posted question on LinkedIN: https://www.linkedin.com/feed/update/urn:li:activity:7062447441895141376/
//
// We will apply it only if we have no forwarding_status in packet
if (!flow_meta.received_forwarding_status) {
// We need to confirm that TWO rules are TRUE:
// - Output interface is 0
// - Next hop for IPv4 is set and set to 0 OR next hop for IPv6 set and set to zero
if (packet.output_interface == 0 &&
((flow_meta.bgp_next_hop_ipv4_set && flow_meta.bgp_next_hop_ipv4 == 0) ||
(flow_meta.ip_next_hop_ipv4_set && flow_meta.ip_next_hop_ipv4 == 0) ||
(is_zero_ipv6_address(flow_meta.bgp_next_hop_ipv6) && flow_meta.bgp_next_hop_ipv6_set))) {
packet.forwarding_status = forwarding_status_t::dropped;
ipfix_marked_zero_next_hop_and_zero_output_as_dropped++;
}
}
}
// std::cout << "bgp next hop: " << convert_ip_as_uint_to_string(flow_meta.bgp_next_hop_ipv4) << " set " << flow_meta.bgp_next_hop_ipv4_set
// << " " << print_ipv6_address(flow_meta.bgp_next_hop_ipv6) << " set " << flow_meta.bgp_next_hop_ipv6_set << " output interface: " << packet.output_interface << std::endl;
netflow_ipfix_all_protocols_total_flows++;
ipfix_total_flows++;
// We may have cases like this from previous step:
// :0000:443 > :0000:61444 protocol: tcp flags: psh,ack frag: 0 packets: 1 size: 205 bytes ip size: 205 bytes ttl:
// 0 sample ratio: 1000 It happens when router sends IPv4 and zero IPv6 fields in same packet
if (packet.ip_protocol_version == 6 && is_zero_ipv6_address(packet.src_ipv6) &&
is_zero_ipv6_address(packet.dst_ipv6) && packet.src_ip != 0 && packet.dst_ip != 0) {
ipfix_protocol_version_adjustments++;
packet.ip_protocol_version = 4;
}
if (packet.ip_protocol_version == 4) {
ipfix_total_ipv4_flows++;
} else if (packet.ip_protocol_version == 6) {
ipfix_total_ipv6_flows++;
}
double duration_float = packet.flow_end - packet.flow_start;
// Well, it does happen with Juniper QFX
if (duration_float < 0) {
ipfix_duration_negative++;
// I see no reasons to track duration of such cases because they're definitely broken
} else {
// Covert milliseconds to seconds
duration_float = duration_float / 1000;
int64_t duration = int64_t(duration_float);
// Increments duration counters
increment_duration_counters_ipfix(duration);
// logger<< log4cpp::Priority::INFO<< "Flow start: " << packet.flow_start << " end: " << packet.flow_end << " duration: " << duration;
// This logic also does not make any sense with negative duration of flows
}
// logger<< log4cpp::Priority::INFO<<"src asn: " << packet.src_asn << " " << "dst asn: " << packet.dst_asn;
// logger<< log4cpp::Priority::INFO<<"output: " << packet.output_interface << " " << " input: " << packet.input_interface;
// Logical sources of this logic are unknown but I'm sure we had reasons to do so
if (packet.protocol == IPPROTO_ICMP) {
// Explicitly set ports to zeros even if device sent something in these fields
packet.source_port = 0;
packet.destination_port = 0;
}
// pass data to FastNetMon
netflow_process_func_ptr(packet);
return true;
}
// That's kind of histogram emulation
void increment_duration_counters_ipfix(int64_t duration) {
if (duration == 0) {
ipfix_duration_0_seconds++;
} else if (duration <= 1) {
ipfix_duration_less_1_seconds++;
} else if (duration <= 2) {
ipfix_duration_less_2_seconds++;
} else if (duration <= 3) {
ipfix_duration_less_3_seconds++;
} else if (duration <= 5) {
ipfix_duration_less_5_seconds++;
} else if (duration <= 10) {
ipfix_duration_less_10_seconds++;
} else if (duration <= 15) {
ipfix_duration_less_15_seconds++;
} else if (duration <= 30) {
ipfix_duration_less_30_seconds++;
} else if (duration <= 60) {
ipfix_duration_less_60_seconds++;
} else if (duration <= 90) {
ipfix_duration_less_90_seconds++;
} else if (duration <= 180) {
ipfix_duration_less_180_seconds++;
} else {
ipfix_duration_exceed_180_seconds++;
}
return;
}
bool process_ipfix_data(const uint8_t* pkt,
size_t flowset_length,
const ipfix_header_t* ipfix_header,
uint32_t source_id,
const std::string& client_addres_in_string_format,
uint32_t client_ipv4_address) {
ipfix_total_packets++;
const ipfix_data_flowset_header_t* flowset_header = (const ipfix_data_flowset_header_t*)pkt;
if (flowset_length < sizeof(ipfix_data_flowset_header_t)) {
logger << log4cpp::Priority::ERROR << "Too short IPFIX flowset with not enough space for flowset header: " << flowset_length
<< " Agent: " << client_addres_in_string_format;
return false;
}
// Store packet end, it's useful for sanity checks
const uint8_t* flowset_end = pkt + flowset_length;
uint32_t flowset_id = ntohs(flowset_header->header.flowset_id);
const template_t* field_template = peer_find_template(global_ipfix_templates, global_ipfix_templates_mutex,
source_id, flowset_id, client_addres_in_string_format);
if (field_template == NULL) {
ipfix_packets_with_unknown_templates++;
logger << log4cpp::Priority::DEBUG << "We don't have a IPFIX template for flowset_id: " << flowset_id
<< " client " << client_addres_in_string_format << " source_id: " << source_id
<< " but it's not an error if this message disappears in some time "
"seconds. We need some time to learn them";
return false;
}
if (field_template->records.empty()) {
logger << log4cpp::Priority::ERROR << "There are no records in IPFIX template. Agent: " << client_addres_in_string_format;
return false;
}
uint32_t offset = sizeof(ipfix_data_flowset_header_t);
if (field_template->type == netflow_template_type_t::Data) {
if (field_template->ipfix_variable_length_elements_used) {
// When we have variable length fields we need to use different logic which relies on flow length calculated during process of reading flow
// Get clean flowsets length to use it as limit for our parser
ssize_t current_flowset_length_no_header = flowset_length - sizeof(ipfix_data_flowset_header_t);
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "IPFIX variable field element was used";
}
// Where all flows start in packet
const uint8_t* flow_section_start = pkt + sizeof(ipfix_data_flowset_header_t);
// Offset where flow starts
uint32_t flow_offset = 0;
// How much data we have in current flow set
uint32_t maximum_data_available_to_read = current_flowset_length_no_header;
// Run this loop until flow_offset reaches end of packet
while (flow_offset < current_flowset_length_no_header) {
// When variable fields present we need to read all fields before getting total length of flow
uint32_t read_flow_length = 0;
// In many cases we have just single flow per UDP packet but Juniper PTX uses multiple flows per packet
bool floset_processing_result =
ipfix_flowset_to_store(flow_section_start + flow_offset, ipfix_header, maximum_data_available_to_read,
field_template, client_ipv4_address, read_flow_length, client_addres_in_string_format);
// If we cannot process this flowset then we must stop processing here because we need correct value of flowset_length to jump to next record
if (!floset_processing_result) {
return false;
}
if (logger.getPriority() == log4cpp::Priority::DEBUG) {
logger << log4cpp::Priority::DEBUG << "Total flow length: " << read_flow_length;
}
// Shift flowset offset by length of data read in this iteration
flow_offset += read_flow_length;
// And in the same time reduce amount of available to read data
maximum_data_available_to_read -= read_flow_length;
}
} else {
// Check that template total length is not zero as we're going to divide by it
if (field_template->total_length == 0) {
logger << log4cpp::Priority::ERROR << "Zero IPFIX template length is not valid "
<< "client " << client_addres_in_string_format << " source_id: " << source_id;
return false;
}
// This logic is pretty reliable but it works only if we do not have variable sized fields in template
// In that case it's completely not applicable
// But I prefer to keep it as it's very predictable and works fix for fields fields
// Templates with only fixed fields are 99% of our installations and variable fields are very rare
uint32_t number_flowsets = (flowset_length - offset) / field_template->total_length;
// We need to calculate padding value
// IPFIX RFC explains it following way:
// https://datatracker.ietf.org/doc/html/rfc7011?ref=pavel.network#section-3.3.1
uint32_t flowset_padding = (flowset_length - offset) % field_template->total_length;
// Very likely data will be aligned by 4 byte boundaries and will have padding 1, 2, 3 bytes
// To be on safe side we assume that padding may be up to 7 bytes to achieve 8 byte boundaries
// All other values may be sign of some kind of issues. For example, it may be template conflicts
// https://pavel.network/its-just-wrong-to-update-ipfix-templates/
if (flowset_padding > 7) {
ipfix_flowsets_with_anomaly_padding++;
}
if (number_flowsets > 0x4000) {
logger << log4cpp::Priority::ERROR << "Very high number of IPFIX data flowsets " << number_flowsets
<< " Agent: " << client_addres_in_string_format
<< " flowset template length: " << field_template->total_length;
return false;
}
if (number_flowsets == 0) {
logger << log4cpp::Priority::ERROR << "Unexpected zero number of flowsets "
<< " agent: " << client_addres_in_string_format
<< " flowset template length: " << field_template->total_length << " flowset length "
<< flowset_length << " source_id " << source_id << " flowset_id: " << flowset_id;
return false;
}
for (uint32_t i = 0; i < number_flowsets; i++) {
// We do not use it as we can use total_length directly instead of calculating it
uint32_t flowset_length = 0;
// We apply constraint that maximum potential length of flow set cannot exceed length of all fields in
// template In this case we have no fields with variable length which may affect it and we're safe
// We do not check response code as we can jump to next flow even if previous one failed
ipfix_flowset_to_store(pkt + offset, ipfix_header, field_template->total_length, field_template,
client_ipv4_address, flowset_length, client_addres_in_string_format);
offset += field_template->total_length;
}
}
} else if (field_template->type == netflow_template_type_t::Options) {
ipfix_options_packet_number++;
// Check that we will not read outside of packet
if (pkt + offset + field_template->total_length > flowset_end) {
logger << log4cpp::Priority::ERROR << "We tried to read data outside packet for IPFIX options. "
<< "Agent: " << client_addres_in_string_format;
return false;
}
// Process options packet
ipfix_options_flowset_to_store(pkt + offset, ipfix_header, field_template, client_addres_in_string_format);
}
return true;
}
// Process IPFIX packet
bool process_ipfix_packet(const uint8_t* packet,
uint32_t udp_packet_length,
const std::string& client_addres_in_string_format,
uint32_t client_ipv4_address) {
const ipfix_header_t* ipfix_header = (const ipfix_header_t*)packet;
if (udp_packet_length < sizeof(ipfix_header_t)) {
logger << log4cpp::Priority::ERROR << "Packet is too short to accommodate IPFIX header " << udp_packet_length
<< " bytes which requires at least " << sizeof(ipfix_header_t) << " bytes";
return false;
}
// In compare with Netflow v9 IPFIX uses packet length instead of explicitly specified number of flows
// https://datatracker.ietf.org/doc/html/rfc7011#section-3.1
// Total length of the IPFIX Message, measured in octets, including Message Header and Set(s).
uint32_t ipfix_packet_length = fast_ntoh(ipfix_header->header.length);
if (udp_packet_length == ipfix_packet_length) {
// Under normal circumstances udp_packet_length must be equal to ipfix_packet_length
} else {
// If they're different we need to do more careful checks
if (udp_packet_length > ipfix_packet_length) {
// Theoretically it may happen if we have some padding on the end of packet
logger << log4cpp::Priority::DEBUG << "udp_packet_length exceeds ipfix_packet_length, suspect padding";
ipfix_packets_with_padding++;
}
// And this case we cannot tolerate
if (udp_packet_length < ipfix_packet_length) {
logger << log4cpp::Priority::DEBUG << "UDP packet it shorter (" << udp_packet_length << ")"
<< " then IPFIX data (" << ipfix_packet_length << "). Assume data corruption";
return false;
}
}
uint32_t source_id = ntohl(ipfix_header->source_id);
uint32_t offset = sizeof(*ipfix_header);
uint64_t flowset_number = 0;
// Yes, it's infinite loop but we apply boundaries inside to limit it
while (true) {
flowset_number++;
// We limit number of flow sets in packet and also use it for infinite loop prevention
if (flowset_number > flowsets_per_packet_maximum_number) {
logger << log4cpp::Priority::ERROR << "Infinite loop prevention triggered or we have so many flowsets inside IPFIX packet";
return false;
}
if (offset >= ipfix_packet_length) {
logger << log4cpp::Priority::ERROR
<< "We tried to read from address outside of IPFIX packet agent IP: " << client_addres_in_string_format;
return false;
}
// Check that we have enough space in packet to read flowset header
if (offset + sizeof(ipfix_flowset_header_common_t) > ipfix_packet_length) {
logger << log4cpp::Priority::ERROR
<< "Flowset is too short: we do not have space for flowset header. "
<< "IPFIX packet agent IP:" << client_addres_in_string_format
<< " flowset number: " << flowset_number << " offset: " << offset << " packet_length: " << ipfix_packet_length;
return false;
}
const ipfix_flowset_header_common_t* flowset = (const ipfix_flowset_header_common_t*)(packet + offset);
uint32_t flowset_id = ntohs(flowset->flowset_id);
uint32_t flowset_length = ntohs(flowset->length);
// One more check to ensure that we have enough space in packet to read whole flowset
if (offset + flowset_length > ipfix_packet_length) {
logger << log4cpp::Priority::ERROR
<< "We tried to read from address outside IPFIX packet flowset agent IP: " << client_addres_in_string_format;
return false;
}
switch (flowset_id) {
case IPFIX_TEMPLATE_FLOWSET_ID:
ipfix_data_templates_number++;
if (!process_ipfix_template(packet + offset, flowset_length, source_id, client_addres_in_string_format)) {
return false;
}
break;
case IPFIX_OPTIONS_FLOWSET_ID:
ipfix_options_templates_number++;
if (!process_ipfix_options_template(packet + offset, flowset_length, source_id, client_addres_in_string_format)) {
return false;
}
break;
default:
if (flowset_id < IPFIX_MIN_RECORD_FLOWSET_ID) {
logger << log4cpp::Priority::ERROR << "Received unknown IPFIX reserved flowset type " << flowset_id;
break; // interrupts only switch!
}
ipfix_data_packet_number++;
if (!process_ipfix_data(packet + offset, flowset_length, ipfix_header, source_id,
client_addres_in_string_format, client_ipv4_address)) {
return false;
}
break;
}
offset += flowset_length;
if (offset == ipfix_packet_length) {
break;
}
}
return true;
}
void update_ipfix_sampling_rate(uint32_t sampling_rate, const std::string& client_addres_in_string_format) {
if (sampling_rate == 0) {
return;
}
// NB! Incoming sampling rate is big endian / network byte order
auto new_sampling_rate = fast_ntoh(sampling_rate);
ipfix_custom_sampling_rate_received++;
logger << log4cpp::Priority::DEBUG << "I extracted sampling rate: " << new_sampling_rate << " for " << client_addres_in_string_format;
{
// Replace old sampling rate value
std::lock_guard<std::mutex> lock(ipfix_sampling_rates_mutex);
auto known_sampling_rate = ipfix_sampling_rates.find(client_addres_in_string_format);
if (known_sampling_rate == ipfix_sampling_rates.end()) {
// We had no sampling rates before
ipfix_sampling_rates[client_addres_in_string_format] = new_sampling_rate;
ipfix_sampling_rate_changes++;
logger << log4cpp::Priority::INFO << "Learnt new IPFIX sampling rate " << new_sampling_rate << " for "
<< client_addres_in_string_format;
} else {
auto old_sampling_rate = known_sampling_rate->second;
if (old_sampling_rate != new_sampling_rate) {
ipfix_sampling_rates[client_addres_in_string_format] = new_sampling_rate;
ipfix_sampling_rate_changes++;
logger << log4cpp::Priority::INFO << "Detected IPFIX sampling rate change from " << old_sampling_rate
<< " to " << new_sampling_rate << " for " << client_addres_in_string_format;
}
}
}
}
|