[Tracking Issue] transports/quic: Add QUIC Transport

[elenaf9]

Summary

Implement the QUIC transport for rust-libp2p.

Done criteria

• Quic can be used as a transport in the Swarm for communication between nodes that can directly reach each other
• TLS handshake is compliant with the libp2p/specs TLS Handshake and unit tested
• Transport is unit & integration tested
• Benchmarked with mxinden/libp2p-perf
• Tested again go-libp2p with Testground
• Public API is documented

Status Quo

Alpha implementation based on quinn crate. See #3454.

Previous attempts / History

• Implement QUIC #211
  • Initial Issue
• [WIP] Add libp2p-quic #563
  • First implementation using picoquic
  • Not using quinn because back then most quinn types were !Send
• [WIP] Add experimental QUIC support. #862
  • Continuation of [WIP] Add libp2p-quic #563
• QUIC support #1334
  • Use quinn-proto
  • Continuation in branch tomaka/quiccc-again
• Add libp2p-quic. #2144
  • Inspired by QUIC support #1334 but does not share code
  • Related repo: https://github.com/ipfs-rust/libp2p-quic
  • published on crates.io as libp2p-quic
  • Support noise in addition to tls
  • Closed because quic+noise not in libp2p specs
• Libp2p quic second attempt #2159
  • Continuation of Add libp2p-quic. #2144
  • Handles ecn codes and gso (throughput)
  • "Support for plugging in your own crypto"
• transports/quic: Add implementation based on quinn-proto #2289 [Most recent PR]
  • Initially a continuation of Libp2p quic second attempt #2159
  • Later code was replaced with old code from tomaka/quiccc-again branch
• Quic attempt 4 #2801 Alternative to transports/quic: Add implementation based on quinn-proto #2289
  • Uses quinn instead of quinn-proto

Tasks

• Finish transports/quic: Refactor Muxer and Connection  kpp/rust-libp2p#23 (replaces transports/quic: Adapt QuicMuxer to upstream StreamMuxer changes elenaf9/rust-libp2p#6)
• Finish remaining TODOs / FIXMEs in transports/quic: Add implementation based on quinn-proto #2289:
• Evaluate whether we should switch to use UdpSocket from quinn_udp instead of the rust std implementation
  • Will stick with the rust std ones for the first version.
• Review how backpressure is enforced throughout the whole implementation
  • If the application is too busy to read from an existing substream
  • If max inbound substreams is reached
  • If one connection is busy
• Enhance docs
• Enhance test
  • Enhance ping test in libp2p/test-plans for interop tests with Testground
  • More tests in general: backpressure, closing substreams, closing connections, limits, ..
• Add QUIC support to mxinden/libp2p-perf for benchmarks (mxinden/libp2p-perf is replaced by https://github.com/libp2p/test-plans/blob/master/perf/)
• quic: Add support for quic codepoint , interpreted as QUIC version draft-29 #3133

Long-term (not required for first implementation):

• Properly implement Transport::dial_as_listener to support hole-punching feat(quic): implement hole punching #3964
• Handle address change if a connection migrates
• Handle / use ECN bits (Happening now with the move to quinn refactor(quic): rewrite quic using quinn #3454)
• Fix local_address when processing an incoming UDP datagram for a new connection on a socket that is bound to a wildcard address.
• Similarly, select correct socket when listening on wildcard address fix(quic): improve listener socket selection when dialing #4259
• When first starting to listen, enable server-capabilities on existing client-only endpoint instead of creating a new one
• Evaluate alternatives to the quinn_proto quic implementation
  • quinn refactor(quic): rewrite quic using quinn #3454
  • s2n-quic (AWS)
  • quiche (Cloudflare)
• Refactor tls-config handling to support PeerId-validation on TLS level: Add muxer compliance test suite and refactor tests to not depend on libp2p-swarm kpp/rust-libp2p#27 (comment) Consider verifying expected PeerId as part of auth upgrades #2946

[mxinden]

Thanks for creating this @elenaf9!

Whenever you make a significant change to the original issue description, would you mind posting a comment like #2052 (comment)? That way, everyone subscribed to this issue gets a notification.

[elenaf9]

Changelog

Handle address change if a connection migrates

• Moved to Long-term. For now we can simply disable connection migration.

[elenaf9]

Changelog
QuicMuxer refactoring (elenaf9#6) was replaced and merged into #2289 with kpp#23:

• Updated the status-quo description
• Marked corresponding task as done.

[elenaf9]

Changelog

Evaluate whether we should switch to use UdpSocket from quinn_udp instead of the rust std implementation

• For the first implementation we will stick with UdpSocket from rust std. Integrating quinn_udp::UdpSocket requires additional complexity, and we don't strictly need it, especially if we plan on long-term switching to quinn.

Handle / use ECN bits

• Moved to Long-term since the UdpSocket from std does not support this.

Fix local_address when processing an UDP datagram for a new incoming connection on a socket that is bound to a wildcard address

• Moved to Long-term. To fix this, we need to obtain the destination-ip of the first udp packet on the connection, which we can not access through the normal UdpSocket API. quinn_udp supports it for linux only. Long-term we can contribute support for other platforms as well (related issue: Provide local and remote socket addresses from a Connecting quinn-rs/quinn#508). For now the local_address will have an unspecified IP in this case.

[marten-seemann]

Should Stateless Reset handling / generation be added to the Long Term list?

[elenaf9]

Changelog:

• Finish remaining TODOs / FIXMEs in Libp2p quic third attempt transports/quic: Add implementation based on quinn-proto #2289
• Enhance docs
• Review how backpressure is enforced throughout the whole implementation
  -> Described in the docs on [endpoint::Driver] in transports/quic: Add implementation based on quinn-proto #2289

[thomaseizinger]

Changelog:

Added link to kpp#27 (comment) so we don't forget to refactor the TLS-config handling.