8eb2839f989f16d6cb32954faac61d16992482e4
[anytun.git] / 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 [ *-L|--log* <target>:<level>[,<param1>[,<param2>[..]]]
14 [ *-r|--remote-host* <hostname|ip> ]
15 [ *-o|--remote-port* <port> ]
16 [ *-4|--ipv4-only* ]
17 [ *-6|--ipv6-only* ]
18 [ *-R|--route* <net>/<prefix length> ]
19 [ *-m|--mux* <mux-id> ]
20 [ *-w|--window-size* <window size> ]
21 [ *-k|--kd-prf* <kd-prf type> ]
22 [ *-e|--role <role>* ]
23 [ *-E|--passphrase* <pass phrase> ]
24 [ *-K|--key* <master key> ]
25 [ *-A|--salt* <master salt> ]
26
27 DESCRIPTION
28 -----------
29
30 *anytun-config* writes routing/connection table entries, that can be read by *anytun-controld*.
31
32 OPTIONS
33 -------
34
35 -L|--log <target>:<level>[,<param1>[,<param2>[..]]]
36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
37
38 add log target to logging system. This can be invoked several times
39 in order to log to different targets at the same time. Every target 
40 hast its own log level which is a number between 0 and 5. Where 0 means
41 disabling log and 5 means debug messages are enabled.
42
43 The following targets are supported:
44
45 * *syslog* - log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
46 * *file* - log to file, parameters <level>[,<path>]
47 * *stdout* - log to standard output, parameters <level>
48 * *stderr* - log to standard error, parameters <level> 
49
50 The file target can be used more the once with different levels.
51 If no target is provided at the command line a single target with the 
52 following config is added:
53
54 *syslog:3,uanytun,daemon*
55
56 -r|--remote-host <hostname|ip>
57 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58
59 remote host
60
61 This option can be used to specify the remote tunnel
62 endpoint. In case of anycast tunnel endpoints, the
63 anycast IP address has to be used. If you do not specify
64 an address, it is automatically determined after receiving
65 the first data packet.
66
67 -o|--remote-port <port>
68 ~~~~~~~~~~~~~~~~~~~~~~~
69 remote port
70
71 The UDP port used for payload data by the remote host
72 (specified with -p on the remote host). If you do not specify
73 a port, it is automatically determined after receiving
74 the first data packet.
75
76 -4|--ipv4-only
77 ~~~~~~~~~~~~~~
78
79 Resolv to IPv4 addresses only. The default is to resolv both
80 IPv4 and IPv6 addresses.
81
82 -6|--ipv6-only
83 ~~~~~~~~~~~~~~
84
85 Resolv to IPv6 addresses only. The default is to resolv both
86 IPv4 and IPv6 addresses.
87
88 -R|--route <net>/<prefix length>
89 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90
91 add a route to connection. This can be invoked several times.
92
93 -m|--mux <mux-id>
94 ~~~~~~~~~~~~~~~~~
95
96 the multiplex id to use. default: 0
97
98 -w|--window-size <window size>
99 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
100
101 seqence window size
102
103 Sometimes, packets arrive out of order on the receiver
104 side. This option defines the size of a list of received
105 packets' sequence numbers. If, according to this list,
106 a received packet has been previously received or has
107 been transmitted in the past, and is therefore not in
108 the list anymore, this is interpreted as a replay attack
109 and the packet is dropped. A value of 0 deactivates this
110 list and, as a consequence, the replay protection employed
111 by filtering packets according to their secuence number.
112 By default the sequence window is disabled and therefore a
113 window size of 0 is used.
114
115 -k|--kd--prf <kd-prf type>
116 ~~~~~~~~~~~~~~~~~~~~~~~~~~
117
118 key derivation pseudo random function.
119
120 The pseudo random function which is used for calculating the 
121 session keys and session salt.
122
123 Possible values:
124
125 * *null* - no random function, keys and salt are set to 0..00
126 * *aes-ctr* - AES in counter mode with 128 Bits, default value
127 * *aes-ctr-128* - AES in counter mode with 128 Bits
128 * *aes-ctr-192* - AES in counter mode with 192 Bits
129 * *aes-ctr-256* - AES in counter mode with 256 Bits
130
131 -e|--role <role>
132 ~~~~~~~~~~~~~~~~
133
134 SATP uses different session keys for inbound and outbound traffic. The
135 role parameter is used to determine which keys to use for outbound or
136 inbound packets. On both sides of a vpn connection different roles have 
137 to be used. Possible values are *left* and *right*. You may also use 
138 *alice* or *server* as a replacement for *left* and *bob* or *client* as 
139 a replacement for *right*. By default *left* is used.
140
141 -E|--passphrase <pass phrase>
142 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
143
144 This passphrase is used to generate the master key and master salt.
145 For the master key the last n bits of the SHA256 digest of the 
146 passphrase (where n is the length of the master key in bits) is used. 
147 The master salt gets generated with the SHA1 digest. 
148 You may force a specific key and or salt by using *--key* and *--salt*.
149
150 -K|--key <master key>
151 ~~~~~~~~~~~~~~~~~~~~~
152
153 master key to use for key derivation
154
155 Master key in hexadecimal notation, eg
156 01a2b3c4d5e6f708a9b0cadbecfd0fa1, with a mandatory length
157 of 32, 48 or 64 characters (128, 192 or 256 bits).
158
159 -A|--salt <master salt>
160 ~~~~~~~~~~~~~~~~~~~~~~~
161
162 master salt to use for key derivation
163
164 Master salt in hexadecimal notation, eg
165 01a2b3c4d5e6f708a9b0cadbecfd, with a mandatory length
166 of 28 characters (14 bytes).
167
168
169 EXAMPLES
170 --------
171
172 Add a client with Connection ID (Mux) 12 and add 2 Routes to this client
173
174 ------------------------------------------------------------------------------------------------ 
175 # anytun-config -w 0 -m 12 -K 0123456789ABCDEFFEDCBA9876543210 -A 0123456789ABCDDCBA9876543210 \
176                 -R 192.0.2.0/24 -R 192.168.1.1/32 -e server >> routingtable
177 ------------------------------------------------------------------------------------------------ 
178
179 BUGS
180 ----
181 Most likely there are some bugs in *anytun*. If you find a bug, please let
182 the developers know at satp@anytun.org. Of course, patches are preferred.
183
184 SEE ALSO
185 --------
186 anytun(8), anytun-controld(8), anytun-showtables(8)
187
188 AUTHORS
189 -------
190 Design of SATP and wizards of this implementation:
191
192 Othmar Gsenger <otti@anytun.org>
193 Erwin Nindl <nine@anytun.org>
194 Christian Pointner <equinox@anytun.org>
195
196 Debian packaging:
197
198 Andreas Hirczy <ahi@itp.tu-graz.ac.at>
199
200 Manual page:
201
202 Alexander List <alex@debian.org>
203
204 RESOURCES
205 ---------
206
207 Main web site: http://www.anytun.org/
208
209
210 COPYING
211 -------
212
213 Copyright \(C) 2007-2008 Othmar Gsenger, Erwin Nindl and Christian
214 Pointner. This  program  is  free software;  you  can redistribute
215 it and/or modify it under the terms of the GNU General Public License
216 version 2 as published by the Free Software Foundation.
217