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