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 *anytun-config*
  12 [ *-h|--help* ]
  13 [ *-r|--remote-host* <hostname|ip> ]
  14 [ *-o|--remote-port* <port> ]
  15 [ *-w|--window-size* <window size> ]
  16 [ *-m|--mux* <mux-id> ]
  17 [ *-K|--key* <master key> ]
  18 [ *-A|--salt* <master salt> ]
  19 [ *-R|--route* <net>/<prefix length> ]
  20
  21 DESCRIPTION
  22 -----------
  23
  24 Anytun is an implementation of the Secure Anycast Tunneling Protocol
  25 (SATP). Anycast provides a complete VPN solution similar to OpenVPN or
  26 IPsec in tunnel mode. The main difference is that anycast enables the
  27 setup of tunnels between an arbitrary combination of anycast, unicast
  28 and multicast hosts.
  29
  30 OPTIONS
  31 -------
  32
  33 Anytun has been designed as a peer to peer application, so there is
  34 no difference between client and server. The following options can be
  35 passed to the daemon:
  36
  37 -r|--remote-host <hostname|ip>
  38 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  39
  40 remote host
  41
  42 This option can be used to specify the remote tunnel
  43 endpoint. In case of anycast tunnel endpoints, the
  44 anycast IP address has to be used. If you do not specify
  45 an address, it is automatically determined after receiving
  46 the first data packet.
  47
  48 -o|--remote-port <port>
  49 ~~~~~~~~~~~~~~~~~~~~~~~
  50 remote port
  51
  52 The UDP port used for payload data by the remote host
  53 (specified with -p on the remote host).
  54
  55 -w|--window-size <window size>
  56 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  57
  58 seqence window size
  59
  60 Sometimes, packets arrive out of order on the receiver
  61 side. This option defines the size of a list of received
  62 packets' sequence numbers. If, according to this list,
  63 a received packet has been previously received or has
  64 been transmitted in the past, and is therefore not in
  65 the list anymore, this is interpreted as a replay attack
  66 and the packet is dropped. A value of 0 deactivates this
  67 list and, as a consequence, the replay protection employed
  68 by filtering packets according to their secuence number.
  69
  70 -m|--mux <mux-id>
  71 ~~~~~~~~~~~~~~~~~
  72
  73 the multiplex id to use
  74
  75 -K|--key <master key>
  76 ~~~~~~~~~~~~~~~~~~~~~
  77
  78 master key to use for encryption
  79
  80 Master key in hexadecimal notation, eg
  81 01a2b3c4d5e6f708a9b0cadbecfd0fa1, with a mandatory length
  82 of 32 characters (16 bytes).
  83
  84 -A|--salt <master salt>
  85 ~~~~~~~~~~~~~~~~~~~~~~~
  86
  87 master salt to use for encryption
  88
  89 Master salt in hexadecimal notation, eg
  90 01a2b3c4d5e6f708a9b0cadbecfd, with a mandatory length
  91 of 28 characters (14 bytes).
  92
  93 -R|--route <net>/<prefix length>
  94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  95
  96 add a route to connection, can be invoked several times
  97
  98
  99 EXAMPLES
 100 --------
 101
 102 Add a client with Connection ID (Mux) 12 and add 2 Routes to this client
 103
 104 --------------------------------------------------------------------------------------
 105 # anytun -w 0 -m 12 -K 0123456789ABCDEFFEDCBA9876543210 -A 0123456789ABCDDCBA9876543210 \
 106          -R 192.0.2.0/24 -R 192.168.1.1/32
 107 --------------------------------------------------------------------------------------
 108
 109
 110 BUGS
 111 ----
 112 Most likely there are some bugs in anytun. If you find a bug, please let
 113 the developers know at satp@anytun.org. Of course, patches are preferred.
 114
 115 SEE ALSO
 116 --------
 117 anytun(8), anytun-controld(8), anytun-showtables(8)
 118
 119 AUTHORS
 120 -------
 121 Design of SATP and wizards of this implementation:
 122
 123 Othmar Gsenger <otti@anytun.org>
 124 Erwin Nindl <nine@anytun.org>
 125 Christian Pointner <equinox@anytun.org>
 126
 127 Debian packaging:
 128
 129 Andreas Hirczy <ahi@itp.tu-graz.ac.at>
 130
 131 Manual page:
 132
 133 Alexander List <alex@debian.org>
 134
 135 RESOURCES
 136 ---------
 137
 138 Main web site: http://www.anytun.org/
 139
 140
 141 COPYING
 142 -------
 143
 144 Copyright \(C) 2007-2008 Othmar Gsenger, Erwin Nindl and Christian
 145 Pointner. This  program  is  free software;  you  can redistribute
 146 it and/or modify it under the terms of the GNU General Public License
 147 version 2 as published by the Free Software Foundation.
 148