3 .\" Author: [see the "AUTHORS" section]
4 .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
6 .\" Manual: uanytun user manual
7 .\" Source: uanytun 0.3.3
10 .TH "UANYTUN" "8" "02/17/2010" "uanytun 0.3.3" "uanytun user manual"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
16 .\" disable justification (adjust text to left margin only)
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
22 uanytun \- micro anycast tunneling daemon
27 [ \fB\-h|\-\-help\fR ]
28 [ \fB\-D|\-\-nodaemonize\fR ]
29 [ \fB\-u|\-\-username\fR <username> ]
30 [ \fB\-g|\-\-groupname\fR <groupname> ]
31 [ \fB\-C|\-\-chroot\fR <path> ]
32 [ \fB\-P|\-\-write\-pid\fR <filename> ]
33 [ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]] ]
34 [ \fB\-U|\-\-debug\fR ]
35 [ \fB\-i|\-\-interface\fR <ip\-address> ]
36 [ \fB\-p|\-\-port\fR <port> ]
37 [ \fB\-r|\-\-remote\-host\fR <hostname|ip> ]
38 [ \fB\-o|\-\-remote\-port\fR <port> ]
39 [ \fB\-4|\-\-ipv4\-only\fR ]
40 [ \fB\-6|\-\-ipv6\-only\fR ]
41 [ \fB\-d|\-\-dev\fR <name> ]
42 [ \fB\-t|\-\-type\fR <tun|tap> ]
43 [ \fB\-n|\-\-ifconfig\fR <local>/<prefix> ]
44 [ \fB\-x|\-\-post\-up\-script\fR <script> ]
45 [ \fB\-m|\-\-mux\fR <mux\-id> ]
46 [ \fB\-s|\-\-sender\-id\fR <sender id> ]
47 [ \fB\-w|\-\-window\-size\fR <window size> ]
48 [ \fB\-k|\-\-kd\-prf\fR <kd\-prf type> ]
49 [ \fB\-e|\-\-role\fR <role> ]
50 [ \fB\-E|\-\-passphrase\fR <pass phrase> ]
51 [ \fB\-K|\-\-key\fR <master key> ]
52 [ \fB\-A|\-\-salt\fR <master salt> ]
53 [ \fB\-c|\-\-cipher\fR <cipher type> ]
54 [ \fB\-a|\-\-auth\-algo\fR <algo type> ]
55 [ \fB\-b|\-\-auth\-tag\-length\fR <length> ]
59 \fBuAnytun\fR is a tiny 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 enables the setup of tunnels between an arbitrary combination of anycast, unicast and multicast hosts\&. Unlike Anytun which is a full featured implementation uAnytun has no support for multiple connections or synchronisation\&. It is a small single threaded implementation intended to act as a client on small platforms\&.
62 \fBuAnytun\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:
64 \fB\-D, \-\-nodaemonize\fR
68 to run in foreground instead of becoming a daemon which is the default\&.
71 \fB\-u, \-\-username \fR\fB\fI<username>\fR\fR
73 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\&.
76 \fB\-g, \-\-groupname \fR\fB\fI<groupname>\fR\fR
78 run as this group\&. If no username is specified (\fB\-u\fR) this gets ignored\&. The default is to not drop privileges\&.
81 \fB\-C, \-\-chroot \fR\fB\fI<path>\fR\fR
85 to run in a chroot jail\&. The default is to not run in chroot\&.
88 \fB\-P, \-\-write\-pid <filename>\fR
92 to write it\(cqs pid to this file\&. The default is to not create a pid file\&.
95 \fB\-L, \-\-log \fR\fB\fI<target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR\fR
97 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\&.
99 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
100 \fIsyslog:3,uanytun,daemon\fR
103 The following targets are supported:
107 log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
112 log to file, parameters <level>[,<path>]
117 log to standard output, parameters <level>
122 log to standard error, parameters <level>
128 This option instructs
130 to run in debug mode\&. It implicits
132 (don\(cqt daemonize) and adds a log target with the configuration
134 (logging with maximum level)\&. In future releases there might be additional output when this option is supplied\&.
137 \fB\-i, \-\-interface \fR\fB\fI<ip address>\fR\fR
139 This IP address is used as the sender address for outgoing packets\&. The default is to not use a special inteface and just bind on all interfaces\&.
142 \fB\-p, \-\-port \fR\fB\fI<port>\fR\fR
144 The local UDP port that is used to send and receive the payload data\&. The two tunnel endpoints can use different ports\&. default: 4444
147 \fB\-r, \-\-remote\-host \fR\fB\fI<hostname|ip>\fR\fR
149 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\&.
152 \fB\-o, \-\-remote\-port \fR\fB\fI<port>\fR\fR
154 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\&.
157 \fB\-4, \-\-ipv4\-only\fR
159 Resolv to IPv4 addresses only\&. The default is to resolv both IPv4 and IPv6 addresses\&.
162 \fB\-6, \-\-ipv6\-only\fR
164 Resolv to IPv6 addresses only\&. The default is to resolv both IPv4 and IPv6 addresses\&.
167 \fB\-d, \-\-dev \fR\fB\fI<name>\fR\fR
171 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\&.
174 \fB\-t, \-\-type \fR\fB\fI<tun|tap>\fR\fR
178 Type of the tunnels to create\&. Use tap for Ethernet tunnels, tun for IP tunnels\&.
181 \fB\-n, \-\-ifconfig \fR\fB\fI<local>/<prefix>\fR\fR
183 The local IP address and prefix length\&. The remote tunnel endpoint has to use a different IP address in the same subnet\&.
187 the local IP address for the tun/tap device
192 the prefix length of the network
196 \fB\-x, \-\-post\-up\-script \fR\fB\fI<script>\fR\fR
198 This option instructs
200 to run this script after the interface is created\&. By default no script will be executed\&.
203 \fB\-m, \-\-mux \fR\fB\fI<mux\-id>\fR\fR
205 the multiplex id to use\&. default: 0
208 \fB\-s, \-\-sender\-id \fR\fB\fI<sender id>\fR\fR
210 Each anycast tunnel endpoint needs a unique sender id (1, 2, 3, \&...)\&. It is needed to distinguish the senders in case of replay attacks\&. As
212 does not support synchronisation it can\(cqt be used as an anycast endpoint therefore this option is quite useless but implemented for compatibility reasons\&. default: 0
215 \fB\-w, \-\-window\-size \fR\fB\fI<window size>\fR\fR
219 Sometimes, packets arrive out of order on the receiver side\&. This option defines the size of a list of received packets\' 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\&.
222 \fB\-k, \-\-kd\(emprf \fR\fB\fI<kd\-prf type>\fR\fR
224 key derivation pseudo random function
226 The pseudo random function which is used for calculating the session keys and session salt\&.
232 no random function, keys and salt are set to 0\&.\&.00
237 AES in counter mode with 128 Bits, default value
242 AES in counter mode with 128 Bits
247 AES in counter mode with 192 Bits
252 AES in counter mode with 256 Bits
256 \fB\-e, \-\-role \fR\fB\fI<role>\fR\fR
258 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
261 \fIright\fR\&. You may also use
272 \fIright\fR\&. By default
277 \fB\-E, \-\-passphrase \fR\fB\fI<pass phrase>\fR\fR
279 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
285 \fB\-K, \-\-key \fR\fB\fI<master key>\fR\fR
287 master key to use for key derivation
289 Master key in hexadecimal notation, e\&.g\&. 01a2b3c4d5e6f708a9b0cadbecfd0fa1, with a mandatory length of 32, 48 or 64 characters (128, 192 or 256 bits)\&.
292 \fB\-A, \-\-salt \fR\fB\fI<master salt>\fR\fR
294 master salt to use for key derivation
296 Master salt in hexadecimal notation, e\&.g\&. 01a2b3c4d5e6f708a9b0cadbecfd, with a mandatory length of 28 characters (14 bytes)\&.
299 \fB\-c, \-\-cipher \fR\fB\fI<cipher type>\fR\fR
301 payload encryption algorithm
303 Encryption algorithm used for encrypting the payload
314 AES in counter mode with 128 Bits, default value
319 AES in counter mode with 128 Bits
324 AES in counter mode with 192 Bits
329 AES in counter mode with 256 Bits
333 \fB\-a, \-\-auth\-algo \fR\fB\fI<algo type>\fR\fR
335 message authentication algorithm
337 This option sets the message authentication algorithm\&.
339 If HMAC\-SHA1 is used, the packet length is increased\&. The additional bytes contain the authentication data\&. see
340 \fB\-\-auth\-tag\-length\fR
347 no message authentication
352 HMAC\-SHA1, default value
356 \fB\-b, \-\-auth\-tag\-length \fR\fB\fI<length>\fR\fR
358 The number of bytes to use for the auth tag\&. This value defaults to 10 bytes unless the
360 auth algo is used in which case it defaults to 0\&.
363 .SS "P2P Setup between two unicast enpoints:"
366 .nr an-no-space-flag 1
373 uanytun \-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
377 .nr an-no-space-flag 1
384 uanytun \-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
386 .SS "One unicast and one anycast tunnel endpoint:"
389 .nr an-no-space-flag 1
393 \fBUnicast tunnel endpoint:\fR
396 uanytun \-r anycast\&.anytun\&.org \-d anytun0 \-t tun \-n 192\&.0\&.2\&.2/30 \-a null \-c null \-w 0 \-e client
400 .nr an-no-space-flag 1
404 \fBAnycast tunnel endpoints:\fR
407 As \fBuAnytun\fR can\(cqt work as an anycast endpoint it can\(cqt be used for this purpose\&. You have to use \fBAnytun\fR for that job\&.
411 Most likely there are some bugs in \fBuAnytun\fR\&. If you find a bug, please let the developers know at uanytun@anytun\&.org\&. Of course, patches are preferred\&.
414 Christian Pointner <equinox@anytun\&.org>
417 Main web site: http://www\&.anytun\&.org/
420 Copyright (C) 2008\-2010 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\&.