doc/anytun-config.8

   1 '\" t
   2 .\"     Title: anytun-config
   3 .\"    Author: [see the "AUTHORS" section]
   4 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
   5 .\"      Date: 08/26/2014
   6 .\"    Manual: \ \&
   7 .\"    Source: \ \&
   8 .\"  Language: English
   9 .\"
  10 .TH "ANYTUN\-CONFIG" "8" "08/26/2014" "\ \&" "\ \&"
  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 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 anytun-config \- anycast tunneling configuration utility
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fBanytun\-config\fR
  36   [ \fB\-h|\-\-help\fR ]
  37   [ \fB\-L|\-\-log\fR <target>:<level>[,<param1>[,<param2>[\&.\&.]]]
  38   [ \fB\-U|\-\-debug\fR ]
  39   [ \fB\-r|\-\-remote\-host\fR <hostname|ip> ]
  40   [ \fB\-o|\-\-remote\-port\fR <port> ]
  41   [ \fB\-4|\-\-ipv4\-only\fR ]
  42   [ \fB\-6|\-\-ipv6\-only\fR ]
  43   [ \fB\-R|\-\-route\fR <net>/<prefix length> ]
  44   [ \fB\-m|\-\-mux\fR <mux\-id> ]
  45   [ \fB\-w|\-\-window\-size\fR <window size> ]
  46   [ \fB\-k|\-\-kd\-prf\fR <kd\-prf type> ]
  47   [ \fB\-e|\-\-role\fR <role> ]
  48   [ \fB\-E|\-\-passphrase\fR <pass phrase> ]
  49   [ \fB\-K|\-\-key\fR <master key> ]
  50   [ \fB\-A|\-\-salt\fR <master salt> ]
  51 .fi
  52 .SH "DESCRIPTION"
  53 .sp
  54 \fBanytun\-config\fR writes routing/connection table entries, that can be read by \fBanytun\-controld\fR\&.
  55 .SH "OPTIONS"
  56 .PP
  57 \fB\-L, \-\-log \fR\fB\fI<target>:<level>[,<param1>[,<param2>[\&.\&.]]]\fR\fR
  58 .RS 4
  59 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\&.
  60
  61 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
  62 \fIsyslog:3,anytun\-config,daemon\fR
  63 is added\&.
  64
  65 The following targets are supported:
  66 .PP
  67 \fIsyslog\fR
  68 .RS 4
  69 log to syslog daemon, parameters <level>[,<logname>[,<facility>]]
  70 .RE
  71 .PP
  72 \fIfile\fR
  73 .RS 4
  74 log to file, parameters <level>[,<path>]
  75 .RE
  76 .PP
  77 \fIstdout\fR
  78 .RS 4
  79 log to standard output, parameters <level>
  80 .RE
  81 .PP
  82 \fIstderr\fR
  83 .RS 4
  84 log to standard error, parameters <level>
  85 .RE
  86 .RE
  87 .PP
  88 \fB\-U, \-\-debug\fR
  89 .RS 4
  90 This option instructs
  91 \fBAnytun\fR
  92 to run in debug mode\&. It implicits
  93 \fB\-D\fR
  94 (don\(cqt daemonize) and adds a log target with the configuration
  95 \fIstdout:5\fR
  96 (logging with maximum level)\&. In future releases there might be additional output when this option is supplied\&.
  97 .RE
  98 .PP
  99 \fB\-r, \-\-remote\-host \fR\fB\fI<hostname|ip>\fR\fR
 100 .RS 4
 101 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\&.
 102 .RE
 103 .PP
 104 \fB\-o, \-\-remote\-port \fR\fB\fI<port>\fR\fR
 105 .RS 4
 106 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\&.
 107 .RE
 108 .PP
 109 \fB\-4, \-\-ipv4\-only\fR
 110 .RS 4
 111 Resolv to IPv4 addresses only\&. The default is to resolv both IPv4 and IPv6 addresses\&.
 112 .RE
 113 .PP
 114 \fB\-6, \-\-ipv6\-only\fR
 115 .RS 4
 116 Resolv to IPv6 addresses only\&. The default is to resolv both IPv4 and IPv6 addresses\&.
 117 .RE
 118 .PP
 119 \fB\-R, \-\-route \fR\fB\fI<net>/<prefix length>\fR\fR
 120 .RS 4
 121 add a route to connection\&. This can be invoked several times\&.
 122 .RE
 123 .PP
 124 \fB\-m, \-\-mux \fR\fB\fI<mux\-id>\fR\fR
 125 .RS 4
 126 the multiplex id to use\&. default: 0
 127 .RE
 128 .PP
 129 \fB\-w, \-\-window\-size \fR\fB\fI<window size>\fR\fR
 130 .RS 4
 131 seqence window size
 132
 133 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\&.
 134 .RE
 135 .PP
 136 \fB\-k, \-\-kd\(emprf \fR\fB\fI<kd\-prf type>\fR\fR
 137 .RS 4
 138 key derivation pseudo random function
 139
 140 The pseudo random function which is used for calculating the session keys and session salt\&.
 141
 142 Possible values:
 143 .PP
 144 \fInull\fR
 145 .RS 4
 146 no random function, keys and salt are set to 0\&.\&.00
 147 .RE
 148 .PP
 149 \fIaes\-ctr\fR
 150 .RS 4
 151 AES in counter mode with 128 Bits, default value
 152 .RE
 153 .PP
 154 \fIaes\-ctr\-128\fR
 155 .RS 4
 156 AES in counter mode with 128 Bits
 157 .RE
 158 .PP
 159 \fIaes\-ctr\-192\fR
 160 .RS 4
 161 AES in counter mode with 192 Bits
 162 .RE
 163 .PP
 164 \fIaes\-ctr\-256\fR
 165 .RS 4
 166 AES in counter mode with 256 Bits
 167 .RE
 168 .RE
 169 .PP
 170 \fB\-e, \-\-role \fR\fB\fI<role>\fR\fR
 171 .RS 4
 172 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
 173 \fBleft\fR
 174 and
 175 \fBright\fR\&. You may also use
 176 \fBalice\fR
 177 or
 178 \fBserver\fR
 179 as a replacement for
 180 \fBleft\fR
 181 and
 182 \fBbob\fR
 183 or
 184 \fBclient\fR
 185 as a replacement for
 186 \fBright\fR\&. By default
 187 \fBleft\fR
 188 is used\&.
 189 .RE
 190 .PP
 191 \fB\-E, \-\-passphrase \fR\fB\fI<pass phrase>\fR\fR
 192 .RS 4
 193 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
 194 \fB\-\-key\fR
 195 and
 196 \fB\-\-salt\fR\&.
 197 .RE
 198 .PP
 199 \fB\-K, \-\-key \fR\fB\fI<master key>\fR\fR
 200 .RS 4
 201 master key to use for key derivation
 202
 203 Master key in hexadecimal notation, e\&.g\&. 01a2b3c4d5e6f708a9b0cadbecfd0fa1, with a mandatory length of 32, 48 or 64 characters (128, 192 or 256 bits)\&.
 204 .RE
 205 .PP
 206 \fB\-A, \-\-salt \fR\fB\fI<master salt>\fR\fR
 207 .RS 4
 208 master salt to use for key derivation
 209
 210 Master salt in hexadecimal notation, e\&.g\&. 01a2b3c4d5e6f708a9b0cadbecfd, with a mandatory length of 28 characters (14 bytes)\&.
 211 .RE
 212 .SH "EXAMPLES"
 213 .sp
 214 Add a client with Connection ID (Mux) 12 and add 2 Routes to this client
 215 .sp
 216 .if n \{\
 217 .RS 4
 218 .\}
 219 .nf
 220 # anytun\-config \-w 0 \-m 12 \-K 0123456789ABCDEFFEDCBA9876543210 \-A 0123456789ABCDDCBA9876543210 \e
 221                 \-R 192\&.0\&.2\&.0/24 \-R 192\&.168\&.1\&.1/32 \-e server >> routingtable
 222 .fi
 223 .if n \{\
 224 .RE
 225 .\}
 226 .SH "BUGS"
 227 .sp
 228 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\&.
 229 .SH "SEE ALSO"
 230 .sp
 231 anytun(8), anytun\-controld(8), anytun\-showtables(8)
 232 .SH "AUTHORS"
 233 .sp
 234 Othmar Gsenger <otti@anytun\&.org> Erwin Nindl <nine@anytun\&.org> Christian Pointner <equinox@anytun\&.org>
 235 .SH "RESOURCES"
 236 .sp
 237 Main web site: http://www\&.anytun\&.org/
 238 .SH "COPYING"
 239 .sp
 240 Copyright (C) 2007\-2014 Markus Grüneis, 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\&.