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
use super::*;
use std::{io, marker};
/// Helper for building packets.
///
/// The packet builder allows the easy construction of a packet from the
/// ethernet II layer downwards including ipv6, ipv4, the udp header and the
/// actual payload. The packet builder automatically calculates lengths & checksums
/// for ip & udp and set type identifiers for ethernetII and ip. This makes it
/// easy and less error prone to construct custom packets.
///
/// # Example:
///
/// Generating a packet that starts with an Ethernet II header:
///
/// ```
/// use etherparse::PacketBuilder;
///
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6], //source mac
/// [7,8,9,10,11,12]) //destionation mac
/// .ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// println!("{:?}", result);
/// ```
///
/// # Options
///
/// * Starting Options:
/// * [`PacketBuilder::ethernet2`]
/// * [`PacketBuilder::ip`]
/// * [`PacketBuilder::ipv4`]
/// * [`PacketBuilder::ipv6`]
/// * Options after an Ethernet2 header was added:
/// * [`PacketBuilderStep<Ethernet2Header>::vlan`]
/// * [`PacketBuilderStep<Ethernet2Header>::single_vlan`]
/// * [`PacketBuilderStep<Ethernet2Header>::double_vlan`]
/// * [`PacketBuilderStep<Ethernet2Header>::ip`]
/// * [`PacketBuilderStep<Ethernet2Header>::ipv4`]
/// * [`PacketBuilderStep<Ethernet2Header>::ipv6`]
/// * Options after an Vlan header was added:
/// * [`PacketBuilderStep<VlanHeader>::ip`]
/// * [`PacketBuilderStep<VlanHeader>::ipv4`]
/// * [`PacketBuilderStep<VlanHeader>::ipv6`]
/// * Options after an IP header was added:
/// * [`PacketBuilderStep<IpHeader>::write`]
/// * [`PacketBuilderStep<IpHeader>::tcp`]
/// * [`PacketBuilderStep<IpHeader>::udp`]
/// * [`PacketBuilderStep<IpHeader>::icmpv4`]
/// * [`PacketBuilderStep<IpHeader>::icmpv4_raw`]
/// * [`PacketBuilderStep<IpHeader>::icmpv4_echo_request`]
/// * [`PacketBuilderStep<IpHeader>::icmpv4_echo_reply`]
/// * [`PacketBuilderStep<IpHeader>::icmpv6`]
/// * [`PacketBuilderStep<IpHeader>::icmpv6_raw`]
/// * [`PacketBuilderStep<IpHeader>::icmpv6_echo_request`]
/// * [`PacketBuilderStep<IpHeader>::icmpv6_echo_reply`]
/// * Options after an TCP header was added:
/// * [`PacketBuilderStep<TcpHeader>::write`]
/// * [`PacketBuilderStep<TcpHeader>::size`]
/// * [`PacketBuilderStep<TcpHeader>::ns`]
/// * [`PacketBuilderStep<TcpHeader>::fin`]
/// * [`PacketBuilderStep<TcpHeader>::syn`]
/// * [`PacketBuilderStep<TcpHeader>::rst`]
/// * [`PacketBuilderStep<TcpHeader>::psh`]
/// * [`PacketBuilderStep<TcpHeader>::ack`]
/// * [`PacketBuilderStep<TcpHeader>::urg`]
/// * [`PacketBuilderStep<TcpHeader>::ece`]
/// * [`PacketBuilderStep<TcpHeader>::cwr`]
/// * [`PacketBuilderStep<TcpHeader>::options`]
/// * [`PacketBuilderStep<TcpHeader>::options_raw`]
/// * Options after an UDP header was added:
/// * [`PacketBuilderStep<UdpHeader>::write`]
/// * [`PacketBuilderStep<UdpHeader>::size`]
/// * Options after an ICMPv4 header was added:
/// * [`PacketBuilderStep<Icmpv4Header>::write`]
/// * [`PacketBuilderStep<Icmpv4Header>::size`]
/// * Options after an ICMPv6 header was added:
/// * [`PacketBuilderStep<Icmpv6Header>::write`]
/// * [`PacketBuilderStep<Icmpv6Header>::size`]
///
pub struct PacketBuilder {}
impl PacketBuilder {
/// Start an packet with an ethernetII header.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6], //source mac
/// [7,8,9,10,11,12]) //destionation mac
/// .ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn ethernet2(source: [u8;6], destination: [u8;6]) -> PacketBuilderStep<Ethernet2Header> {
PacketBuilderStep {
state: PacketImpl {
ethernet2_header: Some(Ethernet2Header{
source,
destination,
ether_type: 0 //the type identifier
}),
vlan_header: None,
ip_header: None,
transport_header: None
},
_marker: marker::PhantomData::<Ethernet2Header>{}
}
}
/// Starts a packet with an IPv4 header.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn ipv4(source: [u8;4], destination: [u8;4], time_to_live: u8) -> PacketBuilderStep<IpHeader> {
PacketBuilderStep {
state: PacketImpl {
ethernet2_header: None,
vlan_header: None,
ip_header: None,
transport_header: None
},
_marker: marker::PhantomData::<Ethernet2Header>{}
}.ipv4(source, destination, time_to_live)
}
/// Start a packet with an IPv6 header.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ipv6(
/// //source
/// [11,12,13,14,15,16,17,18,19,10,21,22,23,24,25,26],
/// //destination
/// [31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46],
/// //hop_limit
/// 47)
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn ipv6(source: [u8;16], destination: [u8;16], hop_limit: u8) -> PacketBuilderStep<IpHeader> {
PacketBuilderStep {
state: PacketImpl {
ethernet2_header: None,
vlan_header: None,
ip_header: None,
transport_header: None
},
_marker: marker::PhantomData::<Ethernet2Header>{}
}.ipv6(source, destination, hop_limit)
}
/// Starts a packet with an arbitrary IP header (length, protocol/next_header & checksum fields will be overwritten based on the rest of the packet).
///
/// # Examples
///
/// With an IPv4 header:
///
/// ```
/// # use etherparse::*;
/// #
/// let builder = PacketBuilder::
/// //payload_len, protocol & checksum will be replaced during write
/// ip(IpHeader::Version4(
/// Ipv4Header::new(
/// 0, //payload_len will be replaced during write
/// 12, //time_to_live
/// ip_number::UDP, //will be replaced during write
/// [0,1,2,3], //source
/// [4,5,6,7] //destination
/// ),
/// Default::default()))
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
///
/// With an IPv6 header:
///
/// ```
/// # use etherparse::*;
/// #
/// let builder = PacketBuilder::
/// ip(IpHeader::Version6(
/// Ipv6Header{
/// traffic_class: 0,
/// flow_label: 0,
/// payload_length: 0, //will be replaced during write
/// next_header: 0, //will be replaced during write
/// hop_limit: 4,
/// source: [0;16],
/// destination: [0;16]
/// },
/// Default::default()))
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn ip(ip_header: IpHeader) -> PacketBuilderStep<IpHeader> {
PacketBuilderStep {
state: PacketImpl {
ethernet2_header: None,
vlan_header: None,
ip_header: None,
transport_header: None
},
_marker: marker::PhantomData::<Ethernet2Header>{}
}.ip(ip_header)
}
}
struct PacketImpl {
ethernet2_header: Option<Ethernet2Header>,
ip_header: Option<IpHeader>,
vlan_header: Option<VlanHeader>,
transport_header: Option<TransportHeader>
}
///An unfinished packet that is build with the packet builder
pub struct PacketBuilderStep<LastStep> {
state: PacketImpl,
_marker: marker::PhantomData<LastStep>
}
impl PacketBuilderStep<Ethernet2Header> {
/// Add an IPv4 header
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6], //source mac
/// [7,8,9,10,11,12]) //destionation mac
/// .ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn ipv4(mut self, source: [u8;4], destination: [u8;4], time_to_live: u8) -> PacketBuilderStep<IpHeader> {
//add ip header
self.state.ip_header = Some(IpHeader::Version4({
let mut value: Ipv4Header = Default::default();
value.source = source;
value.destination = destination;
value.time_to_live = time_to_live;
value
}, Default::default()));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<IpHeader>{}
}
}
/// Add an IP header (length, protocol/next_header & checksum fields will be overwritten based on the rest of the packet).
///
/// # Examples
///
/// With an IPv4 header:
///
/// ```
/// # use etherparse::*;
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6],
/// [7,8,9,10,11,12])
/// //payload_len, protocol & checksum will be replaced during write
/// .ip(IpHeader::Version4(
/// Ipv4Header::new(
/// 0, //payload_len will be replaced during write
/// 12, //time_to_live
/// ip_number::UDP, //will be replaced during write
/// [0,1,2,3], //source
/// [4,5,6,7] //destination
/// ),
/// Default::default()));
/// ```
///
/// With an IPv6 header:
///
/// ```
/// # use etherparse::*;
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6],
/// [7,8,9,10,11,12])
/// .ip(IpHeader::Version6(
/// Ipv6Header{
/// traffic_class: 0,
/// flow_label: 0,
/// payload_length: 0, //will be replaced during write
/// next_header: 0, //will be replaced during write
/// hop_limit: 4,
/// source: [0;16],
/// destination: [0;16]
/// },
/// Default::default()));
/// ```
pub fn ip(mut self, ip_header: IpHeader) -> PacketBuilderStep<IpHeader> {
//add ip header
self.state.ip_header = Some(ip_header);
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<IpHeader>{}
}
}
/// Add an IPv6 header
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6],
/// [7,8,9,10,11,12])
/// .ipv6(
/// //source
/// [11,12,13,14,15,16,17,18,19,10,21,22,23,24,25,26],
/// //destination
/// [31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46],
/// //hop_limit
/// 47)
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn ipv6(mut self, source: [u8;16], destination: [u8;16], hop_limit: u8) -> PacketBuilderStep<IpHeader> {
self.state.ip_header = Some(IpHeader::Version6(Ipv6Header{
traffic_class: 0,
flow_label: 0,
payload_length: 0, //filled in on write
next_header: 0, //filled in on write
hop_limit,
source,
destination
}, Default::default()));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<IpHeader>{}
}
}
/// Adds a vlan tagging header with the given vlan identifier
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::{PacketBuilder, SingleVlanHeader, VlanHeader};
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6], //source mac
/// [7,8,9,10,11,12]) //destionation mac
/// .vlan(VlanHeader::Single(
/// SingleVlanHeader{
/// priority_code_point: 0,
/// drop_eligible_indicator: false,
/// vlan_identifier: 0x123,
/// ether_type: 0 // will be overwritten during write
/// }))
/// .ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn vlan(mut self, vlan: VlanHeader) -> PacketBuilderStep<VlanHeader> {
self.state.vlan_header = Some(vlan);
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<VlanHeader>{}
}
}
/// Adds a vlan tagging header with the given vlan identifier
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::{PacketBuilder, SingleVlanHeader, VlanHeader};
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6], //source mac
/// [7,8,9,10,11,12]) //destionation mac
/// .single_vlan(0x123) // vlan identifier
/// .ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn single_vlan(mut self, vlan_identifier: u16) -> PacketBuilderStep<VlanHeader> {
self.state.vlan_header = Some(VlanHeader::Single(SingleVlanHeader {
priority_code_point: 0,
drop_eligible_indicator: false,
vlan_identifier,
ether_type: 0, //will be set automatically during write
}));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<VlanHeader>{}
}
}
/// Adds two vlan tagging header with the given vlan identifiers (also known as double vlan tagging).
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::{PacketBuilder, SingleVlanHeader, VlanHeader};
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6], //source mac
/// [7,8,9,10,11,12]) //destionation mac
/// .double_vlan(0x123, // outer vlan identifier
/// 0x234) // inner vlan identifier
/// .ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn double_vlan(mut self, outer_vlan_identifier: u16, inner_vlan_identifier: u16) -> PacketBuilderStep<VlanHeader> {
self.state.vlan_header = Some(VlanHeader::Double(DoubleVlanHeader {
outer: SingleVlanHeader {
priority_code_point: 0,
drop_eligible_indicator: false,
vlan_identifier: outer_vlan_identifier,
ether_type: 0, //will be set automatically during write
},
inner: SingleVlanHeader {
priority_code_point: 0,
drop_eligible_indicator: false,
vlan_identifier: inner_vlan_identifier,
ether_type: 0, //will be set automatically during write
}
}));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<VlanHeader>{}
}
}
}
impl PacketBuilderStep<VlanHeader> {
///Add an ip header (length, protocol/next_header & checksum fields will be overwritten based on the rest of the packet).
///
/// # Example IPv4
/// ```
/// # use etherparse::*;
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6],
/// [7,8,9,10,11,12])
/// .single_vlan(0x132)
/// //payload_len, protocol & checksum will be replaced during write
/// .ip(IpHeader::Version4(
/// Ipv4Header::new(
/// 0, //payload_len will be replaced during write
/// 12, //time_to_live
/// ip_number::UDP, //will be replaced during write
/// [0,1,2,3], //source
/// [4,5,6,7] //destination
/// ),
/// Default::default() // IPv4 extension headers (default is none)
/// ));
/// ```
///
/// # Example IPv6
/// ```
/// # use etherparse::*;
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6],
/// [7,8,9,10,11,12])
/// .single_vlan(0x132)
/// .ip(IpHeader::Version6(
/// Ipv6Header{
/// traffic_class: 0,
/// flow_label: 0,
/// payload_length: 0, //will be replaced during write
/// next_header: 0, //will be replaced during write
/// hop_limit: 4,
/// source: [0;16],
/// destination: [0;16]
/// },
/// Default::default() // IPv6 extension headers (default is none)
/// ));
/// ```
pub fn ip(self, ip_header: IpHeader) -> PacketBuilderStep<IpHeader> {
//use the method from the Ethernet2Header implementation
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<Ethernet2Header>{}
}.ip(ip_header)
}
/// Add an IPv6 header
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::{PacketBuilder, SingleVlanHeader, VlanHeader};
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6], //source mac
/// [7,8,9,10,11,12]) //destionation mac
/// .single_vlan(0x123) // vlan identifier
/// .ipv6(
/// //source
/// [11,12,13,14,15,16,17,18,19,10,21,22,23,24,25,26],
/// //destination
/// [31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46],
/// //hop_limit
/// 47)
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn ipv6(self, source: [u8;16], destination: [u8;16], hop_limit: u8) -> PacketBuilderStep<IpHeader> {
//use the method from the Ethernet2Header implementation
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<Ethernet2Header>{}
}.ipv6(source, destination, hop_limit)
}
/// Add an IPv4 header
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::{PacketBuilder, SingleVlanHeader, VlanHeader};
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6], //source mac
/// [7,8,9,10,11,12]) //destionation mac
/// .single_vlan(0x123) // vlan identifier
/// .ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn ipv4(self, source: [u8;4], destination: [u8;4], time_to_live: u8) -> PacketBuilderStep<IpHeader> {
//use the method from the Ethernet2Header implementation
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<Ethernet2Header>{}
}.ipv4(source, destination, time_to_live)
}
}
impl PacketBuilderStep<IpHeader> {
/// Adds an ICMPv4 header of the given [`Icmpv4Type`] to the packet.
///
/// If an ICMPv4 header gets added the payload used during the builders `write`
/// call contains the bytes after the header and has different meanings
/// and contents based on the type. Ususally all statically sized values
/// known based on the ICMPv4 type & code are part of the header and the
/// payload is used to store contains the dynamic parts of the ICMPv4 packet.
///
/// Check [`Icmpv4Type`] for a documentation which values are part of the
/// header and what is stored as part of the payload.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::{PacketBuilder, Icmpv4Type, icmpv4};
/// #
/// let builder = PacketBuilder::
/// ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .icmpv4(
/// Icmpv4Type::TimeExceeded(
/// icmpv4::TimeExceededCode::TtlExceededInTransit
/// )
/// );
///
/// // what is part of the payload depends on the Icmpv4Type
/// //
/// // In case of `Icmpv4Type::TimeExceeded` the "internet header
/// // + 64 bits of the original data datagram" should be given as
/// // the payload
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn icmpv4(mut self, icmp_type: Icmpv4Type) -> PacketBuilderStep<Icmpv4Header> {
self.state.transport_header = Some(TransportHeader::Icmpv4(Icmpv4Header{
icmp_type,
checksum: 0, // calculated later
}));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<Icmpv4Header>{}
}
}
/// Adds an ICMPv4 header based on raw numbers.
///
/// This can be usefull when trying to build an ICMPv4 packet
/// which is not fully supported by etherparse and is the equivalent
/// of using [`Icmpv4Type::Unknown`] together with
/// [`PacketBuilderStep<IpHeader>::icmpv4`].
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .icmpv4_raw(
/// 253, // ICMPv4 type (e.g. 253 is RFC3692-style Experiment 1)
/// 0, // ICMPv4 code
/// [1,2,3,4] // bytes 5-8 in the ICMPv4 header
/// );
///
/// // the payload is written after the 8 byte raw ICMPv4 header
/// let payload = [1,2,3,4,5,6,7,8];
///
/// // get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// // serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn icmpv4_raw(mut self, type_u8: u8, code_u8: u8, bytes5to8: [u8;4]) -> PacketBuilderStep<Icmpv4Header> {
let icmp_type = Icmpv4Type::Unknown{type_u8, code_u8, bytes5to8};
self.state.transport_header = Some(TransportHeader::Icmpv4(Icmpv4Header{
icmp_type,
checksum: 0, // calculated later
}));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<Icmpv4Header>{}
}
}
/// Adds an ICMPv4 echo request packet.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .icmpv4_echo_request(
/// 123, // identifier
/// 456, // sequence number
/// );
///
/// // payload of the echo request
/// let payload = [1,2,3,4,5,6,7,8];
///
/// // get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// // serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn icmpv4_echo_request(mut self, id: u16, seq: u16) -> PacketBuilderStep<Icmpv4Header> {
let echo_header = IcmpEchoHeader{
id,
seq,
};
let icmpv4_echo = Icmpv4Header::new(Icmpv4Type::EchoRequest(echo_header));
self.state.transport_header = Some(TransportHeader::Icmpv4(icmpv4_echo));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<Icmpv4Header>{}
}
}
/// Adds an ICMPv4 echo reply packet.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .icmpv4_echo_reply(
/// 123, // identifier
/// 456, // sequence number
/// );
///
/// // payload of the echo reply
/// let payload = [1,2,3,4,5,6,7,8];
///
/// // get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// // serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn icmpv4_echo_reply(mut self, id: u16, seq: u16) -> PacketBuilderStep<Icmpv4Header> {
let echo_header = IcmpEchoHeader{
id,
seq,
};
let icmpv4_echo = Icmpv4Header::new(Icmpv4Type::EchoReply(echo_header));
self.state.transport_header = Some(TransportHeader::Icmpv4(icmpv4_echo));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<Icmpv4Header>{}
}
}
/// Adds an ICMPv6 header of the given [`Icmpv6Type`] to the packet.
///
/// If an ICMPv6 header gets added the payload used during the builders `write`
/// call contains the bytes after the header and has different meanings
/// and contents based on the type. Ususally all statically sized values
/// known based on the ICMPv6 type & code are part of the header and the
/// payload is used to store contains the dynamic parts of the ICMPv6 packet.
///
/// Check [`Icmpv6Type`] for a documentation which values are part of the
/// header and what is stored as part of the payload.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::{PacketBuilder, Icmpv6Type, icmpv6};
/// #
/// let builder = PacketBuilder::
/// ipv6(
/// //source
/// [11,12,13,14,15,16,17,18,19,10,21,22,23,24,25,26],
/// //destination
/// [31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46],
/// //hop_limit
/// 47)
/// .icmpv6(
/// Icmpv6Type::TimeExceeded(
/// icmpv6::TimeExceededCode::HopLimitExceeded
/// )
/// );
///
/// // what is part of the payload depends on the Icmpv6Type
/// //
/// // In case of `Icmpv6Type::TimeExceeded` "As much of invoking packet
/// // as possible without the ICMPv6 packet exceeding the minimum IPv6 MTU"
/// // should be given as the payload.
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn icmpv6(mut self, icmp_type: Icmpv6Type) -> PacketBuilderStep<Icmpv6Header> {
self.state.transport_header = Some(TransportHeader::Icmpv6(Icmpv6Header{
icmp_type,
checksum: 0, // calculated later
}));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<Icmpv6Header>{}
}
}
/// Adds an ICMPv6 header based on raw values.
///
/// This can be usefull when trying to build an ICMPv6 packet
/// which is not fully supported by etherparse and is the equivalent
/// of using [`Icmpv6Type::Unknown`] together with
/// [`PacketBuilderStep<IpHeader>::icmpv6`].
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ipv6(
/// //source
/// [11,12,13,14,15,16,17,18,19,10,21,22,23,24,25,26],
/// //destination
/// [31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46],
/// //hop_limit
/// 47)
/// .icmpv4_raw(
/// 200, // ICMPv6 type (e.g. 200 is for "private experimentation")
/// 0, // ICMPv6 code
/// [1,2,3,4] // bytes 5-8 in the ICMPv6 header
/// );
///
/// // the payload is written after the 8 byte raw ICMPv6 header
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn icmpv6_raw(mut self, type_u8: u8, code_u8: u8, bytes5to8: [u8;4]) -> PacketBuilderStep<Icmpv6Header> {
let icmp_type = Icmpv6Type::Unknown{type_u8, code_u8, bytes5to8};
self.state.transport_header = Some(TransportHeader::Icmpv6(Icmpv6Header{
icmp_type,
checksum: 0, // calculated later
}));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<Icmpv6Header>{}
}
}
/// Adds an ICMPv6 echo reply packet.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ipv6(
/// //source
/// [11,12,13,14,15,16,17,18,19,10,21,22,23,24,25,26],
/// //destination
/// [31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46],
/// //hop_limit
/// 47)
/// .icmpv6_echo_request(
/// 123, // identifier
/// 456, // sequence number
/// );
///
/// // payload of the echo request
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn icmpv6_echo_request(mut self, id: u16, seq: u16) -> PacketBuilderStep<Icmpv6Header> {
let echo_header = IcmpEchoHeader{
id,
seq,
};
let icmpv6_echo = Icmpv6Header::new(Icmpv6Type::EchoRequest(echo_header));
self.state.transport_header = Some(TransportHeader::Icmpv6(icmpv6_echo));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<Icmpv6Header>{}
}
}
/// Adds an ICMPv6 echo request packet.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ipv6(
/// //source
/// [11,12,13,14,15,16,17,18,19,10,21,22,23,24,25,26],
/// //destination
/// [31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46],
/// //hop_limit
/// 47)
/// .icmpv6_echo_reply(
/// 123, // identifier
/// 456, // sequence number
/// );
///
/// // payload of the echo reply
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn icmpv6_echo_reply(mut self, id: u16, seq: u16) -> PacketBuilderStep<Icmpv6Header> {
let echo_header = IcmpEchoHeader{
seq,
id,
};
let icmpv6_echo = Icmpv6Header::new(Icmpv6Type::EchoReply(echo_header));
self.state.transport_header = Some(TransportHeader::Icmpv6(icmpv6_echo));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<Icmpv6Header>{}
}
}
/// Adds an UDP header.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6], //source mac
/// [7,8,9,10,11,12]) //destionation mac
/// .ipv4([192,168,1,1], //source ip
/// [192,168,1,2], //desitionation ip
/// 20) //time to life
/// .udp(21, //source port
/// 1234); //desitnation port
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn udp(mut self, source_port: u16, destination_port: u16) -> PacketBuilderStep<UdpHeader> {
self.state.transport_header = Some(TransportHeader::Udp(UdpHeader{
source_port,
destination_port,
length: 0, //calculated later
checksum: 0 //calculated later
}));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<UdpHeader>{}
}
}
/// Adds an TCP header.
///
/// # Example
///
/// Basic usage:
///
/// ```
/// # use etherparse::PacketBuilder;
/// #
/// let builder = PacketBuilder::
/// ethernet2([1,2,3,4,5,6], // source mac
/// [7,8,9,10,11,12]) // destionation mac
/// .ipv4([192,168,1,1], // source ip
/// [192,168,1,2], // desitionation ip
/// 20) // time to life
/// .tcp(21, // source port
/// 12, // destination port
/// 12345, // sequence number
/// 4000); // window size
///
/// //payload of the udp packet
/// let payload = [1,2,3,4,5,6,7,8];
///
/// //get some memory to store the result
/// let mut result = Vec::<u8>::with_capacity(
/// builder.size(payload.len()));
///
/// //serialize
/// builder.write(&mut result, &payload).unwrap();
/// ```
pub fn tcp(mut self, source_port: u16, destination_port: u16, sequence_number: u32, window_size: u16) -> PacketBuilderStep<TcpHeader> {
self.state.transport_header = Some(TransportHeader::Tcp(
TcpHeader::new(source_port, destination_port, sequence_number, window_size)
));
//return for next step
PacketBuilderStep {
state: self.state,
_marker: marker::PhantomData::<TcpHeader>{}
}
}
/// Write all the headers and the payload with the given ip number.
///
/// `last_next_header_ip_number` will be set in the last extension header
/// or if no extension header exists the ip header as the "next header" or
/// "protocol number".
pub fn write<T: io::Write + Sized>(mut self, writer: &mut T, last_next_header_ip_number: u8, payload: &[u8]) -> Result<(),WriteError> {
self.state.ip_header.as_mut().unwrap().set_next_headers(last_next_header_ip_number);
final_write(self, writer, payload)
}
///Returns the size of the packet when it is serialized
pub fn size(&self, payload_size: usize) -> usize {
final_size(self, payload_size)
}
}
impl PacketBuilderStep<Icmpv4Header> {
/// Write all the headers and the payload.
pub fn write<T: io::Write + Sized>(self, writer: &mut T, payload: &[u8]) -> Result<(),WriteError> {
final_write(self, writer, payload)
}
/// Returns the size of the packet when it is serialized
pub fn size(&self, payload_size: usize) -> usize {
final_size(self, payload_size)
}
}
impl PacketBuilderStep<Icmpv6Header> {
///Write all the headers and the payload.
pub fn write<T: io::Write + Sized>(self, writer: &mut T, payload: &[u8]) -> Result<(),WriteError> {
final_write(self, writer, payload)
}
///Returns the size of the packet when it is serialized
pub fn size(&self, payload_size: usize) -> usize {
final_size(self, payload_size)
}
}
impl PacketBuilderStep<UdpHeader> {
///Write all the headers and the payload.
pub fn write<T: io::Write + Sized>(self, writer: &mut T, payload: &[u8]) -> Result<(),WriteError> {
final_write(self, writer, payload)
}
///Returns the size of the packet when it is serialized
pub fn size(&self, payload_size: usize) -> usize {
final_size(self, payload_size)
}
}
impl PacketBuilderStep<TcpHeader> {
///Set ns flag (ECN-nonce - concealment protection; experimental: see RFC 3540)
pub fn ns(mut self) -> PacketBuilderStep<TcpHeader> {
self.state.transport_header.as_mut().unwrap().mut_tcp().unwrap().ns = true;
self
}
///Set fin flag (No more data from sender)
pub fn fin(mut self) -> PacketBuilderStep<TcpHeader> {
self.state.transport_header.as_mut().unwrap().mut_tcp().unwrap().fin = true;
self
}
///Set the syn flag (synchronize sequence numbers)
pub fn syn(mut self) -> PacketBuilderStep<TcpHeader> {
self.state.transport_header.as_mut().unwrap().mut_tcp().unwrap().syn = true;
self
}
///Sets the rst flag (reset the connection)
pub fn rst(mut self) -> PacketBuilderStep<TcpHeader> {
self.state.transport_header.as_mut().unwrap().mut_tcp().unwrap().rst = true;
self
}
///Sets the psh flag (push function)
pub fn psh(mut self) -> PacketBuilderStep<TcpHeader> {
self.state.transport_header.as_mut().unwrap().mut_tcp().unwrap().psh = true;
self
}
///Sets the ack flag and the acknowledgment_number.
pub fn ack(mut self, acknowledgment_number: u32) -> PacketBuilderStep<TcpHeader> {
{
let header = self.state.transport_header.as_mut().unwrap().mut_tcp().unwrap();
header.ack = true;
header.acknowledgment_number = acknowledgment_number;
}
self
}
///Set the urg flag & the urgent pointer field.
///
///The urgent pointer points to the sequence number of the octet following
///the urgent data.
pub fn urg(mut self, urgent_pointer: u16) -> PacketBuilderStep<TcpHeader> {
{
let header = self.state.transport_header.as_mut().unwrap().mut_tcp().unwrap();
header.urg = true;
header.urgent_pointer = urgent_pointer;
}
self
}
///Sets ece flag (ECN-Echo, RFC 3168)
pub fn ece(mut self) -> PacketBuilderStep<TcpHeader> {
self.state.transport_header.as_mut().unwrap().mut_tcp().unwrap().ece = true;
self
}
///Set cwr flag (Congestion Window Reduced)
///
///This flag is set by the sending host to indicate that it received a TCP segment with the ECE flag set and had responded in congestion control mechanism (added to header by RFC 3168).
pub fn cwr(mut self) -> PacketBuilderStep<TcpHeader> {
self.state.transport_header.as_mut().unwrap().mut_tcp().unwrap().cwr = true;
self
}
///Set the tcp options of the header.
pub fn options(mut self, options: &[TcpOptionElement]) -> Result<PacketBuilderStep<TcpHeader>, TcpOptionWriteError> {
self.state.transport_header.as_mut().unwrap().mut_tcp().unwrap().set_options(options)?;
Ok(self)
}
///Set the tcp options of the header (setting the bytes directly).
pub fn options_raw(mut self, options: &[u8]) -> Result<PacketBuilderStep<TcpHeader>, TcpOptionWriteError> {
self.state.transport_header.as_mut().unwrap().mut_tcp().unwrap().set_options_raw(options)?;
Ok(self)
}
///Write all the headers and the payload.
pub fn write<T: io::Write + Sized>(self, writer: &mut T, payload: &[u8]) -> Result<(),WriteError> {
final_write(self, writer, payload)
}
///Returns the size of the packet when it is serialized
pub fn size(&self, payload_size: usize) -> usize {
final_size(self, payload_size)
}
}
///Write all the headers and the payload.
fn final_write<T: io::Write + Sized, B>(builder: PacketBuilderStep<B>, writer: &mut T, payload: &[u8]) -> Result<(),WriteError> {
let ip_ether_type = {
use crate::IpHeader::*;
match builder.state.ip_header {
Some(Version4(_,_)) => ether_type::IPV4,
Some(Version6(_,_)) => ether_type::IPV6,
None => panic!("Missing ip header")
}
};
//ethernetII header
if let Some(mut eth) = builder.state.ethernet2_header {
eth.ether_type = {
use crate::VlanHeader::*;
//determine the ether type depending on if there is a vlan tagging header
match builder.state.vlan_header {
Some(Single(_)) => ether_type::VLAN_TAGGED_FRAME,
Some(Double(_)) => ether_type::PROVIDER_BRIDGING,
//if no vlan header exists, the id is purely defined by the ip type
None => ip_ether_type
}
};
eth.write(writer)?;
}
//write the vlan header if it exists
use crate::VlanHeader::*;
match builder.state.vlan_header {
Some(Single(mut value)) => {
//set ether types
value.ether_type = ip_ether_type;
//serialize
value.write(writer)?;
},
Some(Double(mut value)) => {
//set ether types
value.outer.ether_type = ether_type::VLAN_TAGGED_FRAME;
value.inner.ether_type = ip_ether_type;
//serialize
value.write(writer)?;
},
None => {}
}
//ip header
use crate::IpHeader::*;
let ip_header = builder.state.ip_header.unwrap();
//transport header
let transport = builder.state.transport_header;
match transport {
None => {
// in case no transport header is present the protocol
// number and next_header fields are set in the write call
// directly and don't need to be set here again.
match ip_header {
Version4(mut ip, ext) => {
ip.set_payload_len(ext.header_len() + payload.len())?;
ip.write(writer)?;
ext.write(writer, ip.protocol)?;
},
Version6(mut ip, ext) => {
ip.set_payload_length(ext.header_len() + payload.len())?;
ip.write(writer)?;
ext.write(writer, ip.next_header)?;
}
}
},
Some(mut transport) => {
match ip_header {
Version4(mut ip, mut ext) => {
//set total length & udp payload length (ip checks that the payload length is ok)
let transport_size = transport.header_len() + payload.len();
ip.set_payload_len(ext.header_len() + transport_size)?;
use crate::TransportHeader::*;
match transport {
Icmpv4(_) => {},
Icmpv6(_) => {},
Udp(ref mut udp) => { udp.length = transport_size as u16; }
Tcp(_) => {},
}
//ip protocol number & next header values of the extension header
ip.protocol = ext.set_next_headers(
match transport {
Icmpv4(_) => ip_number::ICMP,
Icmpv6(_) => ip_number::IPV6_ICMP,
Udp(_) => ip_number::UDP,
Tcp(_) => ip_number::TCP
}
);
//calculate the udp checksum
transport.update_checksum_ipv4(&ip, payload)?;
//write (will automatically calculate the checksum)
ip.write(writer)?;
ext.write(writer, ip.protocol)?;
},
Version6(mut ip, mut ext) => {
//set total length
let transport_size = transport.header_len() + payload.len();
ip.set_payload_length(ext.header_len() + transport_size)?;
use crate::TransportHeader::*;
match transport {
Icmpv4(_) => {},
Icmpv6(_) => {},
Udp(ref mut udp) => { udp.length = transport_size as u16; }
Tcp(_) => {}
}
//set the protocol
ip.next_header = ext.set_next_headers(
match transport {
Icmpv4(_) => ip_number::ICMP,
Icmpv6(_) => ip_number::IPV6_ICMP,
Udp(_) => ip_number::UDP,
Tcp(_) => ip_number::TCP
}
);
//calculate the udp checksum
transport.update_checksum_ipv6(&ip, payload)?;
//write (will automatically calculate the checksum)
ip.write(writer)?;
ext.write(writer, ip.next_header)?;
}
}
//finaly write the udp header & payload
transport.write(writer)?;
},
}
writer.write_all(payload)?;
Ok(())
}
///Returns the size of the packet when it is serialized
fn final_size<B>(builder: &PacketBuilderStep<B>, payload_size: usize) -> usize {
use crate::IpHeader::*;
use crate::VlanHeader::*;
use crate::TransportHeader::*;
(match builder.state.ethernet2_header {
Some(_) => Ethernet2Header::SERIALIZED_SIZE,
None => 0
}) + match builder.state.vlan_header {
Some(Single(_)) => SingleVlanHeader::SERIALIZED_SIZE,
Some(Double(_)) => DoubleVlanHeader::SERIALIZED_SIZE,
None => 0
} + match builder.state.ip_header {
Some(Version4(ref value, ref ext)) => value.header_len() + ext.header_len(),
Some(Version6(_, ref ext)) => Ipv6Header::SERIALIZED_SIZE + ext.header_len(),
None => 0
} + match builder.state.transport_header {
Some(Icmpv4(ref value)) => value.header_len(),
Some(Icmpv6(ref value)) => value.header_len(),
Some(Udp(_)) => UdpHeader::SERIALIZED_SIZE,
Some(Tcp(ref value)) => value.header_len() as usize,
None => 0
} + payload_size
}
#[cfg(test)]
mod whitebox_tests {
use super::*;
//whitebox tests that need internal access
#[test]
fn size() {
assert_eq!(0,
PacketBuilderStep::<UdpHeader> {
state: PacketImpl {
ethernet2_header: None,
ip_header: None,
vlan_header: None,
transport_header: None
},
_marker: marker::PhantomData::<UdpHeader>{}
}.size(0));
}
#[test]
#[should_panic]
fn final_write_panic_missing_ip() {
let mut writer = Vec::new();
final_write(
PacketBuilderStep::<UdpHeader> {
state: PacketImpl {
ethernet2_header: None,
ip_header: None,
vlan_header: None,
transport_header: None
},
_marker: marker::PhantomData::<UdpHeader>{}
},
&mut writer,
&[]
).unwrap();
}
}