vpnc.8

   1 .TH "VPNC" "8" "28 Januar 2004" "Debian" "vpnc"
   2
   3 .SH NAME
   4 vpnc \- client for cisco3000 VPN Concentrator
   5 .SH SYNOPSIS
   6
   7 .B vpnc  [ \-\-gateway
   8 .I IP-or-hostname
   9 .B ] [ \-\-id
  10 .I IPSec group Id
  11 .B ] [ \-\-username
  12 .I name
  13 .B ] [ \-\-ifname
  14 .I name
  15 .B ] [ \-\-local\-port
  16 .I port number
  17 .B ] [ \-\-pid\-file
  18 .I filename
  19 .B ] [ \-\-dh
  20 .I IKE DH group
  21 .B ] [ \-\-pfs
  22 .I PFS group
  23 .B ] [ \-\-non\-inter ] [ \-\-debug ] [ \-\-no\-detach ] [ \-\-print\-config ]
  24
  25
  26 .SH "DESCRIPTION"
  27 .PP
  28 This manual page documents briefly the
  29 \fBvpnc\fR, \fBvpnc\-connect\fR and
  30 \fBvpnc\-disconnect\fR commands.
  31 .PP
  32 \fBvpnc\fR is a
  33 VPN client for the Cisco 3000 VPN  Concentrator,  creating  a IPSec-like
  34 connection as a tunneling network device for the local system. It uses
  35 the TUN/TAP driver in  Linux  kernel  2.4  and  above  and device tun(4)
  36 on BSD. The created connection is presented as a tunneling network
  37 device to the local system.
  38 .PP
  39 The vpnc daemon by it self does not set any routes, the user (or
  40 the connect script, see below) has to do it on its own, e.g. for a full
  41 tunnel with IP routing under Linux. Further, the user must care about
  42 setting a minimal route to the gateway to not cut the essential
  43 connection.
  44 .PP
  45 The command \fBvpnc\-connect\fR (a helper script) will take care of it all: it
  46 reads the configuration file (specified as the first argument, see
  47 EXAMPLES below), creates a minimalistic host route to the gateway and
  48 configures the default gateway configuration of Linux to run over the
  49 VPN tunnel.
  50 .PP
  51 The \fBvpnc\-disconnect\fR command is used to terminate
  52 the connection previously created by \fBvpnc\-connect\fR
  53 and restore the previous routing configuration.
  54
  55 .SH CONFIGURATION
  56 The daemon reads configuration data from the following places:
  57 .PD 0
  58 .IP "- command line options"
  59 .IP "- config file(s) specified on the command line"
  60 .IP "- /etc/vpnc.conf"
  61 .IP "- prompting the user if not found above"
  62
  63 .PP
  64
  65 The script expects the
  66 .B configuration file
  67 as the first parameter. This
  68 can either be an absolute path or the name
  69 of a config file located in
  70 .B /etc/vpnc/<filename>.conf.
  71 If no config is specified,
  72 .B vpnc-connect
  73 will try
  74 to load
  75 .B /etc/vpnc/default.conf
  76 or as a last resort
  77 .B /etc/vpnc.conf.
  78
  79 .SH OPTIONS
  80 The program options can be either given as argument (but not all of them
  81 for security reasons) or be stored in a configuration file.
  82
  83 .IP "\-\-gateway IP-or-hostname"
  84 IP address or hostname of the VPN gateway
  85 .IP "\-\-id IPSec group Id"
  86 ID of the IPSec group
  87 .IP "\-\-username name"
  88 your user credentials
  89 .IP "\-\-ifname name"
  90 name of the tun-interface to use
  91 .IP "\-\-local\-port port number"
  92 use this port for the connection <0-65535>, use 0 for random
  93 .IP "\-\-pid\-file filename"
  94 store the pid of background process there
  95 .IP "\-\-dh IKE DH group"
  96 name of the IKE DH Group <dh1/dh2/dh5>
  97 .IP "\-\-pfs PFS group"
  98 Perfect Forward Secrecy <nopfs/dh1/dh2/dh5>
  99 .IP "\-\-non\-inter"
 100 non interactive mode, don't ask any questions
 101 .IP "\-\-debug nr"
 102 set debugging level <0/1/2/3/99>.
 103 .B Warning: \-\-debug output of level 99 and greater from later versions cotains (hex-encoded) username and password!
 104 .IP "\-\-no\-detach"
 105 do not send daemon to background
 106 .IP "\-\-print\-config"
 107 prints your configuration; output can be used as vpnc.conf
 108
 109 .SH FILES
 110 .I /etc/vpnc.conf
 111 .RS
 112 The default configuration file. See
 113 .BR EXAMPLES
 114 for further details.
 115 .RE
 116
 117 .I /etc/vpnc/*.conf
 118 .RS
 119 The vpnc\-connect will read configuration files in this directory when
 120 the config script name (without .conf) is specified on the command line.
 121 .RE
 122
 123
 124 .SH EXAMPLES
 125 This is an example vpnc.conf:
 126
 127 .RS
 128 .PD 0
 129 IKE DH Group dh2
 130 .P
 131 Perfect Forward Secrecy nopfs
 132 .P
 133 IPSec gateway vpn.rwth\-aachen.de
 134 .P
 135 IPSec ID MoPS
 136 .P
 137 IPSec secret mopsWLAN
 138 .P
 139 Xauth username abcdef
 140 .P
 141 Xauth password 123456
 142 .PD
 143 .RE
 144
 145 The lines begin with a keyword (no leading spaces!).
 146 The values start exactly one space after the keywords, and run to the end of
 147 line. This lets you put any kind of weird character (except EOL and NUL) in
 148 your strings, but it does mean you can't add comments after a string, or spaces
 149 before them.
 150
 151 See also the
 152 .B \-\-print\-config
 153 option to generate a config file, and the example file in the package
 154 documentation directory where more advanced usage is described.
 155
 156 Advanced features like manual setting of multiple target routes is
 157 documented in the example files of the vpnc package.
 158
 159 .SH TODO
 160 Re-keying is no implemented yet (default rekey-intervall is 8 hours).
 161
 162 .SH AUTHOR
 163 This man-page has been written by Eduard Bloch <blade(at)debian.org> and
 164 Christian Lackas <delta(at)lackas.net>, based on vpnc README by
 165 Maurice Massar <vpnc(at)unix\-ag.uni\-kl.de>.
 166 Permission is
 167 granted to copy, distribute and/or modify this document under
 168 the terms of the GNU General Public License, Version 2 any
 169 later version published by the Free Software Foundation.
 170 .PP
 171 On Debian systems, the complete text of the GNU General Public
 172 License can be found in /usr/share/common\-licenses/GPL.
 173 .SH "SEE ALSO"
 174 .BR ip (8),
 175 .BR ifconfig (8),
 176 .BR route (1),
 177 .BR http://www.unix\-ag.uni\-kl.de/~massar/vpnc/