-
Notifications
You must be signed in to change notification settings - Fork 12
/
ooniprobe-agent.1
140 lines (140 loc) · 3.96 KB
/
ooniprobe-agent.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
.\" Man page generated from reStructuredText.
.
.TH "OONIPROBE-AGENT" "1" "Apr 05, 2017" "2.2.0" "OONI: Open Observatory of Network Interference"
.SH NAME
ooniprobe-agent \- an internet censorship measurement tool, system daemon.
.
.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\-agent\fP start | stop | run | status
.SH DESCRIPTION
.sp
\fBooniprobe\-agent\fP, is a system daemon responsible for automatically
running OONI measurements and exposing a web user interface. The web user
interface is accessible by default on \fI\%http://127.0.0.1:8842/\fP
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-help
Display help and exit.
.TP
.B \-\-version
Display the ooniprobe version and exit.
.UNINDENT
.SH COMMANDS
.sp
\fBstart\fP
Start the ooniprobe\-agent in the background
.sp
\fBstop\fP
Stop the ooniprobe\-agent
.sp
\fBstatus\fP
Show status of the ooniprobe\-agent
.sp
\fBrun\fP
Run the ooniprobe\-agent in the foreground
.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.
.