src/man/anytun-config.8.txt

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