.\" Man page generated from reStructuredText.
.
.TH "OONIPROBE" "1" "Dec 07, 2016" "2.1.0" "OONI: Open Observatory of Network Interference"
.SH NAME
ooniprobe \- an internet censorship measurement tool
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBooniprobe\fP [\fIoptions\fP] ([\fItest name\fP] | [\fIpath to nettest\fP\&.py])
.SH DESCRIPTION
.sp
\fBooniprobe\fP, is a tool for performing internet censorship
measurements. Our goal is to achieve a common data format and set of
methodologies for conducting censorship related research.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-h\fP,\fB  \-\-help
Display help and exit.
.TP
.B \-n\fP,\fB  \-\-no\-collector
Disable writing to collector
.TP
.B \-N\fP,\fB  \-\-no\-njson
Disable writing to disk
.TP
.B \-g\fP,\fB  \-\-no\-geoip
Disable geoip lookup on start
.TP
.B \-s\fP,\fB  \-\-list
List the currently installed ooniprobe nettests
.TP
.B \-v\fP,\fB  \-\-verbose
Show more verbose information
.TP
.B \-w\fP,\fB  \-\-web\-ui
Start the web UI
.TP
.B \-z\fP,\fB  \-\-initialize
Initialize ooniprobe to begin running it
.TP
.BI \-o\fP,\fB  \-\-reportfile \ PATH_TO_FILE
Specify the report file name to write to.
.TP
.BI \-i\fP,\fB  \-\-testdeck \ PATH_TO_DECK
Specify as input a test deck: a yaml file containing the tests to run and their arguments.
.TP
.BI \-c\fP,\fB  \-\-collector \ COLLECTOR_ADDRESS
Specify the address of the collector for test results. In most cases a user
will prefer to specify a bouncer over this.
.TP
.BI \-b\fP,\fB  \-\-bouncer \ BOUNCER_ADDRESS
Specify the bouncer used to obtain the address of the collector and test helpers.
.TP
.BI \-l\fP,\fB  \-\-logfile \ PATH_TO_LOGFILE
Write to this logs to this filename.
.TP
.BI \-O\fP,\fB  \-\-pcapfile \ PATH_TO_PCAPFILE
Write a PCAP of the ooniprobe session to this filename.
.TP
.BI \-f\fP,\fB  \-\-configfile \ PATH_TO_CONFIG
Specify a path to the ooniprobe configuration file.
.TP
.B \-d\fP,\fB  \-\-datadir
Specify a path to the ooniprobe data directory.
.UNINDENT
.INDENT 0.0
.TP
.B \-a, \-\-annotations key:value[,key2:value2]
Annotate the report with a key:value[, key:value] format.
.TP
.B \-P, \-\-preferred\-backend onion|https|cloudfront
Set the preferred backend to use when submitting results and/or
communicating with test helpers. Can be either onion, https or cloudfront
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Display the ooniprobe version and exit.
.UNINDENT
.SH OONIPROBE
.SS Read this before running ooniprobe!
.sp
Running ooniprobe is a potentially risky activity. This greatly depends on the
jurisdiction in which you are in and which test you are running. It is
technically possible for a person observing your internet connection to be
aware of the fact that you are running ooniprobe. This means that if running
network measurement tests is something considered to be illegal in your country
then you could be spotted.
.sp
Furthermore, ooniprobe takes no precautions to protect the install target machine
from forensics analysis.  If the fact that you have installed or used ooni
probe is a liability for you, please be aware of this risk.
.SS What is this?
.sp
ooniprobe is the command line tool that volunteers and researches interested in
contributing data to the project should be running.
.sp
If you are interested in using ooniprobe from a graphical user interface
refer to \fBooniprobe\-agent\fP and see how to run that.
.sp
ooniprobe allows the user to select what test should be run and what backend
should be used for storing the test report and/or assisting them in the running
of the test.
.sp
ooniprobe tests are divided into two categories: \fBTraffic Manipulation\fP and
\fBContent Blocking\fP\&.
.sp
\fBTraffic Manipulation\fP tests aim to detect the presence of some sort of
tampering with the internet traffic between the probe and a remote test helper
backend. As such they usually require the selection of a oonib backend
component for running the test.
.sp
\fBContent Blocking\fP are aimed at enumerating the kind of content that is
blocked from the probes network point of view. As such they usually require to
have specified an input list for running the test.
.SH EXAMPLES
.sp
Run the web_connectivity test on \fI\%http://torproject.org\fP:
.INDENT 0.0
.INDENT 3.5
\fBooniprobe web_connectivity \-\-url http://torproject.org/\fP
.UNINDENT
.UNINDENT
.sp
Run the http_invalid_request_line test to detect middleboxes:
.INDENT 0.0
.INDENT 3.5
\fBooniprobe http_invalid_request_line\fP
.UNINDENT
.UNINDENT
.sp
Run the http_header_field_manipulation test to detect middleboxes:
.INDENT 0.0
.INDENT 3.5
\fBooniprobe http_header_field_manipulation\fP
.UNINDENT
.UNINDENT
.sp
List all the available tests:
.INDENT 0.0
.INDENT 3.5
\fBooniprobe \-s\fP
.UNINDENT
.UNINDENT
.sp
Start the web user interface:
.INDENT 0.0
.INDENT 3.5
\fBooniprobe \-w\fP
.UNINDENT
.UNINDENT
.SH AUTHOR
The Tor Project
.SH COPYRIGHT
2016, The Tor Project
.\" Generated by docutils manpage writer.
.