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.1170
1 files changed, 102 insertions, 68 deletions
diff --git a/doc/man/gnunet-nat-server.1 b/doc/man/gnunet-nat-server.1
index 8cb995f7c..b8462d9da 100644
--- a/doc/man/gnunet-nat-server.1
+++ b/doc/man/gnunet-nat-server.1
@@ -1,71 +1,105 @@
1.TH GNUNET-NAT-SERVER 1 "February 25, 2012" "GNUnet" 1.\" This file is part of GNUnet.
2.SH NAME 2.\" Copyright (C) 2001-2019 GNUnet e.V.
3gnunet\-nat\-server \- help GNUnet setup test network setup with NAT 3.\"
4.SH SYNOPSIS 4.\" Permission is granted to copy, distribute and/or modify this document
5.B gnunet\-nat\-server 5.\" under the terms of the GNU Free Documentation License, Version 1.3 or
6.RI [ options ] 6.\" any later version published by the Free Software Foundation; with no
7.RI PORT 7.\" Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
8.SH DESCRIPTION 8.\" copy of the license is included in the file
9Normal GNUnet end-users should not concern themselves with 9.\" ``FDL-1.3''.
10gnunet\-nat\-server. In fact, distributions are encouraged to 10.\"
11consider not shipping it at all. Running gnunet\-nat\-server's is 11.\" A copy of the license is also available from the Free Software
12similar to running hostlist servers: it is a special service to the 12.\" Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
13community with special requirements and no benefit to those running 13.\"
14the service. 14.\" Alternately, this document is also available under the General
15.PP 15.\" Public License, version 3 or later, as published by the Free Software
16This program will listen on the specified PORT for incoming requests 16.\" Foundation. A copy of the license is included in the file
17to test a peer's network connectivity. Incoming requests can ask it 17.\" ``GPL3''.
18to connect to a given IPv4 address (and port) using TCP or UDP and to 18.\"
19send a 2-byte test message using the specified address. The program 19.\" A copy of the license is also available from the Free Software
20can also be asked to send a "fake" ICMP response message to a given 20.\" Foundation Web site at @url{http://www.gnu.org/licenses/gpl.html}.
21IPv4 address (for autonomous NAT traversal \-\-\- see the description 21.\"
22in the respective research paper). 22.\" SPDX-License-Identifier: GPL3.0-or-later OR FDL1.3-or-later
23.PP 23.\"
24The idea is that gnunet\-nat\-server will be run on some trusted hosts 24.Dd February 25, 2012
25with unrestricted connectivity to allow GNUnet users to test their 25.Dt GNUNET-NAT-SERVER 1
26network configuration. As written, the code allows any user on the 26.Os
27Internet to cause the gnunet\-nat\-server to send 2-bytes of arbitrary 27.Sh NAME
28data to any TCP or UDP port at any address. We believe that this is 28.Nm gnunet-nat-server
29generally harmless. 29.Nd
30.PP 30help GNUnet setup test network setup with NAT
31When running gnunet\-nat\-server, make sure to use a configuration 31.Sh SYNOPSIS
32that disables most NAT options but enables 'enable_nat_client' and 32.Nm
33sets 'internal_address' to the global IP address of your local host. 33.Op Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
34Also, the gnunet\-helper\-nat\-client should be installed locally and 34.Op Fl d | \-daemonize
35run with root privileges (SUID), otherwise the gnunet\-nat\-server 35.Op Fl h | \-help
36will not work properly. 36.Op Fl L Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
37.PP 37.Op Fl v | \-version
38Note that gnunet\-nat\-server could be run via gnunet\-arm but 38.Ao Ar PORT Ac
39typically is not. Also, the name of the host and port that 39.Sh DESCRIPTION
40gnunet\-nat\-server is run on should be specified in the NATSERVER 40Running a gnunet-nat-server is similar to running a hostlist server: it is a special service to the community with special requirements and no benefit to those running the service.
41option in the [setup] section of the configuration file of hosts that 41.Pp
42are supposed to autoconfigure with this server. 42This program will listen on the specified
43.SH OPTIONS 43.Ar PORT
44.IP "\-c FILENAME, \-\-config=FILENAME" 44for incoming requests to test a peer's network connectivity.
45Use the configuration file FILENAME. 45Incoming 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.
46.SH BUGS 46The 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).
47Report bugs by using Mantis <https://bugs.gnunet.org/> or by sending 47.Pp
48electronic mail to <gnunet\-developers@gnu.org> 48The 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.
49.SH SEE ALSO 49As 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.
50gnunet\-transport(1) 50We believe that this is generally harmless.
51.PP 51.Pp
52The full documentation for 52When 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.
53.B gnunet 53Also, the gnunet-helper-nat-client should be installed locally and run with root privileges (SUID), otherwise the gnunet-nat-server will not work properly.
54is maintained as a Texinfo manual. 54.Pp
55Note that gnunet-nat-server could be run via gnunet-arm but typically is not.
56Also, 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.
57.Pp
58Normal GNUnet end-users should not concern themselves with gnunet-nat-server.
59In fact, distributions are encouraged to consider not shipping it at all.
60.Pp
61The options are as follows:
62.Bl -tag -width Ds
63.It Fl c Ar FILENAME | Fl \-config= Ns Ar FILENAME
64Use the configuration file
65.Ar FILENAME .
66.It Fl d | \-daemonize
67Daemonize gnunet-nat-server (detach from terminal).
68.It Fl h | \-help
69Print the help page.
70.It Fl L Ar LOGLEVEL | Fl \-log= Ns Ar LOGLEVEL
71Configure logging to use
72.Ar LOGLEVEL .
73.It Fl l Ar FILENAME | Fl \-logfile= Ns Ar FILENAME
74Configure logging to write logs to
75.Ar FILENAME .
76.It Fl v | \-version
77Print the GNUnet version.
78.El
79.\".Sh EXAMPLES
80.Sh SEE ALSO
81.Xr gnunet-transport 1
82.sp
83The full documentation for gnunet is maintained as a Texinfo manual.
55If the 84If the
56.B info 85.Xr info 1
57and 86and gnunet programs are properly installed at your site, the command
58.B gnunet 87.Pp
59programs are properly installed at your site, the command 88.Dl info gnunet
60.IP 89.Pp
61.B info gnunet
62.PP
63should give you access to the complete handbook, 90should give you access to the complete handbook,
64.IP 91.Pp
65.B info gnunet-c-tutorial 92.Dl info gnunet-c-tutorial
66.PP 93.Pp
67will give you access to a tutorial for developers. 94will give you access to a tutorial for developers.
68.PP 95.sp
69Depending on your installation, this information is also 96Depending on your installation, this information is also available in
70available in 97.Xr gnunet 7 and
71\fBgnunet\fP(7) and \fBgnunet-c-tutorial\fP(7). 98.Xr gnunet-c-tutorial 7 .
99.\".Sh HISTORY
100.\".Sh AUTHORS
101.Sh BUGS
102Report bugs by using
103.Lk https://bugs.gnunet.org
104or by sending electronic mail to
105.Aq Mt gnunet-developers@gnu.org .
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-19 05:47:13 +0000