2 .\" Title: anytun-config
3 .\" Author: [see the "AUTHORS" section]
4 .\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
6 .\" Manual: anytun-config user manual
7 .\" Source: anytun 0.3.3
10 .TH "ANYTUN\-CONFIG" "8" "02/16/2010" "anytun 0.3.3" "anytun-config 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 anytun-config \- anycast tunneling configuration utility
27 [ \fB\-h|\-\-help\fR ]
28 [ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]]
29 [ \fB\-U|\-\-debug\fR ]
30 [ \fB\-r|\-\-remote\-host\fR <hostname|ip> ]
31 [ \fB\-o|\-\-remote\-port\fR <port> ]
32 [ \fB\-4|\-\-ipv4\-only\fR ]
33 [ \fB\-6|\-\-ipv6\-only\fR ]
34 [ \fB\-R|\-\-route\fR <net>/<prefix length> ]
35 [ \fB\-m|\-\-mux\fR <mux\-id> ]
36 [ \fB\-w|\-\-window\-size\fR <window size> ]
37 [ \fB\-k|\-\-kd\-prf\fR <kd\-prf type> ]
38 [ \fB\-e|\-\-role\fR <role> ]
39 [ \fB\-E|\-\-passphrase\fR <pass phrase> ]
40 [ \fB\-K|\-\-key\fR <master key> ]
41 [ \fB\-A|\-\-salt\fR <master salt> ]
45 \fBanytun\-config\fR writes routing/connection table entries, that can be read by \fBanytun\-controld\fR\&.
48 \fB\-L, \-\-log \fR\fB\fI<target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR\fR
50 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\&.
52 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
53 \fIsyslog:3,anytun\-config,daemon\fR
56 The following targets are supported:
60 log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
65 log to file, parameters <level>[,<path>]
70 log to standard output, parameters <level>
75 log to standard error, parameters <level>
83 to run in debug mode\&. It implicits
85 (don\(cqt daemonize) and adds a log target with the configuration
87 (logging with maximum level)\&. In future releases there might be additional output when this option is supplied\&.
90 \fB\-r, \-\-remote\-host \fR\fB\fI<hostname|ip>\fR\fR
92 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\&.
95 \fB\-o, \-\-remote\-port \fR\fB\fI<port>\fR\fR
97 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\&.
100 \fB\-4, \-\-ipv4\-only\fR
102 Resolv to IPv4 addresses only\&. The default is to resolv both IPv4 and IPv6 addresses\&.
105 \fB\-6, \-\-ipv6\-only\fR
107 Resolv to IPv6 addresses only\&. The default is to resolv both IPv4 and IPv6 addresses\&.
110 \fB\-R, \-\-route \fR\fB\fI<net>/<prefix length>\fR\fR
112 add a route to connection\&. This can be invoked several times\&.
115 \fB\-m, \-\-mux \fR\fB\fI<mux\-id>\fR\fR
117 the multiplex id to use\&. default: 0
120 \fB\-w, \-\-window\-size \fR\fB\fI<window size>\fR\fR
124 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\&.
127 \fB\-k, \-\-kd\(emprf \fR\fB\fI<kd\-prf type>\fR\fR
129 key derivation pseudo random function
131 The pseudo random function which is used for calculating the session keys and session salt\&.
137 no random function, keys and salt are set to 0\&.\&.00
142 AES in counter mode with 128 Bits, default value
147 AES in counter mode with 128 Bits
152 AES in counter mode with 192 Bits
157 AES in counter mode with 256 Bits
161 \fB\-e, \-\-role \fR\fB\fI<role>\fR\fR
163 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
166 \fBright\fR\&. You may also use
177 \fBright\fR\&. By default
182 \fB\-E, \-\-passphrase \fR\fB\fI<pass phrase>\fR\fR
184 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
190 \fB\-K, \-\-key \fR\fB\fI<master key>\fR\fR
192 master key to use for key derivation
194 Master key in hexadecimal notation, e\&.g\&. 01a2b3c4d5e6f708a9b0cadbecfd0fa1, with a mandatory length of 32, 48 or 64 characters (128, 192 or 256 bits)\&.
197 \fB\-A, \-\-salt \fR\fB\fI<master salt>\fR\fR
199 master salt to use for key derivation
201 Master salt in hexadecimal notation, e\&.g\&. 01a2b3c4d5e6f708a9b0cadbecfd, with a mandatory length of 28 characters (14 bytes)\&.
205 Add a client with Connection ID (Mux) 12 and add 2 Routes to this client
211 # anytun\-config \-w 0 \-m 12 \-K 0123456789ABCDEFFEDCBA9876543210 \-A 0123456789ABCDDCBA9876543210 \e
212 \-R 192\&.0\&.2\&.0/24 \-R 192\&.168\&.1\&.1/32 \-e server >> routingtable
219 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\&.
222 anytun(8), anytun\-controld(8), anytun\-showtables(8)
225 Othmar Gsenger <otti@anytun\&.org> Erwin Nindl <nine@anytun\&.org> Christian Pointner <equinox@anytun\&.org>
228 Main web site: http://www\&.anytun\&.org/
231 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\&.