aboutsummaryrefslogtreecommitdiff
path: root/doc/man/gnunet-nat-server.1
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/gnunet-nat-server.1')
-rw-r--r--doc/man/gnunet-nat-server.143
1 files changed, 34 insertions, 9 deletions
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1
index dcf856e1c..3d79d5bc5 100644
--- a/doc/man/gnunet-nat-server.1
+++ b/doc/man/gnunet-nat-server.1
@@ -11,15 +11,40 @@ gnunet\-nat\-server \- help GNUnet setup test network setup with NAT
11 11
12.SH DESCRIPTION 12.SH DESCRIPTION
13 13
14Normal 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. 14Normal GNUnet end-users should not concern themselves with
15 15gnunet\-nat\-server. In fact, distributions are encouraged to
16This 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). 16consider not shipping it at all. Running gnunet\-nat\-server's is
17 17similar to running hostlist servers: it is a special service to the
18The 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. 18community with special requirements and no benefit to those running
19 19the service.
20When 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. 20
21 21This program will listen on the specified PORT for incoming requests
22Note 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. 22to test a peer's network connectivity. Incoming requests can ask it
23to connect to a given IPv4 address (and port) using TCP or UDP and to
24send a 2-byte test message using the specified address. The program
25can also be asked to send a "fake" ICMP response message to a given
26IPv4 address (for autonomous NAT traversal \-\-\- see the description
27in the respective research paper).
28
29The idea is that gnunet\-nat\-server will be run on some trusted hosts
30with unrestricted connectivity to allow GNUnet users to test their
31network configuration. As written, the code allows any user on the
32Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary
33data to any TCP or UDP port at any address. We believe that this is
34generally harmless.
35
36When running gnunet\-nat\-server, make sure to use a configuration
37that disables most NAT options but enables 'enable_nat_client' and
38sets 'internal_address' to the global IP address of your local host.
39Also, the gnunet\-helper\-nat\-client should be installed locally and
40run with root privileges (SUID), otherwise the gnunet\-nat\-server
41will not work properly.
42
43Note that gnunet\-nat\-server could be run via gnunet\-arm but
44typically is not. Also, the name of the host and port that
45gnunet\-nat\-server is run on should be specified in the NATSERVER
46option in the [setup] section of the configuration file of hosts that
47are supposed to autoconfigure with this server.
23 48
24 49
25.SH OPTIONS 50.SH OPTIONS