ooni-probe-cli/internal/tutorial/netxlite
DecFox 5d2afaade4
cli: upgrade to lucas-clemente/quic-go@v0.27.0 (#715)
* quic-go upgrade: replaced Session/EarlySession with Connection/EarlyConnection

* quic-go upgrade: added context to RoundTripper.Dial

* quic-go upgrade: made corresponding changes to tutorial

* quic-go upgrade: changed sess variable instances to qconn

* quic-go upgrade: made corresponding changes to tutorial

* cleanup: remove unnecessary comments

Those comments made sense in terms of illustrating the changes
but they're going to be less useful once we merge.

* fix(go.mod): apparently we needed `go1.18.1 mod tidy`

VSCode just warned me about this. It seems fine to apply this
change as part of the pull request at hand.

* cleanup(netxlite): http3dialer can be removed

We used to use http3dialer to glue a QUIC dialer, which had a
context as its first argument, to the Dial function used by the
HTTP3 transport, which did not have a context as its first
argument.

Now that HTTP3 transport has a Dial function taking a context as
its first argument, we don't need http3dialer
anymore, since we can use the QUIC dialer directly.

Cc: @DecFox

* Revert "cleanup(netxlite): http3dialer can be removed"

This reverts commit c62244c620cee5fadcc2ca89d8228c8db0b96add
to investigate the build failure mentioned at
https://github.com/ooni/probe-cli/pull/715#issuecomment-1119450484

* chore(netx): show that test was already broken

We didn't see the breakage before because we were not using
the created transport, but the issue of using a nil dialer was
already present before, we just didn't see it.

Now we understand why removing the http3transport in
c62244c620cee5fadcc2ca89d8228c8db0b96add did cause the
breakage mentioned at
https://github.com/ooni/probe-cli/pull/715#issuecomment-1119450484

* fix(netx): convert broken integration test to working unit test

There's no point in using the network here. Add a fake dialer that
breaks and ensure we're getting the expected error.

We've now improved upon the original test because the original test was
not doing anything while now we're testing whether we get back a QUIC
dialer that _can be used_.

After this commit, I can then readd the cleanup commit
c62244c620cee5fadcc2ca89d8228c8db0b96add and it won't be
broken anymore (at least, this is what I expected to happen).

* Revert "Revert "cleanup(netxlite): http3dialer can be removed""

This reverts commit 0e254bfc6ba3bfd65365ce3d8de2c8ec51b925ff
because now we should have fixed the broken test.

Co-authored-by: decfox <decfox>
Co-authored-by: Simone Basso <bassosimone@gmail.com>
2022-05-06 12:24:03 +02:00
..
chapter01 doc: add tutorial on how to use netxlite (#519) 2021-09-28 18:15:38 +02:00
chapter02 doc: add tutorial on how to use netxlite (#519) 2021-09-28 18:15:38 +02:00
chapter03 doc: add tutorial on how to use netxlite (#519) 2021-09-28 18:15:38 +02:00
chapter04 cli: upgrade to lucas-clemente/quic-go@v0.27.0 (#715) 2022-05-06 12:24:03 +02:00
chapter05 doc: add tutorial on how to use netxlite (#519) 2021-09-28 18:15:38 +02:00
chapter06 doc: add tutorial on how to use netxlite (#519) 2021-09-28 18:15:38 +02:00
chapter07 doc: add tutorial on how to use netxlite (#519) 2021-09-28 18:15:38 +02:00
chapter08 cli: upgrade to lucas-clemente/quic-go@v0.27.0 (#715) 2022-05-06 12:24:03 +02:00
README.md doc(netxlite): revamp the documentation (#523) 2021-09-29 20:21:25 +02:00

Tutorial: using the netxlite networking library

Netxlite is the underlying networking library we use in OONI. In most cases, network experiments do not use netxlite directly, rather they use abstractions built on top of netxlite (e.g., measurex). Though, you need to know about netxlite if you need to modify these abstractions.

For this reason, this chapter shows the basic netxlite primitives that we use when writing higher-level measurement primitives.

We will start from simple primitives and we will combine them together to reach to the point where we can perform GET requests to websites using already existing TLS or QUIC connections. (The code we will end up writing will look like a stripped down version of the measurex library, for which there is a separate tutorial.)

Index:

  • chapter01 shows how to establish TCP connections;

  • chapter02 covers TLS handshakes;

  • chapter03 discusses TLS parroting;

  • chapter04 shows how to establish QUIC sessions;

  • chapter05 is about the "system" DNS resolver;

  • chapter06 discusses custom DNS-over-UDP resolvers;

  • chapter07 shows how to perform an HTTP GET using an already existing TLS connection to a website;

  • chapter08 is like chapter07 but for QUIC.