1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
|
uanytun(8)
==========
NAME
----
uanytun - micro anycast tunneling daemon
SYNOPSIS
--------
*uanytun*
[ *-h|--help* ]
[ *-D|--nodaemonize* ]
[ *-C|--chroot* ]
[ *-u|--username* <username> ]
[ *-H|--chroot-dir* <directory> ]
[ *-P|--write-pid* <filename> ]
[ *-i|--interface* <ip-address> ]
[ *-p|--port* <port> ]
[ *-r|--remote-host* <hostname|ip> ]
[ *-o|--remote-port* <port> ]
[ *-d|--dev* <name> ]
[ *-t|--type* <tun|tap> ]
[ *-n|--ifconfig* <local> <remote|netmask> ]
[ *-x|--post-up-script* <script> ]
[ *-s|--sender-id* <sender id> ]
[ *-w|--window-size* <window size> ]
[ *-m|--mux* <mux-id> ]
[ *-c|--cipher* <cipher type> ]
[ *-a|--auth-algo* <algo type> ]
[ *-K|--key* <master key> ]
[ *-A|--salt* <master salt> ]
DESCRIPTION
-----------
*uAnytun* 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.
OPTIONS
-------
*uAnytun* 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:
-D|--nodaemonize
~~~~~~~~~~~~~~~~
This option instructs *uAnytun* to run in the foreground
instead of becoming a daemon which is the default.
-C|--chroot
~~~~~~~~~~~
Instruct *uAnytun* to run in a chroot chail and drop privileges. The
default is not to run in chroot.
-u|--username <username>
~~~~~~~~~~~~~~~~~~~~~~~~
if chroot change to this user. default: nobody
-H|--chroot-dir <directory>
~~~~~~~~~~~~~~~~~~~~~~~~~~~
chroot to this directory. default: /var/run/uanytun
-P|--write-pid <filename>
~~~~~~~~~~~~~~~~~~~~~~~~~
Instruct *uAnytun* to write it's pid to this file. The default is
not to create a pid file.
-i|--interface <ip address>
~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
-p|--port <port>
~~~~~~~~~~~~~~~~
local port to bind to
The local UDP port that is used to send and receive the
payload data. The two tunnel endpoints can use different
ports. default: 4444
-r|--remote-host <hostname|ip>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
remote host
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.
-o|--remote-port <port>
~~~~~~~~~~~~~~~~~~~~~~~
remote port
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.
-d|--dev <name>
~~~~~~~~~~~~~~~
device name
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.
-t|--type <tun|tap>
~~~~~~~~~~~~~~~~~~~
device type
Type of the tunnels to create. Use tap for Ethernet
tunnels, tun for IP tunnels.
-n|--ifconfig <local> <remote|netmask>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*<local>* the local IP address for the tun/tap device
*<remote|netmask>* the remote IP address (tun) or netmask (tap)
In tap/Ethernet tunnel mode:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The local IP address and subnet mask of the tunnel
interface, in ifconfig style. The remote tunnel endpoint
has to use a different IP address in the same subnet.
In tun/IP tunnel mode:
The local IP address of the tunnel interface and the
IP address of the tunnel interface on the remote tunnel
endpoint.
-x|--post-up-script <script>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This option instructs *uAnytun* to run this script after the interface
is created. By default no script will be executed.
-s|--sender-id <sender id>
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Each anycast tunnel endpoint needs a uniqe sender id
(1, 2, 3, ...). It is needed to distinguish the senders
in case of replay attacks. As *uAnytun* does not support
synchronisation it can't be used as an anycast endpoint therefore
this option is quite useless. default: 0
-w|--window-size <window size>
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
seqence window size
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.
-m|--mux <mux-id>
~~~~~~~~~~~~~~~~~
the multiplex id to use. default: 0
-c|--cipher <cipher type>
~~~~~~~~~~~~~~~~~~~~~~~~~
payload encryption algorithm
Encryption algorithm used for encrypting the payload
Possible values:
* *null* - no encryption
-a|--auth-algo <algo type>
~~~~~~~~~~~~~~~~~~~~~~~~~~
message authentication algorithm
This option sets the message authentication algorithm.
Possible values:
* *null* - no message authentication
If HMAC-SHA1 is used, the packet length is increased by
10 bytes. These 10 bytes contain the authentication data.
-K|--key <master key>
~~~~~~~~~~~~~~~~~~~~~
master key to use for encryption
Master key in hexadecimal notation, eg
01a2b3c4d5e6f708a9b0cadbecfd0fa1, with a mandatory length
of 32 characters (16 bytes).
-A|--salt <master salt>
~~~~~~~~~~~~~~~~~~~~~~~
master salt to use for encryption
Master salt in hexadecimal notation, eg
01a2b3c4d5e6f708a9b0cadbecfd, with a mandatory length
of 28 characters (14 bytes).
EXAMPLES
--------
One unicast and one anycast tunnel endpoint:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Unicast tunnel endpoint:
^^^^^^^^^^^^^^^^^^^^^^^^
uanytun -r anycast.anytun.org -d anytun0 -t tun -n 192.0.2.2 192.0.2.1 -w 0 -c null
BUGS
----
Most likely there are some bugs in *uAnytun*. If you find a bug, please let
the developers know at uanytun@anytun.org. Of course, patches are preferred.
AUTHORS
-------
Christian Pointner <equinox@anytun.org>
RESOURCES
---------
Main web site: http://www.anytun.org/
COPYING
-------
Copyright \(C) 2008-2009 Christian Pointner. This program is free
software; you can redistribute it and/or modify it under the terms
of the GNU General Public License version 2 as published by the
Free Software Foundation.
|
