doc/anytun-config.8.txt

   1 anytun-config(8)
   2 ================
   3
   4 NAME
   5 ----
   6
   7 anytun-config - anycast tunneling configuration utility
   8
   9 SYNOPSIS
  10 --------
  11
  12 ....
  13 anytun-config
  14   [ -h|--help ]
  15   [ -L|--log <target>:<level>[,<param1>[,<param2>[..]]]
  16   [ -U|--debug ]
  17   [ -r|--remote-host <hostname|ip> ]
  18   [ -o|--remote-port <port> ]
  19   [ -4|--ipv4-only ]
  20   [ -6|--ipv6-only ]
  21   [ -R|--route <net>/<prefix length> ]
  22   [ -m|--mux <mux-id> ]
  23   [ -w|--window-size <window size> ]
  24   [ -k|--kd-prf <kd-prf type> ]
  25   [ -e|--role <role> ]
  26   [ -E|--passphrase <pass phrase> ]
  27   [ -K|--key <master key> ]
  28   [ -A|--salt <master salt> ]
  29 ....
  30
  31 DESCRIPTION
  32 -----------
  33
  34 *anytun-config* writes routing/connection table entries, that can be read by *anytun-controld*.
  35
  36 OPTIONS
  37 -------
  38
  39 *-L, --log '<target>:<level>[,<param1>[,<param2>[..]]]'*::
  40    add log target to logging system. This can be invoked several times
  41    in order to log to different targets at the same time. Every target
  42    hast its own log level which is a number between 0 and 5. Where 0 means
  43    disabling log and 5 means debug messages are enabled. +
  44    The file target can be used more the once with different levels.
  45    If no target is provided at the command line a single target with the
  46    config 'syslog:3,anytun-config,daemon' is added. +
  47    The following targets are supported:
  48
  49    'syslog';; log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
  50    'file';; log to file, parameters <level>[,<path>]
  51    'stdout';; log to standard output, parameters <level>
  52    'stderr';; log to standard error, parameters <level>
  53
  54 *-U, --debug*::
  55    This option instructs *Anytun* to run in debug mode. It implicits *-D*
  56    (don't daemonize) and adds a log target with the configuration
  57    'stdout:5' (logging with maximum level). In future releases there might
  58    be additional output when this option is supplied.
  59
  60 *-r, --remote-host '<hostname|ip>'*::
  61    This option can be used to specify the remote tunnel
  62    endpoint. In case of anycast tunnel endpoints, the
  63    anycast IP address has to be used. If you do not specify
  64    an address, it is automatically determined after receiving
  65    the first data packet.
  66
  67 *-o, --remote-port '<port>'*::
  68    The UDP port used for payload data by the remote host
  69    (specified with -p on the remote host). If you do not specify
  70    a port, it is automatically determined after receiving
  71    the first data packet.
  72
  73 *-4, --ipv4-only*::
  74    Resolv to IPv4 addresses only. The default is to resolv both
  75    IPv4 and IPv6 addresses.
  76
  77 *-6, --ipv6-only*::
  78    Resolv to IPv6 addresses only. The default is to resolv both
  79    IPv4 and IPv6 addresses.
  80
  81 *-R, --route '<net>/<prefix length>'*::
  82    add a route to connection. This can be invoked several times.
  83
  84 *-m, --mux '<mux-id>'*::
  85    the multiplex id to use. default: 0
  86
  87 *-w, --window-size '<window size>'*::
  88    seqence window size +
  89    Sometimes, packets arrive out of order on the receiver
  90    side. This option defines the size of a list of received
  91    packets' sequence numbers. If, according to this list,
  92    a received packet has been previously received or has
  93    been transmitted in the past, and is therefore not in
  94    the list anymore, this is interpreted as a replay attack
  95    and the packet is dropped. A value of 0 deactivates this
  96    list and, as a consequence, the replay protection employed
  97    by filtering packets according to their secuence number.
  98    By default the sequence window is disabled and therefore a
  99    window size of 0 is used.
 100
 101 *-k, --kd--prf '<kd-prf type>'*::
 102    key derivation pseudo random function +
 103    The pseudo random function which is used for calculating the
 104    session keys and session salt. +
 105    Possible values:
 106
 107    'null';; no random function, keys and salt are set to 0..00
 108    'aes-ctr';; AES in counter mode with 128 Bits, default value
 109    'aes-ctr-128';; AES in counter mode with 128 Bits
 110    'aes-ctr-192';; AES in counter mode with 192 Bits
 111    'aes-ctr-256';; AES in counter mode with 256 Bits
 112
 113 *-e, --role '<role>'*::
 114    SATP uses different session keys for inbound and outbound traffic. The
 115    role parameter is used to determine which keys to use for outbound or
 116    inbound packets. On both sides of a vpn connection different roles have
 117    to be used. Possible values are *left* and *right*. You may also use
 118    *alice* or *server* as a replacement for *left* and *bob* or *client* as
 119    a replacement for *right*. By default *left* is used.
 120
 121 *-E, --passphrase '<pass phrase>'*::
 122    This passphrase is used to generate the master key and master salt.
 123    For the master key the last n bits of the SHA256 digest of the
 124    passphrase (where n is the length of the master key in bits) is used.
 125    The master salt gets generated with the SHA1 digest.
 126    You may force a specific key and or salt by using *--key* and *--salt*.
 127
 128 *-K, --key '<master key>'*::
 129    master key to use for key derivation +
 130    Master key in hexadecimal notation, e.g.
 131    01a2b3c4d5e6f708a9b0cadbecfd0fa1, with a mandatory length
 132    of 32, 48 or 64 characters (128, 192 or 256 bits).
 133
 134 *-A, --salt '<master salt>'*::
 135    master salt to use for key derivation +
 136    Master salt in hexadecimal notation, e.g.
 137    01a2b3c4d5e6f708a9b0cadbecfd, with a mandatory length
 138    of 28 characters (14 bytes).
 139
 140
 141 EXAMPLES
 142 --------
 143
 144 Add a client with Connection ID (Mux) 12 and add 2 Routes to this client
 145
 146 ------------------------------------------------------------------------------------------------
 147 # anytun-config -w 0 -m 12 -K 0123456789ABCDEFFEDCBA9876543210 -A 0123456789ABCDDCBA9876543210 \
 148                 -R 192.0.2.0/24 -R 192.168.1.1/32 -e server >> routingtable
 149 ------------------------------------------------------------------------------------------------
 150
 151 BUGS
 152 ----
 153 Most likely there are some bugs in *Anytun*. If you find a bug, please let
 154 the developers know at satp@anytun.org. Of course, patches are preferred.
 155
 156 SEE ALSO
 157 --------
 158 anytun(8), anytun-controld(8), anytun-showtables(8)
 159
 160 AUTHORS
 161 -------
 162
 163 Othmar Gsenger <otti@anytun.org>
 164 Erwin Nindl <nine@anytun.org>
 165 Christian Pointner <equinox@anytun.org>
 166
 167
 168 RESOURCES
 169 ---------
 170
 171 Main web site: http://www.anytun.org/
 172
 173
 174 COPYING
 175 -------
 176
 177 Copyright \(C) 2007-2009 Othmar Gsenger, Erwin Nindl and Christian
 178 Pointner. This  program is  free software: you can redistribute it
 179 and/or modify it under the terms of the GNU General Public License
 180 as published by the Free Software Foundation, either version 3 of
 181 the License, or any later version.