3 .\" Author: [see the "AUTHORS" section]
4 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
10 .TH "ANYTUN" "8" "12/30/2011" "\ \&" "\ \&"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
25 .\" disable justification (adjust text to left margin only)
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 anytun \- anycast tunneling daemon
36 [ \fB\-h|\-\-help\fR ]
37 [ \fB\-D|\-\-nodaemonize\fR ]
38 [ \fB\-u|\-\-username\fR <username> ]
39 [ \fB\-g|\-\-groupname\fR <groupname> ]
40 [ \fB\-C|\-\-chroot\fR <path> ]
41 [ \fB\-P|\-\-write\-pid\fR <filename> ]
42 [ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]] ]
43 [ \fB\-U|\-\-debug\fR ]
44 [ \fB\-i|\-\-interface\fR <ip\-address> ]
45 [ \fB\-p|\-\-port\fR <port> ]
46 [ \fB\-r|\-\-remote\-host\fR <hostname|ip> ]
47 [ \fB\-o|\-\-remote\-port\fR <port> ]
48 [ \fB\-4|\-\-ipv4\-only\fR ]
49 [ \fB\-6|\-\-ipv6\-only\fR ]
50 [ \fB\-I|\-\-sync\-interface\fR <ip\-address> ]
51 [ \fB\-S|\-\-sync\-port\fR port> ]
52 [ \fB\-M|\-\-sync\-hosts\fR <hostname|ip>[:<port>][,<hostname|ip>[:<port>][\&.\&.\&.]] ]
53 [ \fB\-X|\-\-control\-host\fR <hostname|ip>[:<port>]
54 [ \fB\-d|\-\-dev\fR <name> ]
55 [ \fB\-t|\-\-type\fR <tun|tap> ]
56 [ \fB\-n|\-\-ifconfig\fR <local>/<prefix> ]
57 [ \fB\-x|\-\-post\-up\-script\fR <script> ]
58 [ \fB\-R|\-\-route\fR <net>/<prefix length> ]
59 [ \fB\-m|\-\-mux\fR <mux\-id> ]
60 [ \fB\-s|\-\-sender\-id\fR <sender id> ]
61 [ \fB\-w|\-\-window\-size\fR <window size> ]
62 [ \fB\-k|\-\-kd\-prf\fR <kd\-prf type> ]
63 [ \fB\-e|\-\-role\fR <role> ]
64 [ \fB\-E|\-\-passphrase\fR <pass phrase> ]
65 [ \fB\-K|\-\-key\fR <master key> ]
66 [ \fB\-A|\-\-salt\fR <master salt> ]
67 [ \fB\-c|\-\-cipher\fR <cipher type> ]
68 [ \fB\-a|\-\-auth\-algo\fR <algo type> ]
69 [ \fB\-b|\-\-auth\-tag\-length\fR <length> ]
73 \fBAnytun\fR is an implementation of the Secure Anycast Tunneling Protocol (SATP)\&. It provides a complete VPN solution similar to OpenVPN or IPsec in tunnel mode\&. The main difference is that anycast allows a setup of tunnels between an arbitrary combination of anycast, unicast and multicast hosts\&.
76 \fBAnytun\fR has been designed as a peer to peer application, so there is no difference between client and server\&. The following options can be passed to the daemon:
78 \fB\-D, \-\-nodaemonize\fR
82 to run in foreground instead of becoming a daemon which is the default\&.
85 \fB\-u, \-\-username \fR\fB\fI<username>\fR\fR
87 run as this user\&. If no group is specified (\fB\-g\fR) the default group of the user is used\&. The default is to not drop privileges\&.
90 \fB\-g, \-\-groupname \fR\fB\fI<groupname>\fR\fR
92 run as this group\&. If no username is specified (\fB\-u\fR) this gets ignored\&. The default is to not drop privileges\&.
95 \fB\-C, \-\-chroot \fR\fB\fI<path>\fR\fR
99 to run in a chroot jail\&. The default is to not run in chroot\&.
102 \fB\-P, \-\-write\-pid \fR\fB\fI<filename>\fR\fR
106 to write it\(cqs pid to this file\&. The default is to not create a pid file\&.
109 \fB\-L, \-\-log \fR\fB\fI<target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR\fR
111 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\&.
113 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 config
114 \fIsyslog:3,anytun,daemon\fR
117 The following targets are supported:
121 log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
126 log to file, parameters <level>[,<path>]
131 log to standard output, parameters <level>
136 log to standard error, parameters <level>
142 This option instructs
144 to run in debug mode\&. It implicits
146 (don\(cqt daemonize) and adds a log target with the configuration
148 (logging with maximum level)\&. In future releases there might be additional output when this option is supplied\&.
151 \fB\-i, \-\-interface \fR\fB\fI<ip address>\fR\fR
153 This IP address is used as the sender address for outgoing packets\&. In case of anycast tunnel endpoints, the anycast IP has to be used\&. In case of unicast endpoints, the address is usually derived correctly from the routing table\&. The default is to not use a special inteface and just bind on all interfaces\&.
156 \fB\-p, \-\-port \fR\fB\fI<port>\fR\fR
158 The local UDP port that is used to send and receive the payload data\&. The two tunnel endpoints can use different ports\&. If a tunnel endpoint consists of multiple anycast hosts, all hosts have to use the same port\&. default: 4444
161 \fB\-r, \-\-remote\-host \fR\fB\fI<hostname|ip>\fR\fR
163 This option can be used to specify the remote tunnel endpoint\&. In case of anycast tunnel endpoints, the anycast IP address has to be used\&. If you do not specify an address, it is automatically determined after receiving the first data packet\&.
166 \fB\-o, \-\-remote\-port \fR\fB\fI<port>\fR\fR
168 The UDP port used for payload data by the remote host (specified with \-p on the remote host)\&. If you do not specify a port, it is automatically determined after receiving the first data packet\&.
171 \fB\-4, \-\-ipv4\-only\fR
173 Resolv to IPv4 addresses only\&. The default is to resolv both IPv4 and IPv6 addresses\&.
176 \fB\-6, \-\-ipv6\-only\fR
178 Resolv to IPv6 addresses only\&. The default is to resolv both IPv4 and IPv6 addresses\&.
181 \fB\-I, \-\-sync\-interface \fR\fB\fI<ip\-address>\fR\fR
183 local unicast(sync) ip address to bind to
185 This option is only needed for tunnel endpoints consisting of multiple anycast hosts\&. The unicast IP address of the anycast host can be used here\&. This is needed for communication with the other anycast hosts\&. The default is to not use a special inteface and just bind on all interfaces\&. However this is only the case if synchronisation is active see
186 \fB\-\-sync\-port\fR\&.
189 \fB\-S, \-\-sync\-port \fR\fB\fI<port>\fR\fR
191 local unicast(sync) port to bind to
193 This option is only needed for tunnel endpoints consisting of multiple anycast hosts\&. This port is used by anycast hosts to synchronize information about tunnel endpoints\&. No payload data is transmitted via this port\&. By default the synchronisation is disabled an therefore the port is kept empty\&.
195 It is possible to obtain a list of active connections by telnetting into this port\&. This port is read\-only and unprotected by default\&. It is advised to protect this port using firewall rules and, eventually, IPsec\&.
198 \fB\-M, \-\-sync\-hosts \fR\fB\fI<hostname|ip>[:<port>],[<hostname|ip>[:<port>][\&...]]\fR\fR
200 remote hosts to sync with
202 This option is only needed for tunnel endpoints consisting of multiple anycast hosts\&. Here, one has to specify all unicast IP addresses of all other anycast hosts that comprise the anycast tunnel endpoint\&. By default synchronisation is disabled and therefore this is empty\&. Mind that the port can be omitted in which case port 2323 is used\&. If you want to specify an ipv6 address and a port you have to use [ and ] to separate the address from the port, eg\&.: [::1]:1234\&. If you want to use the default port [ and ] can be omitted\&.
205 \fB\-X, \-\-control\-host \fR\fB\fI<hostname|ip>[:<port>]\fR\fR
207 fetch the config from this host\&. The default is not to use a control host and therefore this is empty\&. Mind that the port can be omitted in which case port 2323 is used\&. If you want to specify an ipv6 address and a port you have to use [ and ] to separate the address from the port, eg\&.: [::1]:1234\&. If you want to use the default port [ and ] can be omitted\&.
210 \fB\-d, \-\-dev \fR\fB\fI<name>\fR\fR
214 By default, tapN is used for Ethernet tunnel interfaces, and tunN for IP tunnels, respectively\&. This option can be used to manually override these defaults\&.
217 \fB\-t, \-\-type \fR\fB\fI<tun|tap>\fR\fR
221 Type of the tunnels to create\&. Use tap for Ethernet tunnels, tun for IP tunnels\&.
224 \fB\-n, \-\-ifconfig \fR\fB\fI<local>/<prefix>\fR\fR
226 The local IP address and prefix length\&. The remote tunnel endpoint has to use a different IP address in the same subnet\&.
230 the local IP address for the tun/tap device
235 the prefix length of the network
239 \fB\-x, \-\-post\-up\-script \fR\fB\fI<script>\fR\fR
241 This option instructs
243 to run this script after the interface is created\&. By default no script will be executed\&.
246 \fB\-R, \-\-route \fR\fB\fI<net>/<prefix length>\fR\fR
248 add a route to connection\&. This can be invoked several times\&.
251 \fB\-m, \-\-mux \fR\fB\fI<mux\-id>\fR\fR
253 the multiplex id to use\&. default: 0
256 \fB\-s, \-\-sender\-id \fR\fB\fI<sender id>\fR\fR
258 Each anycast tunnel endpoint needs a uniqe sender id (1, 2, 3, \&...)\&. It is needed to distinguish the senders in case of replay attacks\&. This option can be ignored on unicast endpoints\&. default: 0
261 \fB\-w, \-\-window\-size \fR\fB\fI<window size>\fR\fR
265 Sometimes, packets arrive out of order on the receiver side\&. This option defines the size of a list of received packets\*(Aq sequence numbers\&. If, according to this list, a received packet has been previously received or has been transmitted in the past, and is therefore not in the list anymore, this is interpreted as a replay attack and the packet is dropped\&. A value of 0 deactivates this list and, as a consequence, the replay protection employed by filtering packets according to their secuence number\&. By default the sequence window is disabled and therefore a window size of 0 is used\&.
268 \fB\-k, \-\-kd\(emprf \fR\fB\fI<kd\-prf type>\fR\fR
270 key derivation pseudo random function
272 The pseudo random function which is used for calculating the session keys and session salt\&.
278 no random function, keys and salt are set to 0\&.\&.00
283 AES in counter mode with 128 Bits, default value
288 AES in counter mode with 128 Bits
293 AES in counter mode with 192 Bits
298 AES in counter mode with 256 Bits
302 \fB\-e, \-\-role \fR\fB\fI<role>\fR\fR
304 SATP uses different session keys for inbound and outbound traffic\&. The role parameter is used to determine which keys to use for outbound or inbound packets\&. On both sides of a vpn connection different roles have to be used\&. Possible values are
307 \fIright\fR\&. You may also use
318 \fIright\fR\&. By default
323 \fB\-E, \-\-passphrase \fR\fB\fI<passphrase>\fR\fR
325 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
331 \fB\-K, \-\-key \fR\fB\fI<master key>\fR\fR
333 master key to use for key derivation
335 Master key in hexadecimal notation, e\&.g\&. 01a2b3c4d5e6f708a9b0cadbecfd0fa1, with a mandatory length of 32, 48 or 64 characters (128, 192 or 256 bits)\&.
338 \fB\-A, \-\-salt \fR\fB\fI<master salt>\fR\fR
340 master salt to use for key derivation
342 Master salt in hexadecimal notation, e\&.g\&. 01a2b3c4d5e6f708a9b0cadbecfd, with a mandatory length of 28 characters (14 bytes)\&.
345 \fB\-c, \-\-cipher \fR\fB\fI<cipher type>\fR\fR
347 payload encryption algorithm
349 Encryption algorithm used for encrypting the payload
360 AES in counter mode with 128 Bits, default value
365 AES in counter mode with 128 Bits
370 AES in counter mode with 192 Bits
375 AES in counter mode with 256 Bits
379 \fB\-a, \-\-auth\-algo \fR\fB\fI<algo type>\fR\fR
381 message authentication algorithm
383 This option sets the message authentication algorithm\&.
385 If HMAC\-SHA1 is used, the packet length is increased\&. The additional bytes contain the authentication data\&. see
386 \fB\-\-auth\-tag\-length\fR
393 no message authentication
398 HMAC\-SHA1, default value
402 \fB\-b, \-\-auth\-tag\-length \fR\fB\fI<length>\fR\fR
404 The number of bytes to use for the auth tag\&. This value defaults to 10 bytes unless the
406 auth algo is used in which case it defaults to 0\&.
409 .SS "P2P Setup between two unicast enpoints:"
412 .nr an-no-space-flag 1
419 anytun \-r hostb\&.example\&.com \-t tun \-n 192\&.168\&.123\&.1/30 \-c aes\-ctr\-256 \-k aes\-ctr\-256 \e \-E have_a_very_safe_and_productive_day \-e left
423 .nr an-no-space-flag 1
430 anytun \-r hosta\&.example\&.com \-t tun \-n 192\&.168\&.123\&.2/30 \-c aes\-ctr\-256 \-k aes\-ctr\-256 \e \-E have_a_very_safe_and_productive_day \-e right
432 .SS "One unicast and one anycast tunnel endpoint:"
435 .nr an-no-space-flag 1
439 \fBUnicast tunnel endpoint:\fR
442 anytun \-r anycast\&.anytun\&.org \-d anytun0 \-t tun \-n 192\&.0\&.2\&.2/30 \-a null \-c null \-w 0 \-e client
446 .nr an-no-space-flag 1
450 \fBAnycast tunnel endpoints:\fR
453 On the host with unicast hostname unicast1\&.anycast\&.anytun\&.org and anycast hostname anycast\&.anytun\&.org:
459 # anytun \-i anycast\&.anytun\&.org \-d anytun0 \-t tun \-n 192\&.0\&.2\&.1/30 \-a null \-c null \-w 0 \-e server \e
460 \-S 2342 \-M unicast2\&.anycast\&.anytun\&.org:2342,unicast3\&.anycast\&.anytun\&.org:2342
466 On the host with unicast hostname unicast2\&.anycast\&.anytun\&.org and anycast hostname anycast\&.anytun\&.org:
472 # anytun \-i anycast\&.anytun\&.org \-d anytun0 \-t tun \-n 192\&.0\&.2\&.1/30 \-a null \-c null \-w 0 \-e server \e
473 \-S 2342 \-M unicast1\&.anycast\&.anytun\&.org:2342,unicast3\&.anycast\&.anytun\&.org:2342
479 On the host with unicast hostname unicast3\&.anycast\&.anytun\&.org and anycast hostname anycast\&.anytun\&.org:
485 # anytun \-i anycast\&.anytun\&.org \-d anytun0 \-t tun \-n 192\&.0\&.2\&.1/30 \-a null \-c null \-w 0 \-e server \e
486 \-S 2342 \-M unicast1\&.anycast\&.anytun\&.org:2342,unicast2\&.anycast\&.anytun\&.org:2342
492 For more sophisticated examples (like multiple unicast endpoints to one anycast tunnel endpoint) please consult the man page of anytun\-config(8)\&.
496 Most likely there are some bugs in \fBAnytun\fR\&. If you find a bug, please let the developers know at satp@anytun\&.org\&. Of course, patches are preferred\&.
499 anytun\-config(8), anytun\-controld(8), anytun\-showtables(8)
502 Othmar Gsenger <otti@anytun\&.org> Erwin Nindl <nine@anytun\&.org> Christian Pointner <equinox@anytun\&.org>
505 Main web site: http://www\&.anytun\&.org/
508 Copyright (C) 2007\-2009 Othmar Gsenger, Erwin Nindl and Christian Pointner\&. This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version\&.