microsoft / quicreach

A 'ping' equivalent tool for QUIC.

quicreach

This project has two primary purposes:

1. It provides a complete (C++) client sample application built on top of MsQuic.
2. It is a tool to test the QUIC reachability of a server (latest raw data).

Build

git clone --recursive https://github.com/microsoft/quicreach
cd quicreach && mkdir build && cd build

Linux

cmake -G 'Unix Makefiles' ..
cmake --build .

Windows

cmake -G 'Visual Studio 17 2022' -A x64 ..
cmake --build .

Usage

> quicreach google.com
Success

> quicreach example.com
Failure

> quicreach '*' --stats
                        SERVER          RTT       TIME_I       TIME_H              SEND:RECV    C1     S1    VER                     IP
                    google.com     2.409 ms     2.936 ms     5.461 ms   3:7 2520:8370 (3.3x)   287   6901     v1     172.253.62.102:443   *
                  facebook.com     1.845 ms     4.250 ms     4.722 ms   1:4 1260:4512 (3.6x)   289   3245     v1        31.13.66.35:443   !
                   youtube.com     2.702 ms     3.020 ms     6.491 ms   3:7 2520:8361 (3.3x)   288   6893     v1     142.251.163.93:443   *
                   twitter.com
                 instagram.com     0.944 ms     3.259 ms     3.717 ms   1:4 1260:4464 (3.5x)   290   3197     v1       31.13.66.174:443   !

Full Help

> quicreach --help
usage: quicreach <hostname(s)> [options...]
 -a, --alpn <alpn>      The ALPN to use for the handshake (def=h3)
 -b, --built-in-val     Use built-in TLS validation logic
 -c, --csv <file>       Writes CSV results to the given file
 -h, --help             Prints this help text
 -i, --ip <address>     The IP address to use
 -l, --parallel <num>   The numer of parallel hosts to test at once (def=1)
 -m, --mtu <mtu>        The initial (IPv6) MTU to use (def=1288)
 -p, --port <port>      The UDP port to use (def=443)
 -r, --req-all          Require all hostnames to succeed
 -s, --stats            Print connection statistics
 -u, --unsecure         Allows unsecure connections
 -v, --version          Prints out the version

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

quicreach's Issues

Onboard Windows Schannel Reachability Run to GH Action

Currently, we only run Linux w/ OpenSSL when we test reachability. It'd be interesting to see if there is a difference when using Windows w/ Schannel.

msh3reach in addition to quicreach

I can also do this outside of the repo but I can also add this into the repro if you are interested. It fits kind of loosely to the scope of the repo.

Basically quicreach since it only does the QUIC handshake doesnt know if the server actually advertises quic. This means that if you are hooked into a CDN provider you might have quic enabled on your IP pool but dont advertise it.

So concretely the recommendation here would be to use https://github.com/nibanks/msh3 and try out all the domains that can do the QUIC handshake and inspect the alt-svc header to see if they advertise h3.

Add More Graphs to Dashboard

Update index.html and chart.js to improve the current graphs on the dashboard:

• Stacked line graph of the breakdown of reachable vs unreachable endpoints
• Stacked line graph of the breakdown of reachable endpoints { Normal, TooMuch, MultiRtt }
• Stacked line graph of the breakdown of reachable endpoints { v1, v2 }

Add Parallel Support

Right now, when processing more than URL all requests happen in series. Now that we're adding a ton more URLs to the well-known list, it's going to take a long time to go through them all. To speed things up we should add support for a --parallel <n> option that will do up to n handshakes in parallel. Using a small number, such as 10 should significantly speed up the final result with minimal negative impact.

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

Support Version Option

We should add support for specifying a specific QUIC version number to use when connecting, since MsQuic supports version 2 and version negotiation. In conjunction, we should add support for printing out the resulting version when --stats is specified.

Update Top Domains List

The current list is a few years out of date. It'd be great if we could update to something more recent.

Daily Reachability Dashboard

We should save the results from the reach pipeline into a special branch and produce a dashboard of the results for easy viewing.