From 6fa4295768f930a6d1c4a6077a34e7db36dff14e Mon Sep 17 00:00:00 2001 From: Christian Pointner Date: Sat, 28 Feb 2009 09:10:03 +0000 Subject: updated manpages --- src/man/anytun-config.8.txt | 117 +++++++++++++++++--- src/man/anytun-controld.8.txt | 92 ++++++++++------ src/man/anytun-showtables.8.txt | 2 +- src/man/anytun.8.txt | 237 +++++++++++++++++++++++++--------------- 4 files changed, 306 insertions(+), 142 deletions(-) (limited to 'src/man') diff --git a/src/man/anytun-config.8.txt b/src/man/anytun-config.8.txt index 258bec8..b1e31a3 100644 --- a/src/man/anytun-config.8.txt +++ b/src/man/anytun-config.8.txt @@ -10,13 +10,20 @@ SYNOPSIS *anytun-config* [ *-h|--help* ] +[ *-L|--log* :[,[,[..]]] [ *-r|--remote-host* ] [ *-o|--remote-port* ] -[ *-w|--window-size* ] +[ *-4|--ipv4-only* ] +[ *-6|--ipv6-only* ] +[ *-R|--route* / ] [ *-m|--mux* ] +[ *-w|--window-size* ] +[ *-k|--kd-prf* ] +[ *-l|--ld-kdr* ] +[ *-O|--anytun02-compat* ] +[ *-E|--passphrase* ] [ *-K|--key* ] [ *-A|--salt* ] -[ *-T|--route* / ] DESCRIPTION ----------- @@ -26,6 +33,27 @@ DESCRIPTION OPTIONS ------- +-L|--log :[,[,[..]]] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +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 +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 following targets are supported: + +* *syslog* - log to syslog daemon, parameters [,[,]] +* *file* - log to file, parameters [,] +* *stdout* - log to standard output, parameters +* *stderr* - log to standard error, parameters + +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 +following config is added: + +*syslog:3,uanytun,daemon* + -r|--remote-host ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -46,6 +74,28 @@ The UDP port used for payload data by the remote host a port, it is automatically determined after receiving the first data packet. +-4|--ipv4-only +~~~~~~~~~~~~~~ + +Resolv to IPv4 addresses only. The default is to resolv both +IPv4 and IPv6 addresses. + +-6|--ipv6-only +~~~~~~~~~~~~~~ + +Resolv to IPv6 addresses only. The default is to resolv both +IPv4 and IPv6 addresses. + +-R|--route / +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +add a route to connection. This can be invoked several times. + +-m|--mux +~~~~~~~~~~~~~~~~~ + +the multiplex id to use. default: 0 + -w|--window-size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -63,45 +113,76 @@ by filtering packets according to their secuence number. By default the sequence window is disabled and therefore a window size of 0 is used. --m|--mux -~~~~~~~~~~~~~~~~~ +-k|--kd--prf +~~~~~~~~~~~~~~~~~~~~~~~~~~ -the multiplex id to use. default: 0 +key derivation pseudo random function. + +The pseudo random function which is used for calculating the +session keys and session salt. + +Possible values: + +* *null* - no random function, keys and salt are set to 0..00 +* *aes-ctr* - AES in counter mode with 128 Bits, default value +* *aes-ctr-128* - AES in counter mode with 128 Bits +* *aes-ctr-192* - AES in counter mode with 192 Bits +* *aes-ctr-256* - AES in counter mode with 256 Bits + +-l|--ld-kdr +~~~~~~~~~~~~~~~~~~~~ + +The log2 of the key derivation rate. This is used by the key +derivation to determine how often a new session key has to be +generated. A value of -1 means to generate only one key and use +it forever. The default is 0 which means to calculate a new key +for every packet. A value of 1 would tell the key derivation +to generate a new key after 2 packets, for 2 its 4 packets and +so on. + +-O|--anytun02-compat +~~~~~~~~~~~~~~~~~~~~ + +Enable compatibility mode with version of anytun 0.2.x and prior. +This is for backwards compaitbility to old internet draft of satp. + +-E|--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. +You may force a specific key and or salt by using *--key* and *--salt*. -K|--key ~~~~~~~~~~~~~~~~~~~~~ -master key to use for encryption +master key to use for key derivation Master key in hexadecimal notation, eg 01a2b3c4d5e6f708a9b0cadbecfd0fa1, with a mandatory length -of 32 characters (16 bytes). +of 32, 48 or 64 characters (128, 192 or 256 bits). -A|--salt ~~~~~~~~~~~~~~~~~~~~~~~ -master salt to use for encryption +master salt to use for key derivation Master salt in hexadecimal notation, eg 01a2b3c4d5e6f708a9b0cadbecfd, with a mandatory length of 28 characters (14 bytes). --T|--route / -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -add a route to connection. This can be invoked several times. - EXAMPLES -------- Add a client with Connection ID (Mux) 12 and add 2 Routes to this client - --------------------------------------------------------------------------------------- -# anytun -w 0 -m 12 -K 0123456789ABCDEFFEDCBA9876543210 -A 0123456789ABCDDCBA9876543210 \ - -R 192.0.2.0/24 -R 192.168.1.1/32 >> routingtable --------------------------------------------------------------------------------------- +------------------------------------------------------------------------------------------------ +# anytun-config -w 0 -m 12 -K 0123456789ABCDEFFEDCBA9876543210 -A 0123456789ABCDDCBA9876543210 \ + -R 192.0.2.0/24 -R 192.168.1.1/32 >> routingtable +------------------------------------------------------------------------------------------------ BUGS ---- diff --git a/src/man/anytun-controld.8.txt b/src/man/anytun-controld.8.txt index e97daac..2b1c7a1 100644 --- a/src/man/anytun-controld.8.txt +++ b/src/man/anytun-controld.8.txt @@ -10,13 +10,14 @@ SYNOPSIS *anytun-controld* [ *-h|--help* ] -[ *-f|--file* ] -[ *-X|--control-host* < [:port>] | : > ] [ *-D|--nodaemonize* ] -[ *-C|--chroot* ] [ *-u|--username* ] -[ *-H|--chroot-dir* ] -[ *-P|--write-pid* ] +[ *-g|--groupname* ] +[ *-C|--chroot* ] +[ *-P|--write-pid* ] +[ *-L|--log* :[,[,[..]]] ] +[ *-f|--file* ] +[ *-X|--control-host* < [:port>] | : > ] DESCRIPTION ----------- @@ -26,49 +27,72 @@ DESCRIPTION OPTIONS ------- --f|--file +-D|--nodaemonize ~~~~~~~~~~~~~~~~ -The path to the config file. +This option instructs *anytun* to run in foreground +instead of becoming a daemon which is the default. --X|--control-host < [:] | : > -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +-u|--username +~~~~~~~~~~~~~~~~~~~~~~~~ -The local ip address and or tcp port to bind to. Mind that if an -address is given the port can be omitted in which case port 2323 -is used. You can also specify to listen on an specific port but on -all interfaces by omitting the address. If you want to specify an -ipv6 address and a port you have to use [ and ] to seperate the address -from the port, eg.: [::1]:1234. If you want to use the default port -[ and ] can be omitted. default: 127.0.0.1:2323 +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. --D|--nodaemonize -~~~~~~~~~~~~~~~~ +-g|--groupname +~~~~~~~~~~~~~~~~~~~~~~~~~~ -This option instructs *anytun-controld* to run in the foreground -instead of becoming a daemon which is the default. +run as this group. If no username is specified (*-u*) this gets ignored. +The default is to not drop privileges. --C|--chroot -~~~~~~~~~~~ +-C|--chroot +~~~~~~~~~~~~~~~~~~ -Instruct *anytun* to run in a chroot chail and drop privileges. The -default is not to run in chroot. +Instruct *anytun* to run in a chroot jail. The default is +to not run in chroot. --u|--username -~~~~~~~~~~~~~~~~~~~~~~~~ +-P|--write-pid +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Instruct *anytun* to write it's pid to this file. The default is +to not create a pid file. + +-L|--log :[,[,[..]]] +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -if chroot change to this user. default: nobody +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 +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. --H|--chroot-dir -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The following targets are supported: + +* *syslog* - log to syslog daemon, parameters [,[,]] +* *file* - log to file, parameters [,] +* *stdout* - log to standard output, parameters +* *stderr* - log to standard error, parameters + +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 +following config is added: + +*syslog:3,uanytun,daemon* + +-f|--file +~~~~~~~~~~~~~~~~ -chroot to this directory. default: /var/run/anytun-controld +The path to the file which holds the sync information. --P|--write-pid -~~~~~~~~~~~~~~~~~~~~~ +-X|--control-host < [:] | : > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Instruct *anytun-controld* to write it's pid to this file. -The default is not to create a pid file. +The local ip address and or tcp port to bind to. Mind that if an +address is given the port can be omitted in which case port 2323 +is used. You can also specify to listen on an specific port but on +all interfaces by omitting the address. If you want to specify an +ipv6 address and a port you have to use [ and ] to seperate the address +from the port, eg.: [::1]:1234. If you want to use the default port +[ and ] can be omitted. default: 127.0.0.1:2323 BUGS diff --git a/src/man/anytun-showtables.8.txt b/src/man/anytun-showtables.8.txt index d7b1782..9a04f26 100644 --- a/src/man/anytun-showtables.8.txt +++ b/src/man/anytun-showtables.8.txt @@ -18,7 +18,7 @@ DESCRIPTION OPTIONS ------- -This Tool does not take any Options. It takes the sync information from +This Tool does not take any options. It takes the sync information from the standard input and prints the routing table to the standard output. EXAMPLES diff --git a/src/man/anytun.8.txt b/src/man/anytun.8.txt index 65f5c97..7890a50 100644 --- a/src/man/anytun.8.txt +++ b/src/man/anytun.8.txt @@ -11,21 +11,24 @@ SYNOPSIS *anytun* [ *-h|--help* ] [ *-D|--nodaemonize* ] -[ *-C|--chroot* ] [ *-u|--username* ] -[ *-H|--chroot-dir* ] +[ *-g|--groupname* ] +[ *-C|--chroot* ] [ *-P|--write-pid* ] +[ *-L|--log* :[,[,[..]]] ] [ *-i|--interface* ] [ *-p|--port* ] [ *-r|--remote-host* ] [ *-o|--remote-port* ] +[ *-4|--ipv4-only* ] +[ *-6|--ipv6-only* ] [ *-I|--sync-interface* ] [ *-S|--sync-port* port> ] [ *-M|--sync-hosts* [:][,[:][...]] ] [ *-X|--control-host* [:] [ *-d|--dev* ] [ *-t|--type* ] -[ *-n|--ifconfig* ] +[ *-n|--ifconfig* / ] [ *-x|--post-up-script*