ooni-probe-cli/internal/tutorial/netxlite/README.md
Simone Basso 8a0c062844
feat: clearly indicate which resolver we're using (#885)
See what we documented at https://github.com/ooni/spec/pull/257

Reference issue: https://github.com/ooni/probe/issues/2238

See also the related ooni/spec PR: https://github.com/ooni/spec/pull/257

See also https://github.com/ooni/probe/issues/2237

While there, bump webconnectivity@v0.5 version because this change
has an impact onto the generated data format.

The drop in coverage is unavoidable because we've written some
tests for `measurex` to ensure we deal with DNS resolvers and transport
names correctly depending on the splitting policy we use.

(However, `measurex` is only used for the `tor` experiment and, per
the step-by-step design document, new experiments should use
`measurexlite` instead, so this is hopefully fine(TM).)

While there, fix a broken integration test that does not run in `-short` mode.
2022-08-27 15:47:48 +02:00

1.3 KiB

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 "stdlib" 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.