ooni-probe-cli/internal/engine/netx
Simone Basso 99b28c1d95
refactor: start building an Android package (#205)
* refactor: start building an Android package

Part of https://github.com/ooni/probe/issues/1335.

This seems also a good moment to move some packages out of the
engine, e.g., oonimkall. This package, for example, is a consumer
of the engine, so it makes sense it's not _inside_ it.

* fix: committed some stuff I didn't need to commit

* fix: oonimkall needs to be public to build

The side effect is that we will probably need to bump the major
version number every time we change one of these APIs.

(We can also of course choose to violate the basic guidelines of Go
software, but I believe this is bad form.)

I have no problem in bumping the major quite frequently and in
any case this monorepo solution is convinving me more than continuing
to keep a split between engine and cli. The need to embed assets to
make the probe more reliable trumps the negative effects of having to
~frequently bump major because we expose a public API.

* fix: let's not forget about libooniffi

Honestly, I don't know what to do with this library. I added it
to provide a drop in replacement for MK but I have no idea whether
it's used and useful. I would not feel comfortable exposing it,
unlike oonimkall, since we're not using it.

It may be that the right thing to do here is just to delete the
package and reduce the amount of code we're maintaining?

* woops, we're still missing the publish android script

* fix(publish-android.bash): add proper API key

* ouch fix another place where the name changed
2021-02-03 10:51:14 +01:00
..
archival chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
bytecounter chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
dialer chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
errorx chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
gocertifi chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
httptransport chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
quicdialer chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
resolver refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
selfcensor chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
trace chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
fake_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
integration_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
netx_internal_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
netx_test.go chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00
netx.go refactor: start building an Android package (#205) 2021-02-03 10:51:14 +01:00
README.md chore: merge probe-engine into probe-cli (#201) 2021-02-02 12:05:47 +01:00

Package github.com/ooni/probe-engine/netx

OONI extensions to the net and net/http packages. This code is used by ooni/probe-engine as a low level library to collect network, DNS, and HTTP events occurring during OONI measurements.

This library contains replacements for commonly used standard library interfaces that facilitate seamless network measurements. By using such replacements, as opposed to standard library interfaces, we can:

  • save the timing of HTTP events (e.g. received response headers)
  • save the timing and result of every Connect, Read, Write, Close operation
  • save the timing and result of the TLS handshake (including certificates)

By default, this library uses the system resolver. In addition, it is possible to configure alternative DNS transports and remote servers. We support DNS over UDP, DNS over TCP, DNS over TLS (DoT), and DNS over HTTPS (DoH). When using an alternative transport, we are also able to intercept and save DNS messages, as well as any other interaction with the remote server (e.g., the result of the TLS handshake for DoT and DoH).

This package is a fork of github.com/ooni/netx.