tcp-engine

tcp-engine is a rust crate.

Licensing

The license for this project is AGPL3.

Security and Robustness Features Supported

Fixed size memory usage for transmission control blocks and related structures at start-up; no dynamic memory allocation per connection;
Urgent segments are not permitted;
Non-zero padding and urgent pointers are disallowed;
TCP known options are always length checked;
Push flag is always ignored;
Invalid flag combinations are blackholed;
Unusual but valid combinations are blackholed;
Fixed memory usage at start-up;
Alarm wheels of fixed size with fixed sized 'ticks' to prevent unbounded and unstable alarm growth (memory for alarms is statically allocated at start up);
SYN flooding defences are permanently on: there is no syncache;
MSS clamping
- Connections with a small MSS are refused (usually under 984 on IPv4 and 1220 on IPv6);
- Connections without a MSS option default to the Path MSS, rather than the TCP minimum;
ICMP and ICMPv6 messages are completely ignored to make attackers time harder:-
- There is no Path MTU discovery;
- Connection failures ignored;
Invalid packets are blackholed rather than resulting in resets;
Connection requests to dead ports are blackholed;
RFC 7323
- PAWS without fragmentation;
- Timestamps which are too old;
- Timestamp rollover;
- Random timestamp offsets;
Segments with an URG flag set or non-zero urgent pointer are considered attacks and blackholed;
RFC 5961: Challenge Acknowledgments for SYN, RST and data injection attacks;
No header prediction
Secure initial sequence number generation
MD5 authenticated segments when required, with different inbound and outbound keys;
- Connections requiring MD5 are dropped if segments are unauthenticated;
Incoming packet reuse to minimize memory overhead;
Hardware checksum support;
Zero-Window probe defences (we do not zero-window probe forever, but eventually drop the connection)
- TODO: Consider changing the zero-window probe logic to time-out after 5 seconds, as longer than this usually indicates a severe problem.
Duplicate TCP options are always rejected
Padding bytes are always validated to be zero (0x00)
Simultaneous Open, a TCP mis-feature, is not possible

Constraints

After 11 zero-window probes (ie we have sent 11 probes) have been sent in a row, we drop the connection without sending a reset;
After 11 retransmissions (ie we have sent 12 transmissions) have been sent of the same segment, we drop the connection without sending a reset;
Retransmissions and Zero-Window probes after the 8th are no-longer backed off
Retransmissions during the SYN_SENT state have a different back-off profile to the norm (but match FreeBSD).
Minimum retransmission time-out, and initial retransmission api.time-out is 128ms, not 1sec.
Maximum retransmission time-out is just over 65 seconds (512 x 128ms).
Zero-window probe times match retransmission time-outs.

Performance

A recent connections cache is used to record congestion-control data to make new connections more efficient, using the principle of "yesterday's weather".
A timer wheel is used to optimize alarms and timers
"magic" (also known as virtual) ring buffers are used to avoid memory copies.
- When using DPDK
  - Efficient use of these requires DPDK to use the IOVA mode (rte_iova_mode::RTE_IOVA_VA); this can only happen if the uio, igb_uio and kni kernel modules are NOT used as PCI drivers for network cards, and the vfio-pci driver is used instead.
  - This also has the benefit of letting DPDK use its 'dynamic' memory mode and avoid physical addresses (which effectively require root to be useful).

Limitations

The use of syncookies means that very large Ethernet Jumbo frames (those over 9000 bytes) are not effectively used for IPV6 TCP packets.
Likewise, the use of Ethernet frames over 1500 bytes are not effectively used for IPv4.
Experimental TCP options are often treated as duplicates as ExID parsing is not implemented.

Supported & Unsupported Standards

Supported RFCs (or, where informational, taken note of)

RFC 8311 Relaxing Restrictions on Explicit Congestion Notification (ECN) Experimentation
RFC 8087 The Benefits of Using Explicit Congestion Notification (ECN)
RFC 7805 Moving Outdated TCP Extensions and TCP-Related Documents to Historic or Informational Status
RFC 7605 (BCP 165) Recommendations on Using Assigned Transport Port Numbers
RFC 7414 A Roadmap for Transmission Control Protocol (TCP) Specification Documents
RFC 7323 TCP Extensions for High Performance
RFC 6928 Increasing TCP's Initial Window
RFC 6691 TCP Options and Maximum Segment Size (MSS)
RFC 6633 Deprecation of ICMP Source Quench Messages
RFC 6528 Defending against Sequence Number Attacks
RFC 6335 (BCP 165) Internet Assigned Numbers Authority (IANA) Procedures for the Management of the Service Name and Transport Protocol Port Number Registry
RFC 6298 Computing TCP's Retransmission Timer
RFC 6429 TCP Sender Clarification for Persist Condition
RFC 6247 Moving the Undeployed TCP Extensions RFC 1072, RFC 1106, RFC 1110, RFC 1145, RFC 1146, RFC 1379, RFC 1644, and RFC 1693 to Historic Status
RFC 6093 On the Implementation of the TCP Urgent Mechanism
RFC 6056 (BCP 156) Recommendations for Transport-Protocol Port Randomization
RFC 5961 Improving TCP's Robustness to Blind In-Window Attacks
RFC 5927 ICMP Attacks against TCP
RFC 5681 TCP Congestion Control
RFC 4987 TCP SYN Flooding Attacks and Common Mitigations
RFC 4821 Packetization Layer Path MTU Discovery
RFC 3465 TCP Congestion Control with Appropriate Byte Counting (ABC)
RFC 3449 (BCP 69) TCP Performance Implications of Network Path Asymmetry
RFC 3390 Increasing TCP's Initial Window
RFC 3360 Inappropriate TCP Resets Considered Harmful
RFC 3168 The Addition of Explicit Congestion Notification (ECN) to IP
RFC 2923 TCP Problems with Path MTU Discovery
RFC 2884 Performance Evaluation of Explicit Congestion Notification (ECN) in IP Networks
RFC 2873 TCP Processing of the IPv4 Precedence Field
RFC 2460 Internet Protocol, Version 6 (IPv6) Specification
RFC 2416 When TCP Starts Up With Four Packets Into Only Three Buffers
RFC 2415 Simulation Studies of Increased Initial TCP Window Size
RFC 2398 (FYI 33) Some Testing Tools for TCP Implementors
RFC 2385 Protection of BGP Sessions via the TCP MD5 Signature Option
- Obsoleted by RFC 5925 but still in widespread use
RFC 2151 (FYI 30) A Primer On Internet and TCP/IP Tools and Utilities
RFC 2140 TCP Control Block Interdependence
RFC 1936 Implementing the Internet Checksum in Hardware
RFC 1624 Computation of the Internet Checksum via Incremental Update
RFC 1470 (FYI 2) FYI on a Network Management Tool Catalog: Tools for Monitoring and Debugging TCP/IP Internets and Interconnected Devices
RFC 1263 TCP Extensions Considered Harmful
RFC 1141 (and as updated by RFC 1624)
RFC 1122 Requirements for Internet Hosts -- Communication Layers
RFC 1025 TCP and IP bake off
RFC 793 (STD 7) Transmission Control Protocol

Passively Supported RFCs

Implementation of these RFCs is limited to passive parsing and validation of options to make sure they are not being used as an attack vector.

RFC 6994 Shared Use of Experimental TCP Options[^No validation of `ExID`s is undertaken and duplicate `ExID`s are not detected]
RFC 5926 Cryptographic Algorithms for the TCP Authentication Option (TCP-AO)
RFC 5925 The TCP Authentication Option[^We also validate that the MD5 option is not present when the TCP authentication option is present, and vice versa]
RFC 5562 Adding Explicit Congestion Notification (ECN) Capability to TCP's SYN/ACK Packets
RFC 5482 TCP User Timeout Option[^This option can not be captured using syncookies and so can not be used]
- In addition, detection of a squatting option used by some CDNs is also supported and distringuished.
RFC 4782 Quick-Start for TCP and IP[^Recent discoveries have indicated that Quick-Start is vulnerable to attack]
RFC 4727 Experimental Values In IPv4, IPv6, ICMPv4, ICMPv6, UDP, and TCP Headers

Non-RFC Documents of Significant Merit

Processing Incoming Segments. This is a markdown document synthesizing many of the RFCs above in to a readable, and referencable, document. Many places in the code reference numbered sections in the generated PDF.
Laminar TCP Draft. Provides a robust explanation of the subtle meanings of the congestion control variables.
A Finite State Machine Model of TCP Connections in the Transport Layer", J. Treurniet and J. H. Lefebvre, 2003. Pages 5 & 6 document a revised state model which makes it clear that many segment flag variations aren't appropriate.

RFC Violations

ICMP messages are explicitly not supported. In the internet at large, they are often blocked, have been frequently used as attack vectors and are not essential to TCP operation. In practice, only ICMP messages relating to PathMTU discovery and host unreachability are of interest. However, both of these can be used to perform Denial-of-Service or 'Slow' attacks, to both servers and clients, and so we do not make use of them.

RFC 6298 Section 5.7: We choose to use 3 × 128 milliseconds rather than 3 seconds.
RFC 6298 Section 2.4: We choose a default minimum of 128 milliseconds rather than one second.
RFC 6298 Section 2.1: We use an initial minimum of 128 milliseconds OR the most recently cached value if available.
RFC 6298 Section 5 (5.5): We use a set of back off scalars which do not always cause doubling when retransmitting SYN segments.
RFC 6093: We blackhole any segments with an URG flag bit set.
RFC 5961 Section 3.2 Page 8: We do not send a 'Challenge ACK' when in the LISTEN or SYN-RECEIVED state, as to do so may reveal that a syncookie we sent as an initial challenge is invalid.
RFC 5961: We do not implement rate limiting of 'Challenge ACK's as this can be exploited as a side-channel.
RFC 4821: We take the advice given and additionally enforce a lowest advertised MSS option of 984 for IPv4 and 1220 for IPv6. In the absence of an MSS option, we force the default MSS to these values rather than 536.
RFC 3360 Section 2.1: We forcibly validate that the reserved field is zero. This seems to be consistent with RFC 4727 Section 7.2: "There are not enough reserved bits to allocate any for experimentation".
RFC 2675: IPv6 Jumbograms are not supported.
RFC 1122: We do not support ICMP messages.
RFC 793: URG and the urgent pointer are not appropriate in the modern internet and are considered threats.
RFC 793: We blackhole (ignore) any segments with the ACK flag bit set in the LISTEN or SYN-RECEIVED state as these have no legitimate purpose and normally indicate a scan according to pages 5 & 6 of A Finite State Machine Model of TCP Connections in the Transport Layer", J. Treurniet and J. H. Lefebvre, 2003.
RFC 793, Page 72: "If the segment acknowledgment is not acceptable, form a reset segment, <SEQ=SEG.ACK><CTL=RST>, and send it". This is violated becase to send a reset is to either reveal to a potential attacker we exist or to inadvertently abort an existing connection because of a spoofed packet.
RFC 792: We do not support ICMP messages.

To finish

RFC 5681 TCP Congestion Control
RTO timer scheduling
Passing up of payloads
Writing of payloads
When to invoke keep-alive and user time out / idle detection

TODO RFCs

SACKs

RFC 6675 A Conservative Loss Recovery Algorithm Based on Selective Acknowledgment (SACK) for TCP
RFC 2883 An Extension to the Selective Acknowledgement (SACK) Option for TCP
RFC 2018 TCP Selective Acknowledgment Options

Authentication

RFC 6978 A TCP Authentication Option Extension for NAT Traversal
- Simply involves whether to zero-out ports and addresses when calculating the HMAC.
RFC 5926 Cryptographic Algorithms for the TCP Authentication Option (TCP-AO)
RFC 5925 The TCP Authentication Option

Congestion Control

Google BBR
RFC 8257 Data Center TCP (DCTCP): TCP Congestion Control for Data Centers
RFC 6937 Proportional Rate Reduction for TCP
RFC 6582 The NewReno Modification to TCP's Fast Recovery Algorithm
RFC 5682 Forward RTO-Recovery (F-RTO): An Algorithm for Detecting Spurious Retransmission Timeouts with TCP
RFC 4138 Forward RTO-Recovery (F-RTO): An Algorithm for Detecting Spurious Retransmission Timeouts with TCP and the Stream Control Transmission Protocol (SCTP)
RFC 4015 The Eifel Response Algorithm for TCP
RFC 3522 The Eifel Detection Algorithm for TCP
RFC 3042 Enhancing TCP's Loss Recovery Using Limited Transmit

Other Developments

RFC 7413 TCP Fast Open
RFC 4821 Packetization Layer Path MTU Discovery
RFC 1337 TIME-WAIT Assassination Hazards in TCP

Statistics

RFC 4898 TCP Extended Statistics MIB
RFC 4022 Management Information Base for the Transmission Control Protocol (TCP)
RFC 1156 Management Information Base for network management of TCP/IP-based internets
RFC 1155 Structure and identification of management information for TCP/IP-based internets

Explicitly unsupported RFCs

ICMP

RFC 8201 Path MTU Discovery for IP version 6
RFC 1812 Requirements for IP Version 4 Routers
RFC 1191 Path MTU Discovery
RFC 844 Who talks ICMP, too? - Survey of 18 February 1983
RFC 792 (STD 5) Internet Control Message Protocol

Not Widely Supported

RFC 7974 An Experimental TCP Option for Host Identification
RFC 4828 TCP Friendly Rate Control (TFRC): The Small-Packet (SP) Variant
RFC 4654 TCP-Friendly Multicast Congestion Control (TFMCC): Protocol Specification
RFC 2675 IPv6 Jumbograms

Bad Ideas

RFC 1011 Official Internet protocols
- URG is explicitly unsupported

Multipath TCP

RFC 8041 Use Cases and Operational Experience with Multipath TCP
RFC 7430 Analysis of Residual Threats and Possible Fixes for Multipath TCP (MPTCP)
RFC 6897 Multipath TCP (MPTCP) Application Interface Considerations
RFC 6824 TCP Extensions for Multipath Operation with Multiple Addresses
RFC 6356 Coupled Congestion Control for Multipath Transport Protocols
RFC 6182 Architectural Guidelines for Multipath TCP Development
RFC 6181 Threat Analysis for TCP Extensions for Multipath Operation with Multiple Addresses

Obsolete, Historic, Made Informational or April Fool's

RFC 6013 (obsoleted by supported RFC 7805)
RFC 5841 (April Fool's Day RFC)
RFC 4614 (obsoleted by RFC 7414)
RFC 3782 (obsoleted by supported RFC 6582)
RFC 3540 (made historic by supported RFC 8311)
RFC 3517 (obsoleted by RFC 6675)
RFC 3448 (obsoleted by RFC 5348)
RFC 2861 (obsoleted by RFC 7661)
RFC 2582 (obsoleted by obsoleted RFC 3782)
RFC 2581 (obsoleted by supported RFC 5681)
RFC 2481 (obsoleted by supported RFC 3168)
RFC 2452 (obsoleted by RFC 4022 and RFC 8096)
RFC 2414 (obsoleted by RFC 3390)
RFC 2147 (obsoleted by supported RFC 2675)
RFC 2012 (obsoleted by RFC 4022)
RFC 2001 (obsoleted by obsoleted RFC 2581)
RFC 1981 (obsoleted by unsupported RFC 8201)
RFC 1948 (obsoleted by supported RFC 6528)
RFC 1739 (obsoleted by supported RFC 2151)
RFC 1716 (obsoleted by explicitly unsupported RFC 1812)
RFC 1693 (obsoleted by supported RFC 6247)
RFC 1644 (obsoleted by supported RFC 6247)
RFC 1379 (obsoleted by supported RFC 6247)
RFC 1347 (historic predecessor to IPv6)
RFC 1323 (obsoleted by supported RFC 7323)
RFC 1185 (obsoleted by obsoleted RFC 1323)
RFC 1158 (obsoleted by RFC 1213)
RFC 1147 (obsoleted by RFC 1470)
RFC 1146 (obsoleted by supported RFC 6247)
RFC 1145 (obsoleted by supported RFC 6247)
RFC 1110 (obsoleted by supported RFC 6247)
RFC 1106 (obsoleted by supported RFC 6247)
RFC 1095 (obsoleted by RFC 1189)
RFC 1078 (obsoleted by supported RFC 7805)
RFC 1072 (obsoleted by supported RFC 6247)
RFC 1071 (obsoleted by supported RFC 1141)
RFC 1066 (obsoleted by RFC 1156)
RFC 1065 (obsoleted by RFC 1155)
RFC 1009 (obsoleted by explicitly unsupported RFC 1812)
RFC 991 (obsoleted by unsupported RFC 1011)
RFC 964 (made informational by supported RFC 7805)
RFC 962 (effectively historic)
RFC 896 (obsoleted by supported RFC 7805)
RFC 889 (made informational by supported RFC 7805)
RFC 879 (obsoleted by supported RFC 7805)
RFC 872 (made informational by supported RFC 7805)
RFC 848 (effectively historic)
RFC 847 (effectively historic)
RFC 846 (obsoleted by obsoleted RFC 847)
RFC 845 (obsoleted by obsoleted RFC 846)
RFC 843 (obsoleted by obsoleted RFC 845)
RFC 842 (obsoleted by obsoleted RFC 843)
RFC 839 (obsoleted by obsoleted RFC 842)
RFC 838 (obsoleted by obsoleted RFC 839)
RFC 837 (obsoleted by obsoleted RFC 838)
RFC 836 (obsoleted by obsoleted RFC 837)
RFC 835 (obsoleted by obsoleted RFC 836)
RFC 834 (obsoleted by obsoleted RFC 835)
RFC 833 (obsoleted by obsoleted RFC 834)
RFC 832 (obsoleted by obsoleted RFC 833)
RFC 817 (made informational by supported RFC 7805)
RFC 816 (obsoleted by supported RFC 7805)
RFC 814 (made informational by supported RFC 7805)
RFC 813 (obsoleted by supported RFC 7805)
RFC 794 (made informational by supported RFC 7805)
RFC 761 (obsoleted by supported RFC 7805)
RFC 721 (obsoleted by supported RFC 7805)
RFC 700 (made informational by supported RFC 7805)
RFC 675 (obsoleted by supported RFC 7805)

RFCs to explore

RFC 7661 (Updating TCP to Support Rate-Limited Traffic)

RFC 7242 Delay-Tolerant Networking TCP Convergence-Layer Protocol

RFC 6544 TCP Candidates with Interactive Connectivity Establishment (ICE)

BCP 159 RFC 6191 Reducing the TIME-WAIT State Using TCP Timestamps.

RFC 6069 Making TCP More Robust to Long Connectivity Disruptions (TCP-LCD)

RFC 6062 Traversal Using Relays around NAT (TURN) Extensions for TCP Allocations

RFC 5461 TCP's Reaction to Soft Errors Uses ICMP so probably should document

BCP 142 RFC 5382 (BCP 142) NAT Behavioral Requirements for TCP (updated by RFC 7857)

RFC 4953 Defending TCP Against Spoofing Attacks RFC 3128 Protection Against a Variant of the Tiny Fragment Attack (RFC 1858) RFC 1858 Security Considerations for IP Fragment Filtering

RFC 4808 Key Change Strategies for TCP-MD5 RFC 4278 Standards Maturity Variance Regarding the TCP MD5 Signature Option (RFC 2385) and the BGP-4 Specification RFC 3562 Key Management Considerations for the TCP MD5 Signature Option

RFC 7786 TCP Modifications for Congestion Exposure (ConEx) RFC 5690 Adding Acknowledgement Congestion Control to TCP RFC 5827 Early Retransmit for TCP and Stream Control Transmission Protocol (SCTP) RFC 5348 TCP Friendly Rate Control (TFRC): Protocol Specification RFC 4653 Improving the Robustness of TCP to Non-Congestion Events RFC 3742 Limited Slow-Start for TCP with Large Congestion Windows RFC 3708 Using TCP Duplicate Selective Acknowledgement (DSACKs) ... to Detect Spurious Retransmissions RFC 3649 HighSpeed TCP for Large Congestion Windows RFC 6349 Framework for TCP Throughput Testing (useful information).

RFC 6675 A Conservative Loss Recovery Algorithm Based on Selective Acknowledgment (SACK) for TCP
- Obsoletes RFC 3517

RFC 2760 Ongoing TCP Research Related to Satellites RFC 2488 (BCP 28) Enhancing TCP Over Satellite Channels using Standard Mechanisms RFC 2757 Long Thin Networks

RFC 2525 Known TCP Implementation Problems RFC 1180 TCP/IP tutorial

lemonrock/tcp-engine