probe-engine

module
v0.17.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 30, 2020 License: BSD-3-Clause

README

OONI probe measurement engine

GoDoc Golang Status Coverage Status Go Report Card

This repository contains OONI probe's measurement engine. That is, the piece of software that implements OONI nettests as well as all the required functionality to run such nettests.

We expect you to use the Go version indicated in go.mod.

Integrating ooni/probe-engine

We recommend pinning to a specific version of probe-engine:

go get -v github.com/ooni/probe-engine@VERSION

See also the workflows/using.yml test where we check that the latest commit can be imported by a third party.

We do not provide any API stability guarantee.

Building miniooni

miniooni is a small command line client used for research and quality assurance testing. Build using:

go build -v ./cmd/miniooni/

We don't provide any miniooni command line flags stability guarantee.

See

./miniooni --help

for more help.

Building Android bindings

./build-android.bash

We automatically build Android bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

implementation "org.ooni:oonimkall:VERSION"

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

Building iOS bindings

./build-ios.bash

We automatically build iOS bindings whenever commits are pushed to the mobile-staging branch. Such builds could be integrated by using:

pod 'oonimkall', :podspec => 'https://dl.bintray.com/ooni/ios/oonimkall-VERSION.podspec'

Where VERSION is like 2020.03.30-231914 corresponding to the time when the build occurred.

Updating dependencies

  1. update direct dependencies using:
for name in `grep -v indirect go.mod | awk '/^\t/{print $1}'`; do \
  go get -u -v $name;                                             \
done
  1. pin to a specific psiphon version (we usually track the staging-client branch) using:
go get -v github.com/Psiphon-Labs/psiphon-tunnel-core@COMMITHASH

  1. clone psiphon-tunnel-core, checkout the tip of the staging-client branch and generate a go.mod by running go mod init && go mod tidy in the toplevel dir

  2. rewrite go.mod such that it contains only your direct dependencies followed by the exact content of psiphon-tunnel-core's go.mod

  3. run go mod tidy

  4. make sure you don't downgrade bolt and goselect because this will break downstream builds on MIPS:

go get -u -v github.com/Psiphon-Labs/bolt github.com/creack/goselect

The above procedure allows us to pin all psiphon dependencies precisely.

Directories

Path Synopsis
Package atomicx contains atomic int64/float64 that work also on 32 bit platforms.
 Package atomicx contains atomic int64/float64 that work also on 32 bit platforms.
cmd
jafar command
Jafar is a censorship simulation tool used for testing OONI.
 Jafar is a censorship simulation tool used for testing OONI.
jafar/badproxy
Package badproxy implements misbehaving proxies.
 Package badproxy implements misbehaving proxies.
jafar/flagx
Package flagx contains extensions for the standard library flag package.
 Package flagx contains extensions for the standard library flag package.
jafar/httpproxy
Package httpproxy contains a censoring HTTP proxy.
 Package httpproxy contains a censoring HTTP proxy.
jafar/iptables
Package iptables contains code for managing firewall rules.
 Package iptables contains code for managing firewall rules.
jafar/resolver
Package resolver contains a censoring DNS resolver.
 Package resolver contains a censoring DNS resolver.
jafar/shellx
Package shellx contains utilities to run external commands.
 Package shellx contains utilities to run external commands.
jafar/tlsproxy
Package tlsproxy contains a censoring TLS proxy.
 Package tlsproxy contains a censoring TLS proxy.
jafar/uncensored
Package uncensored contains code used by Jafar to evade its own censorship efforts by taking alternate routes.
 Package uncensored contains code used by Jafar to evade its own censorship efforts by taking alternate routes.
miniooni command
Command miniooni is a simple binary for research and QA purposes with a CLI interface similar to MK and OONI Probe v2.x.
 Command miniooni is a simple binary for research and QA purposes with a CLI interface similar to MK and OONI Probe v2.x.
experiment
dash
Package dash implements the DASH network experiment.
 Package dash implements the DASH network experiment.
example
Package example contains a simple example experiment.
 Package example contains a simple example experiment.
fbmessenger
Package fbmessenger contains the Facebook Messenger network experiment.
 Package fbmessenger contains the Facebook Messenger network experiment.
hhfm
Package hhfm contains the HTTP Header Field Manipulation network experiment.
 Package hhfm contains the HTTP Header Field Manipulation network experiment.
hirl
Package hirl contains the HTTP Invalid Request Line network experiment.
 Package hirl contains the HTTP Invalid Request Line network experiment.
ndt7
Package ndt7 contains the ndt7 network experiment.
 Package ndt7 contains the ndt7 network experiment.
psiphon
Package psiphon implements the psiphon network experiment.
 Package psiphon implements the psiphon network experiment.
sniblocking
Package sniblocking contains the SNI blocking network experiment.
 Package sniblocking contains the SNI blocking network experiment.
stunreachability
Package stunreachability contains the STUN reachability experiment.
 Package stunreachability contains the STUN reachability experiment.
telegram
Package telegram contains the Telegram network experiment.
 Package telegram contains the Telegram network experiment.
tor
Package tor contains the tor experiment.
 Package tor contains the tor experiment.
urlgetter
Package urlgetter implements a nettest that fetches a URL.
 Package urlgetter implements a nettest that fetches a URL.
webconnectivity
Package webconnectivity implements OONI's Web Connectivity experiment.
 Package webconnectivity implements OONI's Web Connectivity experiment.
webconnectivity/internal
Package internal contains internal code.
 Package internal contains internal code.
whatsapp
Package whatsapp contains the WhatsApp network experiment.
 Package whatsapp contains the WhatsApp network experiment.
Package geolocate implements IP lookup, resolver lookup, and GeoIP location an OONI Probe instance.
 Package geolocate implements IP lookup, resolver lookup, and GeoIP location an OONI Probe instance.
internal
httpfailure
Package httpfailure groups a bunch of extra HTTP failures.
 Package httpfailure groups a bunch of extra HTTP failures.
httpheader
Package httpheader contains code to set common HTTP headers.
 Package httpheader contains code to set common HTTP headers.
httpx
Package httpx contains http extensions.
 Package httpx contains http extensions.
humanizex
Package humanizex is like dustin/go-humanize
 Package humanizex is like dustin/go-humanize
kvstore
Package kvstore contains key-value stores
 Package kvstore contains key-value stores
mlablocate
Package mlablocate contains a locate.measurementlab.net client.
 Package mlablocate contains a locate.measurementlab.net client.
mlablocatev2
Package mlablocatev2 use m-lab locate services API v2.
 Package mlablocatev2 use m-lab locate services API v2.
mockable
Package mockable contains mockable objects
 Package mockable contains mockable objects
platform
Package platform returns the platform name.
 Package platform returns the platform name.
psiphonx
Package psiphonx is a wrapper around the psiphon-tunnel-core.
 Package psiphonx is a wrapper around the psiphon-tunnel-core.
randx
Package randx contains math/rand extensions
 Package randx contains math/rand extensions
runtimex
Package runtimex contains runtime extensions.
 Package runtimex contains runtime extensions.
sessionresolver
Package sessionresolver contains the resolver used by the session.
 Package sessionresolver contains the resolver used by the session.
sessiontunnel
tlsx
Package tlsx contains TLS extensions
 Package tlsx contains TLS extensions
torx
Package torx contains code to control tor.
 Package torx contains code to control tor.
legacy
netx
Package netx contains OONI's net extensions.
 Package netx contains OONI's net extensions.
netx/connid
Package connid contains code to generate the connectionID
 Package connid contains code to generate the connectionID
netx/dialid
netx/handlers
Package handlers contains default modelx.Handler handlers.
 Package handlers contains default modelx.Handler handlers.
netx/modelx
Package modelx contains the data modelx.
 Package modelx contains the data modelx.
netx/oldhttptransport
Package oldhttptransport contains HTTP transport extensions.
 Package oldhttptransport contains HTTP transport extensions.
netx/transactionid
Package transactionid contains code to share the transactionID
 Package transactionid contains code to share the transactionID
netxlogger
Package netxlogger is a logger for netx events.
 Package netxlogger is a logger for netx events.
oonidatamodel
Package oonidatamodel contains the OONI data model.
 Package oonidatamodel contains the OONI data model.
oonitemplates
Package oonitemplates contains templates for experiments.
 Package oonitemplates contains templates for experiments.
Package libminiooni implements the cmd/miniooni CLI.
 Package libminiooni implements the cmd/miniooni CLI.
Package model defines shared data structures and interfaces.
 Package model defines shared data structures and interfaces.
Package netx contains code to perform network measurements.
 Package netx contains code to perform network measurements.
archival
Package archival contains data formats used for archival.
 Package archival contains data formats used for archival.
bytecounter
dialer
errorx
Package errorx contains error extensions
 Package errorx contains error extensions
gocertifi
httptransport
Package httptransport contains HTTP transport extensions.
 Package httptransport contains HTTP transport extensions.
resolver
selfcensor
Package selfcensor contains code that triggers censorship.
 Package selfcensor contains code that triggers censorship.
trace
Package oonimkall implements APIs used by OONI mobile apps.
 Package oonimkall implements APIs used by OONI mobile apps.
tasks
Package tasks implements tasks run using the oonimkall API.
 Package tasks implements tasks run using the oonimkall API.
Package probeservices contains code to contact OONI probe services.
 Package probeservices contains code to contact OONI probe services.
testorchestra
Package testorchestra helps with testing the OONI orchestra API.
 Package testorchestra helps with testing the OONI orchestra API.
Package resources contains code to download resources.
 Package resources contains code to download resources.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.