debian/anytun-config.8

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