summaryrefslogtreecommitdiff
path: root/doc/man/gnunet-nat-server.1
blob: 1fdf1e265b7ea6cac0b4cccad66277635d3e761e (plain)
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
.TH GNUNET-NAT-SERVER 1 "February 25, 2012" "GNUnet"
.SH NAME
gnunet\-nat\-server \- help GNUnet setup test network setup with NAT
.SH SYNOPSIS
.B gnunet\-nat\-server
.RI [ options ]
.RI PORT
.SH DESCRIPTION
Normal GNUnet end-users should not concern themselves with
gnunet\-nat\-server.  In fact, distributions are encouraged to
consider not shipping it at all.  Running gnunet\-nat\-server's is
similar to running hostlist servers: it is a special service to the
community with special requirements and no benefit to those running
the service.
.PP
This program will listen on the specified PORT for incoming requests
to test a peer's network connectivity.  Incoming requests can ask it
to connect to a given IPv4 address (and port) using TCP or UDP and to
send a 2-byte test message using the specified address.  The program
can also be asked to send a "fake" ICMP response message to a given
IPv4 address (for autonomous NAT traversal \-\-\- see the description
in the respective research paper).
.PP
The idea is that gnunet\-nat\-server will be run on some trusted hosts
with unrestricted connectivity to allow GNUnet users to test their
network configuration.  As written, the code allows any user on the
Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary
data to any TCP or UDP port at any address.  We believe that this is
generally harmless.
.PP
When running gnunet\-nat\-server, make sure to use a configuration
that disables most NAT options but enables 'enable_nat_client' and
sets 'internal_address' to the global IP address of your local host.
Also, the gnunet\-helper\-nat\-client should be installed locally and
run with root privileges (SUID), otherwise the gnunet\-nat\-server
will not work properly.
.PP
Note that gnunet\-nat\-server could be run via gnunet\-arm but
typically is not.  Also, the name of the host and port that
gnunet\-nat\-server is run on should be specified in the NATSERVER
option in the [setup] section of the configuration file of hosts that
are supposed to autoconfigure with this server.
.SH OPTIONS
.B
.IP "\-c FILENAME,  \-\-config=FILENAME"
Use the configuration file FILENAME.
.SH BUGS
Report bugs by using Mantis <https://gnunet.org/bugs/> or by sending
electronic mail to <gnunet\-developers@gnu.org>
.SH SEE ALSO
gnunet\-transport(1)
.PP
The full documentation for
.B gnunet
is maintained as a Texinfo manual.
If the
.B info
and
.B gnunet
programs are properly installed at your site, the command
.IP
.B info gnunet
.PP
should give you access to the complete handbook,
.IP
.B info gnunet-c-tutorial
.PP
will give you access to a tutorial for developers.
.PP
Depending on your installation, this information is also
available in
\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7).