diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile | 19 | ||||
| -rw-r--r-- | doc/anyrtpproxy.8.txt | 29 | ||||
| -rw-r--r-- | doc/anytun-config.8 | 23 | ||||
| -rw-r--r-- | doc/anytun-config.8.txt | 36 | ||||
| -rw-r--r-- | doc/anytun-controld.8 | 21 | ||||
| -rw-r--r-- | doc/anytun-controld.8.txt | 29 | ||||
| -rw-r--r-- | doc/anytun-showtables.8 | 23 | ||||
| -rw-r--r-- | doc/anytun-showtables.8.txt | 10 | ||||
| -rw-r--r-- | doc/anytun.8 | 23 | ||||
| -rw-r--r-- | doc/anytun.8.txt | 58 |
10 files changed, 159 insertions, 112 deletions
diff --git a/doc/Makefile b/doc/Makefile index e94cbac..4d5f9a2 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -11,7 +11,7 @@ ## tunneling and relaying of packets of any protocol. ## ## -## Copyright (C) 2007-2009 Othmar Gsenger, Erwin Nindl, +## Copyright (C) 2007-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl, ## Christian Pointner <satp@wirdorange.org> ## ## This file is part of Anytun. @@ -27,13 +27,26 @@ ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License -## along with anytun. If not, see <http://www.gnu.org/licenses/>. +## along with Anytun. If not, see <http://www.gnu.org/licenses/>. +## +## In addition, as a special exception, the copyright holders give +## permission to link the code of portions of this program with the +## OpenSSL library under certain conditions as described in each +## individual source file, and distribute linked combinations +## including the two. +## You must obey the GNU General Public License in all respects +## for all of the code used other than OpenSSL. If you modify +## file(s) with this exception, you may extend this exception to your +## version of the file(s), but you are not obligated to do so. If you +## do not wish to do so, delete this exception statement from your +## version. If you delete this exception statement from all source +## files in the program, then also delete it here. ## VERSION=$(shell cat ../version) MANPAGES := anytun.8 anytun-controld.8 anytun-config.8 anytun-showtables.8 #anyrtpproxy.8 -XML := $(MANPAGES:%.8=%.8.xml) +XML := $(MANPAGES:%.8=%.8.xml) .PHONY: clean realclean diff --git a/doc/anyrtpproxy.8.txt b/doc/anyrtpproxy.8.txt index a92d2e6..4f29906 100644 --- a/doc/anyrtpproxy.8.txt +++ b/doc/anyrtpproxy.8.txt @@ -31,7 +31,7 @@ DESCRIPTION *anyrtpproxy* is a rtpproxy which can be used in combination with anycast. It uses the same control protocol than rtpproxy though it can be controled through the nathelper -plugin of openser. *anyrtpproxy* uses the same synchronisation protocol than *Anytun* +plugin of openser. *anyrtpproxy* uses the same synchronisation protocol than *Anytun* to sync the session information among all anycast instances. @@ -61,16 +61,16 @@ OPTIONS The local address and port to listen on for control messages from openser *-p, --port-range <start> <end>*:: - A pool of ports which should be used by *anyrtpproxy* to relay RTP packets. + A pool of ports which should be used by *anyrtpproxy* to relay RTP packets. The range may not overlap between the anycast instances *-n, --nat*:: Allow to learn the remote address and port in order to handle clients behind nat. - This option should only be enabled if the source is authenticated (i.e. through - *anytun*) + This option should only be enabled if the source is authenticated (i.e. through + *anytun*) *-o, --no-nat-once*:: - Disable learning of remote address and port in case the first packet does not + Disable learning of remote address and port in case the first packet does not come from the client which is specified by openser during configuration. Invoking this parameter increases the security level of the system but in case of nat needs a working nat transversal such as stun. @@ -79,13 +79,13 @@ OPTIONS local unicast(sync) port to bind to + This port is used by anycast hosts to synchronize information about tunnel endpoints. No payload data is transmitted via this port. + - It is possible to obtain a list of active connections by telnetting into - this port. This port is read-only and unprotected by default. It is advised + It is possible to obtain a list of active connections by telnetting into + this port. This port is read-only and unprotected by default. It is advised to protect this port using firewall rules and, eventually, IPsec. *-M, --sync-hosts <hostname|ip>:<port>,[<hostname|ip>:<port>[...]]*:: remote hosts to sync with + - Here, one has to specify all unicast IP addresses of all + Here, one has to specify all unicast IP addresses of all other anycast hosts that comprise the anycast tunnel endpoint. EXAMPLES @@ -94,7 +94,7 @@ EXAMPLES Anycast Setup with 3 instances: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -On the host with unicast hostname unicast1.anycast.anytun.org and anycast +On the host with unicast hostname unicast1.anycast.anytun.org and anycast hostname anycast.anytun.org: -------------------------------------------------------------------------------------- # anyrtpproxy -i anycast.anytun.org -p 20000 25000 -S 2342 \ @@ -142,9 +142,8 @@ Main web site: http://www.anytun.org/ COPYING ------- -Copyright \(C) 2007-2009 Othmar Gsenger, Erwin Nindl and Christian -Pointner. This program is free software: you can redistribute it -and/or modify it under the terms of the GNU General Public License -as published by the Free Software Foundation, either version 3 of -the License, or any later version. - +Copyright \(C) 2007-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl +and Christian Pointner. This program is free software: you can +redistribute it and/or modify it under the terms of the GNU General +Public License as published by the Free Software Foundation, either +version 3 of the License, or any later version. diff --git a/doc/anytun-config.8 b/doc/anytun-config.8 index 5facb41..aec19e8 100644 --- a/doc/anytun-config.8 +++ b/doc/anytun-config.8 @@ -1,13 +1,22 @@ '\" t .\" Title: anytun-config .\" Author: [see the "AUTHORS" section] -.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/> -.\" Date: 02/11/2010 -.\" Manual: anytun-config user manual -.\" Source: anytun trunk +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 06/29/2014 +.\" Manual: \ \& +.\" Source: \ \& .\" Language: English .\" -.TH "ANYTUN\-CONFIG" "8" "02/11/2010" "anytun trunk" "anytun-config user manual" +.TH "ANYTUN\-CONFIG" "8" "06/29/2014" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -121,7 +130,7 @@ the multiplex id to use\&. default: 0 .RS 4 seqence window size -Sometimes, packets arrive out of order on the receiver side\&. This option defines the size of a list of received packets\' sequence numbers\&. If, according to this list, a received packet has been previously received or has been transmitted in the past, and is therefore not in the list anymore, this is interpreted as a replay attack and the packet is dropped\&. A value of 0 deactivates this list and, as a consequence, the replay protection employed by filtering packets according to their secuence number\&. By default the sequence window is disabled and therefore a window size of 0 is used\&. +Sometimes, packets arrive out of order on the receiver side\&. This option defines the size of a list of received packets\*(Aq sequence numbers\&. If, according to this list, a received packet has been previously received or has been transmitted in the past, and is therefore not in the list anymore, this is interpreted as a replay attack and the packet is dropped\&. A value of 0 deactivates this list and, as a consequence, the replay protection employed by filtering packets according to their secuence number\&. By default the sequence window is disabled and therefore a window size of 0 is used\&. .RE .PP \fB\-k, \-\-kd\(emprf \fR\fB\fI<kd\-prf type>\fR\fR @@ -228,4 +237,4 @@ Othmar Gsenger <otti@anytun\&.org> Erwin Nindl <nine@anytun\&.org> Christian Poi Main web site: http://www\&.anytun\&.org/ .SH "COPYING" .sp -Copyright (C) 2007\-2009 Othmar Gsenger, Erwin Nindl and Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&. +Copyright (C) 2007\-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl and Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&. diff --git a/doc/anytun-config.8.txt b/doc/anytun-config.8.txt index 1aebf9a..1b27208 100644 --- a/doc/anytun-config.8.txt +++ b/doc/anytun-config.8.txt @@ -38,21 +38,21 @@ OPTIONS *-L, --log '<target>:<level>[,<param1>[,<param2>[..]]]'*:: add log target to logging system. This can be invoked several times - in order to log to different targets at the same time. Every target + in order to log to different targets at the same time. Every target hast its own log level which is a number between 0 and 5. Where 0 means disabling log and 5 means debug messages are enabled. + The file target can be used more the once with different levels. - If no target is provided at the command line a single target with the + If no target is provided at the command line a single target with the config 'syslog:3,anytun-config,daemon' is added. + The following targets are supported: 'syslog';; log to syslog daemon, parameters <level>[,<logname>[,<facility>]] 'file';; log to file, parameters <level>[,<path>] 'stdout';; log to standard output, parameters <level> - 'stderr';; log to standard error, parameters <level> + 'stderr';; log to standard error, parameters <level> *-U, --debug*:: - This option instructs *Anytun* to run in debug mode. It implicits *-D* + This option instructs *Anytun* to run in debug mode. It implicits *-D* (don't daemonize) and adds a log target with the configuration 'stdout:5' (logging with maximum level). In future releases there might be additional output when this option is supplied. @@ -100,7 +100,7 @@ OPTIONS *-k, --kd--prf '<kd-prf type>'*:: key derivation pseudo random function + - The pseudo random function which is used for calculating the + The pseudo random function which is used for calculating the session keys and session salt. + Possible values: @@ -113,16 +113,16 @@ OPTIONS *-e, --role '<role>'*:: SATP uses different session keys for inbound and outbound traffic. The role parameter is used to determine which keys to use for outbound or - inbound packets. On both sides of a vpn connection different roles have - to be used. Possible values are *left* and *right*. You may also use - *alice* or *server* as a replacement for *left* and *bob* or *client* as + inbound packets. On both sides of a vpn connection different roles have + to be used. Possible values are *left* and *right*. You may also use + *alice* or *server* as a replacement for *left* and *bob* or *client* as a replacement for *right*. By default *left* is used. *-E, --passphrase '<pass phrase>'*:: This passphrase is used to generate the master key and master salt. - For the master key the last n bits of the SHA256 digest of the - passphrase (where n is the length of the master key in bits) is used. - The master salt gets generated with the SHA1 digest. + For the master key the last n bits of the SHA256 digest of the + passphrase (where n is the length of the master key in bits) is used. + The master salt gets generated with the SHA1 digest. You may force a specific key and or salt by using *--key* and *--salt*. *-K, --key '<master key>'*:: @@ -143,10 +143,10 @@ EXAMPLES Add a client with Connection ID (Mux) 12 and add 2 Routes to this client ------------------------------------------------------------------------------------------------- +------------------------------------------------------------------------------------------------ # anytun-config -w 0 -m 12 -K 0123456789ABCDEFFEDCBA9876543210 -A 0123456789ABCDDCBA9876543210 \ -R 192.0.2.0/24 -R 192.168.1.1/32 -e server >> routingtable ------------------------------------------------------------------------------------------------- +------------------------------------------------------------------------------------------------ BUGS ---- @@ -174,8 +174,8 @@ Main web site: http://www.anytun.org/ COPYING ------- -Copyright \(C) 2007-2009 Othmar Gsenger, Erwin Nindl and Christian -Pointner. This program is free software: you can redistribute it -and/or modify it under the terms of the GNU General Public License -as published by the Free Software Foundation, either version 3 of -the License, or any later version. +Copyright \(C) 2007-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl +and Christian Pointner. This program is free software: you can +redistribute it and/or modify it under the terms of the GNU General +Public License as published by the Free Software Foundation, either +version 3 of the License, or any later version. diff --git a/doc/anytun-controld.8 b/doc/anytun-controld.8 index cfcdf41..59388a0 100644 --- a/doc/anytun-controld.8 +++ b/doc/anytun-controld.8 @@ -1,13 +1,22 @@ '\" t .\" Title: anytun-controld .\" Author: [see the "AUTHORS" section] -.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/> -.\" Date: 02/11/2010 -.\" Manual: anytun-controld user manual -.\" Source: anytun trunk +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 06/29/2014 +.\" Manual: \ \& +.\" Source: \ \& .\" Language: English .\" -.TH "ANYTUN\-CONTROLD" "8" "02/11/2010" "anytun trunk" "anytun-controld user manual" +.TH "ANYTUN\-CONTROLD" "8" "06/29/2014" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -136,4 +145,4 @@ Othmar Gsenger <otti@anytun\&.org> Erwin Nindl <nine@anytun\&.org> Christian Poi Main web site: http://www\&.anytun\&.org/ .SH "COPYING" .sp -Copyright (C) 2007\-2009 Othmar Gsenger, Erwin Nindl and Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&. +Copyright (C) 2007\-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl and Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&. diff --git a/doc/anytun-controld.8.txt b/doc/anytun-controld.8.txt index 6c7a3d8..96ac3e3 100644 --- a/doc/anytun-controld.8.txt +++ b/doc/anytun-controld.8.txt @@ -36,7 +36,7 @@ OPTIONS instead of becoming a daemon which is the default. *-u, --username '<username>'*:: - run as this user. If no group is specified (*-g*) the default group of + run as this user. If no group is specified (*-g*) the default group of the user is used. The default is to not drop privileges. *-g, --groupname '<groupname>'*:: @@ -44,30 +44,30 @@ OPTIONS The default is to not drop privileges. *-C, --chroot '<path>'*:: - Instruct *anytun-controld* to run in a chroot jail. The default is + Instruct *anytun-controld* to run in a chroot jail. The default is to not run in chroot. *-P, --write-pid '<filename>'*:: - Instruct *anytun-controld* to write it's pid to this file. The default is + Instruct *anytun-controld* to write it's pid to this file. The default is to not create a pid file. *-L, --log '<target>:<level>[,<param1>[,<param2>[..]]]'*:: add log target to logging system. This can be invoked several times - in order to log to different targets at the same time. Every target + in order to log to different targets at the same time. Every target hast its own log level which is a number between 0 and 5. Where 0 means disabling log and 5 means debug messages are enabled. + The file target can be used more the once with different levels. - If no target is provided at the command line a single target with the + If no target is provided at the command line a single target with the config 'syslog:3,anytun-controld,daemon' is added. + The following targets are supported: 'syslog';; log to syslog daemon, parameters <level>[,<logname>[,<facility>]] 'file';; log to file, parameters <level>[,<path>] 'stdout';; log to standard output, parameters <level> - 'stderr';; log to standard error, parameters <level> + 'stderr';; log to standard error, parameters <level> *-U, --debug*:: - This option instructs *Anytun* to run in debug mode. It implicits *-D* + This option instructs *Anytun* to run in debug mode. It implicits *-D* (don't daemonize) and adds a log target with the configuration 'stdout:5' (logging with maximum level). In future releases there might be additional output when this option is supplied. @@ -77,10 +77,10 @@ OPTIONS *-X, --control-host '<hostname|ip>[:<port>]'*:: fetch the config from this host. The default is not to use a control - host and therefore this is empty. Mind that the port can be omitted + host and therefore this is empty. Mind that the port can be omitted in which case port 2323 is used. If you want to specify an ipv6 address and a port you have to use [ and ] to separate the address - from the port, eg.: [::1]:1234. If you want to use the default port + from the port, eg.: [::1]:1234. If you want to use the default port [ and ] can be omitted. @@ -110,9 +110,8 @@ Main web site: http://www.anytun.org/ COPYING ------- -Copyright \(C) 2007-2009 Othmar Gsenger, Erwin Nindl and Christian -Pointner. This program is free software: you can redistribute it -and/or modify it under the terms of the GNU General Public License -as published by the Free Software Foundation, either version 3 of -the License, or any later version. - +Copyright \(C) 2007-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl +and Christian Pointner. This program is free software: you can +redistribute it and/or modify it under the terms of the GNU General +Public License as published by the Free Software Foundation, either +version 3 of the License, or any later version. diff --git a/doc/anytun-showtables.8 b/doc/anytun-showtables.8 index 4d91bc0..334b4dd 100644 --- a/doc/anytun-showtables.8 +++ b/doc/anytun-showtables.8 @@ -1,13 +1,22 @@ '\" t .\" Title: anytun-showtables .\" Author: [see the "AUTHORS" section] -.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/> -.\" Date: 02/11/2010 -.\" Manual: anytun-showtables user manual -.\" Source: anytun trunk +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 06/29/2014 +.\" Manual: \ \& +.\" Source: \ \& .\" Language: English .\" -.TH "ANYTUN\-SHOWTABLES" "8" "02/11/2010" "anytun trunk" "anytun-showtables user manual" +.TH "ANYTUN\-SHOWTABLES" "8" "06/29/2014" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -39,7 +48,7 @@ Print routing table stored in local file .RS 4 .\} .nf -# perl \-ne \'chomp; print\' < routingtable | \&./anytun\-showtables +# perl \-ne \*(Aqchomp; print\*(Aq < routingtable | \&./anytun\-showtables .fi .if n \{\ .RE @@ -70,4 +79,4 @@ Othmar Gsenger <otti@anytun\&.org> Erwin Nindl <nine@anytun\&.org> Christian Poi Main web site: http://www\&.anytun\&.org/ .SH "COPYING" .sp -Copyright (C) 2007\-2009 Othmar Gsenger, Erwin Nindl and Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&. +Copyright (C) 2007\-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl and Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&. diff --git a/doc/anytun-showtables.8.txt b/doc/anytun-showtables.8.txt index 13070a4..ea74998 100644 --- a/doc/anytun-showtables.8.txt +++ b/doc/anytun-showtables.8.txt @@ -65,8 +65,8 @@ Main web site: http://www.anytun.org/ COPYING ------- -Copyright \(C) 2007-2009 Othmar Gsenger, Erwin Nindl and Christian -Pointner. This program is free software: you can redistribute it -and/or modify it under the terms of the GNU General Public License -as published by the Free Software Foundation, either version 3 of -the License, or any later version. +Copyright \(C) 2007-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl +and Christian Pointner. This program is free software: you can +redistribute it and/or modify it under the terms of the GNU General +Public License as published by the Free Software Foundation, either +version 3 of the License, or any later version. diff --git a/doc/anytun.8 b/doc/anytun.8 index 3b6aa79..e2d5061 100644 --- a/doc/anytun.8 +++ b/doc/anytun.8 @@ -1,13 +1,22 @@ '\" t .\" Title: anytun .\" Author: [see the "AUTHORS" section] -.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/> -.\" Date: 02/11/2010 -.\" Manual: anytun user manual -.\" Source: anytun trunk +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 06/29/2014 +.\" Manual: \ \& +.\" Source: \ \& .\" Language: English .\" -.TH "ANYTUN" "8" "02/11/2010" "anytun trunk" "anytun user manual" +.TH "ANYTUN" "8" "06/29/2014" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -253,7 +262,7 @@ Each anycast tunnel endpoint needs a uniqe sender id (1, 2, 3, \&...)\&. It is n .RS 4 seqence window size -Sometimes, packets arrive out of order on the receiver side\&. This option defines the size of a list of received packets\' sequence numbers\&. If, according to this list, a received packet has been previously received or has been transmitted in the past, and is therefore not in the list anymore, this is interpreted as a replay attack and the packet is dropped\&. A value of 0 deactivates this list and, as a consequence, the replay protection employed by filtering packets according to their secuence number\&. By default the sequence window is disabled and therefore a window size of 0 is used\&. +Sometimes, packets arrive out of order on the receiver side\&. This option defines the size of a list of received packets\*(Aq sequence numbers\&. If, according to this list, a received packet has been previously received or has been transmitted in the past, and is therefore not in the list anymore, this is interpreted as a replay attack and the packet is dropped\&. A value of 0 deactivates this list and, as a consequence, the replay protection employed by filtering packets according to their secuence number\&. By default the sequence window is disabled and therefore a window size of 0 is used\&. .RE .PP \fB\-k, \-\-kd\(emprf \fR\fB\fI<kd\-prf type>\fR\fR @@ -496,4 +505,4 @@ Othmar Gsenger <otti@anytun\&.org> Erwin Nindl <nine@anytun\&.org> Christian Poi Main web site: http://www\&.anytun\&.org/ .SH "COPYING" .sp -Copyright (C) 2007\-2009 Othmar Gsenger, Erwin Nindl and Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&. +Copyright (C) 2007\-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl and Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&. diff --git a/doc/anytun.8.txt b/doc/anytun.8.txt index 00d3e91..7896dcd 100644 --- a/doc/anytun.8.txt +++ b/doc/anytun.8.txt @@ -68,7 +68,7 @@ passed to the daemon: instead of becoming a daemon which is the default. *-u, --username '<username>'*:: - run as this user. If no group is specified (*-g*) the default group of + run as this user. If no group is specified (*-g*) the default group of the user is used. The default is to not drop privileges. *-g, --groupname '<groupname>'*:: @@ -76,30 +76,30 @@ passed to the daemon: The default is to not drop privileges. *-C, --chroot '<path>'*:: - Instruct *Anytun* to run in a chroot jail. The default is + Instruct *Anytun* to run in a chroot jail. The default is to not run in chroot. *-P, --write-pid '<filename>'*:: - Instruct *Anytun* to write it's pid to this file. The default is + Instruct *Anytun* to write it's pid to this file. The default is to not create a pid file. *-L, --log '<target>:<level>[,<param1>[,<param2>[..]]]'*:: add log target to logging system. This can be invoked several times - in order to log to different targets at the same time. Every target + in order to log to different targets at the same time. Every target hast its own log level which is a number between 0 and 5. Where 0 means disabling log and 5 means debug messages are enabled. + The file target can be used more the once with different levels. - If no target is provided at the command line a single target with the + If no target is provided at the command line a single target with the config 'syslog:3,anytun,daemon' is added. + The following targets are supported: 'syslog';; log to syslog daemon, parameters <level>[,<logname>[,<facility>]] 'file';; log to file, parameters <level>[,<path>] 'stdout';; log to standard output, parameters <level> - 'stderr';; log to standard error, parameters <level> + 'stderr';; log to standard error, parameters <level> *-U, --debug*:: - This option instructs *Anytun* to run in debug mode. It implicits *-D* + This option instructs *Anytun* to run in debug mode. It implicits *-D* (don't daemonize) and adds a log target with the configuration 'stdout:5' (logging with maximum level). In future releases there might be additional output when this option is supplied. @@ -144,7 +144,7 @@ passed to the daemon: This option is only needed for tunnel endpoints consisting of multiple anycast hosts. The unicast IP address of the anycast host can be used here. This is needed for - communication with the other anycast hosts. The default is to + communication with the other anycast hosts. The default is to not use a special inteface and just bind on all interfaces. However this is only the case if synchronisation is active see *--sync-port*. @@ -170,15 +170,15 @@ passed to the daemon: disabled and therefore this is empty. Mind that the port can be omitted in which case port 2323 is used. If you want to specify an ipv6 address and a port you have to use [ and ] to separate the address - from the port, eg.: [::1]:1234. If you want to use the default port + from the port, eg.: [::1]:1234. If you want to use the default port [ and ] can be omitted. *-X, --control-host '<hostname|ip>[:<port>]'*:: fetch the config from this host. The default is not to use a control - host and therefore this is empty. Mind that the port can be omitted + host and therefore this is empty. Mind that the port can be omitted in which case port 2323 is used. If you want to specify an ipv6 address and a port you have to use [ and ] to separate the address - from the port, eg.: [::1]:1234. If you want to use the default port + from the port, eg.: [::1]:1234. If you want to use the default port [ and ] can be omitted. *-d, --dev '<name>'*:: @@ -200,7 +200,7 @@ passed to the daemon: '<prefix>';; the prefix length of the network *-x, --post-up-script '<script>'*:: - This option instructs *Anytun* to run this script after the interface + This option instructs *Anytun* to run this script after the interface is created. By default no script will be executed. *-R, --route '<net>/<prefix length>'*:: @@ -231,7 +231,7 @@ passed to the daemon: *-k, --kd--prf '<kd-prf type>'*:: key derivation pseudo random function + - The pseudo random function which is used for calculating the + The pseudo random function which is used for calculating the session keys and session salt. + Possible values: @@ -244,16 +244,16 @@ passed to the daemon: *-e, --role '<role>'*:: SATP uses different session keys for inbound and outbound traffic. The role parameter is used to determine which keys to use for outbound or - inbound packets. On both sides of a vpn connection different roles have - to be used. Possible values are 'left' and 'right'. You may also use - 'alice' or 'server' as a replacement for 'left' and 'bob' or 'client' as + inbound packets. On both sides of a vpn connection different roles have + to be used. Possible values are 'left' and 'right'. You may also use + 'alice' or 'server' as a replacement for 'left' and 'bob' or 'client' as a replacement for 'right'. By default 'left' is used. *-E, --passphrase '<passphrase>'*:: This passphrase is used to generate the master key and master salt. - For the master key the last n bits of the SHA256 digest of the - passphrase (where n is the length of the master key in bits) is used. - The master salt gets generated with the SHA1 digest. + For the master key the last n bits of the SHA256 digest of the + passphrase (where n is the length of the master key in bits) is used. + The master salt gets generated with the SHA1 digest. You may force a specific key and or salt by using *--key* and *--salt*. *-K, --key '<master key>'*:: @@ -282,7 +282,7 @@ passed to the daemon: *-a, --auth-algo '<algo type>'*:: message authentication algorithm + This option sets the message authentication algorithm. + - If HMAC-SHA1 is used, the packet length is increased. The additional bytes + If HMAC-SHA1 is used, the packet length is increased. The additional bytes contain the authentication data. see *--auth-tag-length* for more info. + Possible values: @@ -290,8 +290,8 @@ passed to the daemon: 'sha1';; HMAC-SHA1, default value *-b, --auth-tag-length '<length>'*:: - The number of bytes to use for the auth tag. This value defaults to 10 bytes - unless the 'null' auth algo is used in which case it defaults to 0. + The number of bytes to use for the auth tag. This value defaults to 10 bytes + unless the 'null' auth algo is used in which case it defaults to 0. EXAMPLES @@ -314,7 +314,7 @@ anytun -r hosta.example.com -t tun -n 192.168.123.2/30 -c aes-ctr-256 -k aes-ctr One unicast and one anycast tunnel endpoint: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - + Unicast tunnel endpoint: ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -323,7 +323,7 @@ anytun -r anycast.anytun.org -d anytun0 -t tun -n 192.0.2.2/30 -a null -c null - Anycast tunnel endpoints: ^^^^^^^^^^^^^^^^^^^^^^^^^ -On the host with unicast hostname unicast1.anycast.anytun.org and anycast +On the host with unicast hostname unicast1.anycast.anytun.org and anycast hostname anycast.anytun.org: ------------------------------------------------------------------------------------------------- # anytun -i anycast.anytun.org -d anytun0 -t tun -n 192.0.2.1/30 -a null -c null -w 0 -e server \ @@ -374,8 +374,8 @@ Main web site: http://www.anytun.org/ COPYING ------- -Copyright \(C) 2007-2009 Othmar Gsenger, Erwin Nindl and Christian -Pointner. This program is free software: you can redistribute it -and/or modify it under the terms of the GNU General Public License -as published by the Free Software Foundation, either version 3 of -the License, or any later version. +Copyright \(C) 2007-2014 Markus Grüneis, Othmar Gsenger, Erwin Nindl +and Christian Pointner. This program is free software: you can +redistribute it and/or modify it under the terms of the GNU General +Public License as published by the Free Software Foundation, either +version 3 of the License, or any later version. |