README
¶
OONI Probe Client Library and CLI
The next generation OONI Probe: client library and Command Line Interface.
User setup
Please, follow the instructions at ooni.org/install/cli
to install ooniprobe. If we do not support your use case, please let us know.
Once ooniprobe is installed, try ooniprobe help to get interactive help.
Reporting issues
Please, report issues with this codebase at github.com/ooni/probe.
Please, make sure you tag such issues using the ooni/probe-cli label.
Repository organization
Every top-level directory contains an explanatory README file.
Development setup
Be sure you have golang >= 1.16 and a C compiler (when developing for Windows, you need Mingw-w64 installed). You can build using:
go build -v ./cmd/ooniprobe
This will generate a binary called ooniprobe in the current directory.
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.
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
go get -u -v ./... && go mod tidy
Releasing
Create an issue according to the routine release template and perform any item inside the check-list.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
atomicx
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. |
|
fsx
Package fsx contains file system extension
|
Package fsx contains file system extension |
|
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. |
|
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 |
|
multierror
Package multierror contains code to manage multiple errors.
|
Package multierror contains code to manage multiple errors. |
|
ooapi
Package ooapi contains a client for the OONI API.
|
Package ooapi contains a client for the OONI API. |
|
ooapi/apimodel
Package apimodel describes the data types used by OONI's API.
|
Package apimodel describes the data types used by OONI's API. |
|
ooapi/internal/generator
Command generator generates code in the ooapi package.
|
Command generator generates code in the ooapi package. |
|
ooapi/internal/openapi
Package openapi contains data structures for Swagger v2.0.
|
Package openapi contains data structures for Swagger v2.0. |
|
platform
Package platform returns the platform name.
|
Package platform returns the platform name. |
|
randx
Package randx contains math/rand extensions
|
Package randx contains math/rand extensions |
|
runtimex
Package runtimex contains runtime extensions.
|
Package runtimex contains runtime extensions. |
|
shellx
Package shellx contains utilities to run external commands.
|
Package shellx contains utilities to run external commands. |
|
tlsx
Package tlsx contains TLS extensions
|
Package tlsx contains TLS extensions |
|
tunnel
Package tunnel allows to create tunnels to speak with OONI backends and other services.
|
Package tunnel allows to create tunnels to speak with OONI backends and other services. |
|
v3
|
|
|
cmd/ooniprobe/internal/autorun
Package autorun contains code to manage automatic runs
|
Package autorun contains code to manage automatic runs |
|
cmd/ooniprobe/internal/enginex
Package enginex contains ooni/probe-engine extensions.
|
Package enginex contains ooni/probe-engine extensions. |
|
cmd/ooniprobe/internal/log/handlers/cli/progress
Package progress provides a simple terminal progress bar.
|
Package progress provides a simple terminal progress bar. |
|
cmd/ooniprobe/internal/log/handlers/syslog
Package syslog contains a syslog handler.
|
Package syslog contains a syslog handler. |
|
cmd/ooniprobe/internal/oonitest
Package oonitest contains code used for testing.
|
Package oonitest contains code used for testing. |
|
internal/cmd/apitool
Command apitool is a simple tool to fetch individual OONI measurements.
|
Command apitool is a simple tool to fetch individual OONI measurements. |
|
internal/cmd/getresources
Command getresources downloads the resources
|
Command getresources downloads the resources |
|
internal/cmd/jafar
Jafar is a censorship simulation tool used for testing OONI.
|
Jafar is a censorship simulation tool used for testing OONI. |
|
internal/cmd/jafar/badproxy
Package badproxy implements misbehaving proxies.
|
Package badproxy implements misbehaving proxies. |
|
internal/cmd/jafar/flagx
Package flagx contains extensions for the standard library flag package.
|
Package flagx contains extensions for the standard library flag package. |
|
internal/cmd/jafar/httpproxy
Package httpproxy contains a censoring HTTP proxy.
|
Package httpproxy contains a censoring HTTP proxy. |
|
internal/cmd/jafar/iptables
Package iptables contains code for managing firewall rules.
|
Package iptables contains code for managing firewall rules. |
|
internal/cmd/jafar/resolver
Package resolver contains a censoring DNS resolver.
|
Package resolver contains a censoring DNS resolver. |
|
internal/cmd/jafar/tlsproxy
Package tlsproxy contains a censoring TLS proxy.
|
Package tlsproxy contains a censoring TLS proxy. |
|
internal/cmd/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. |
|
internal/cmd/miniooni
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. |
|
internal/cmd/oohelper
Command oohelper contains a simple command line client for the Web Connectivity test helper.
|
Command oohelper contains a simple command line client for the Web Connectivity test helper. |
|
internal/cmd/oohelperd
Command oohelperd contains the Web Connectivity test helper.
|
Command oohelperd contains the Web Connectivity test helper. |
|
internal/engine
Package engine contains the engine API.
|
Package engine contains the engine API. |
|
internal/engine/experiment/dash
Package dash implements the DASH network experiment.
|
Package dash implements the DASH network experiment. |
|
internal/engine/experiment/dnscheck
Package dnscheck contains the DNS check experiment.
|
Package dnscheck contains the DNS check experiment. |
|
internal/engine/experiment/example
Package example contains a simple example experiment.
|
Package example contains a simple example experiment. |
|
internal/engine/experiment/fbmessenger
Package fbmessenger contains the Facebook Messenger network experiment.
|
Package fbmessenger contains the Facebook Messenger network experiment. |
|
internal/engine/experiment/hhfm
Package hhfm contains the HTTP Header Field Manipulation network experiment.
|
Package hhfm contains the HTTP Header Field Manipulation network experiment. |
|
internal/engine/experiment/hirl
Package hirl contains the HTTP Invalid Request Line network experiment.
|
Package hirl contains the HTTP Invalid Request Line network experiment. |
|
internal/engine/experiment/httphostheader
Package httphostheader contains the HTTP host header network experiment.
|
Package httphostheader contains the HTTP host header network experiment. |
|
internal/engine/experiment/ndt7
Package ndt7 contains the ndt7 network experiment.
|
Package ndt7 contains the ndt7 network experiment. |
|
internal/engine/experiment/psiphon
Package psiphon implements the psiphon network experiment.
|
Package psiphon implements the psiphon network experiment. |
|
internal/engine/experiment/riseupvpn
Package riseupvpn contains the RiseupVPN network experiment.
|
Package riseupvpn contains the RiseupVPN network experiment. |
|
internal/engine/experiment/run
Package run contains code to run other experiments.
|
Package run contains code to run other experiments. |
|
internal/engine/experiment/signal
Package signal contains the Signal network experiment.
|
Package signal contains the Signal network experiment. |
|
internal/engine/experiment/sniblocking
Package sniblocking contains the SNI blocking network experiment.
|
Package sniblocking contains the SNI blocking network experiment. |
|
internal/engine/experiment/stunreachability
Package stunreachability contains the STUN reachability experiment.
|
Package stunreachability contains the STUN reachability experiment. |
|
internal/engine/experiment/telegram
Package telegram contains the Telegram network experiment.
|
Package telegram contains the Telegram network experiment. |
|
internal/engine/experiment/tlstool
Package tlstool contains a TLS tool that we are currently using for running quick and dirty experiments.
|
Package tlstool contains a TLS tool that we are currently using for running quick and dirty experiments. |
|
internal/engine/experiment/tlstool/internal
Package internal contains the implementation of tlstool.
|
Package internal contains the implementation of tlstool. |
|
internal/engine/experiment/tor
Package tor contains the tor experiment.
|
Package tor contains the tor experiment. |
|
internal/engine/experiment/urlgetter
Package urlgetter implements a nettest that fetches a URL.
|
Package urlgetter implements a nettest that fetches a URL. |
|
internal/engine/experiment/webconnectivity
Package webconnectivity implements OONI's Web Connectivity experiment.
|
Package webconnectivity implements OONI's Web Connectivity experiment. |
|
internal/engine/experiment/webconnectivity/internal
Package internal contains internal code.
|
Package internal contains internal code. |
|
internal/engine/experiment/whatsapp
Package whatsapp contains the WhatsApp network experiment.
|
Package whatsapp contains the WhatsApp network experiment. |
|
internal/engine/geolocate
Package geolocate implements IP lookup, resolver lookup, and geolocation.
|
Package geolocate implements IP lookup, resolver lookup, and geolocation. |
|
internal/engine/httpx
Package httpx contains http extensions.
|
Package httpx contains http extensions. |
|
internal/engine/internal/mlablocate
Package mlablocate contains a locate.measurementlab.net client.
|
Package mlablocate contains a locate.measurementlab.net client. |
|
internal/engine/internal/mlablocatev2
Package mlablocatev2 use m-lab locate services API v2.
|
Package mlablocatev2 use m-lab locate services API v2. |
|
internal/engine/internal/mockable
Package mockable contains mockable objects
|
Package mockable contains mockable objects |
|
internal/engine/internal/sessionresolver
Package sessionresolver contains the resolver used by the session.
|
Package sessionresolver contains the resolver used by the session. |
|
internal/engine/legacy/assetsdir
Package assetsdir contains code to cleanup the assets dir.
|
Package assetsdir contains code to cleanup the assets dir. |
|
internal/engine/legacy/netx
Package netx contains OONI's net extensions.
|
Package netx contains OONI's net extensions. |
|
internal/engine/legacy/netx/connid
Package connid contains code to generate the connectionID
|
Package connid contains code to generate the connectionID |
|
internal/engine/legacy/netx/handlers
Package handlers contains default modelx.Handler handlers.
|
Package handlers contains default modelx.Handler handlers. |
|
internal/engine/legacy/netx/modelx
Package modelx contains the data modelx.
|
Package modelx contains the data modelx. |
|
internal/engine/legacy/netx/oldhttptransport
Package oldhttptransport contains HTTP transport extensions.
|
Package oldhttptransport contains HTTP transport extensions. |
|
internal/engine/legacy/netx/transactionid
Package transactionid contains code to share the transactionID
|
Package transactionid contains code to share the transactionID |
|
internal/engine/legacy/netxlogger
Package netxlogger is a logger for netx events.
|
Package netxlogger is a logger for netx events. |
|
internal/engine/legacy/oonidatamodel
Package oonidatamodel contains the OONI data model.
|
Package oonidatamodel contains the OONI data model. |
|
internal/engine/legacy/oonitemplates
Package oonitemplates contains templates for experiments.
|
Package oonitemplates contains templates for experiments. |
|
internal/engine/model
Package model defines shared data structures and interfaces.
|
Package model defines shared data structures and interfaces. |
|
internal/engine/netx
Package netx contains code to perform network measurements.
|
Package netx contains code to perform network measurements. |
|
internal/engine/netx/archival
Package archival contains data formats used for archival.
|
Package archival contains data formats used for archival. |
|
internal/engine/netx/errorx
Package errorx contains error extensions
|
Package errorx contains error extensions |
|
internal/engine/netx/httptransport
Package httptransport contains HTTP transport extensions.
|
Package httptransport contains HTTP transport extensions. |
|
internal/engine/netx/selfcensor
Package selfcensor contains code that triggers censorship.
|
Package selfcensor contains code that triggers censorship. |
|
internal/engine/probeservices
Package probeservices contains code to contact OONI probe services.
|
Package probeservices contains code to contact OONI probe services. |
|
internal/engine/probeservices/testorchestra
Package testorchestra helps with testing the OONI orchestra API.
|
Package testorchestra helps with testing the OONI orchestra API. |
|
internal/version
Package version contains version information
|
Package version contains version information |
|
pkg/oonimkall
Package oonimkall implements APIs used by OONI mobile apps.
|
Package oonimkall implements APIs used by OONI mobile apps. |
|
pkg/oonimkall/internal/tasks
Package tasks implements tasks run using the oonimkall API.
|
Package tasks implements tasks run using the oonimkall API. |
Click to show internal directories.
Click to hide internal directories.