vpnc.8

   1 .TH "VPNC" "8" "13 Mai 2004" "Debian" "vpnc"
   2
   3 .SH NAME
   4 vpnc \- client for Cisco VPN3000 Concentrator, IOS and PIX
   5 .SH SYNOPSIS
   6
   7 see
   8 .B vpnc  \-\-long\-help
   9
  10 .SH "DESCRIPTION"
  11 .PP
  12 This manual page documents briefly the
  13 \fBvpnc\fR, \fBvpnc\-connect\fR and
  14 \fBvpnc\-disconnect\fR commands.
  15 .PP
  16 \fBvpnc\fR is a
  17 VPN client for the Cisco 3000 VPN  Concentrator,  creating  a IPSec-like
  18 connection as a tunneling network device for the local system. It uses
  19 the TUN/TAP driver in  Linux  kernel  2.4  and  above  and device tun(4)
  20 on BSD. The created connection is presented as a tunneling network
  21 device to the local system.
  22 .PP
  23 The vpnc daemon by it self does not set any routes, the user (or
  24 the connect script, see below) has to do it on its own, e.g. for a full
  25 tunnel with IP routing under Linux. Further, the user must care about
  26 setting a minimal route to the gateway to not cut the essential
  27 connection.
  28 .PP
  29 However, when connection has been established, vpnc will run a simple
  30 command (see \-\-script) to configure the interface and care about the
  31 route setup. By default, only a simple ifconfig command is executed.
  32 .PP
  33 The command \fBvpnc\-connect\fR is a helper script that will assist on
  34 connection invocation and routing configuration. It can also be used to manage configuration files
  35 for multiple VPN connections. The script can be started by the user or
  36 from the daemon (see \-\-script) when the connection is established. In
  37 the first case, it will simply run the daemon after some environment
  38 checks. When executed by the daemon later, it will create a minimalistic
  39 host route to the gateway and configures the default gateway
  40 configuration of Linux to run over the VPN tunnel.
  41 .PP
  42 The \fBvpnc\-disconnect\fR command is used to terminate
  43 the connection previously created by \fBvpnc\-connect\fR
  44 and restore the previous routing configuration.
  45
  46 .SH CONFIGURATION
  47 The daemon reads configuration data from the following places:
  48 .PD 0
  49 .IP "- command line options"
  50 .IP "- config file(s) specified on the command line"
  51 .IP "- /etc/vpnc/default.conf"
  52 .IP "- /etc/vpnc.conf"
  53 .IP "- prompting the user if not found above"
  54
  55 .PP
  56
  57 The vpnc-connect script expects the
  58 .B configuration file
  59 as the first parameter. This
  60 can either be an absolute path or the name
  61 of a config file located in
  62 .B /etc/vpnc/<filename>.conf.
  63 If no config is specified,
  64 .B vpnc\-connect
  65 will try
  66 to load
  67 .B /etc/vpnc/default.conf
  68 or as a last resort
  69 .B /etc/vpnc.conf.
  70
  71 .SH OPTIONS
  72 The program options can be either given as argument (but not all of them
  73 for security reasons) or be stored in a configuration file.
  74
  75
  76 .IP "\-\-print\-config"
  77  Prints your configuration; output can be used as vpnc.conf
  78
  79 See output of
  80 .B vpnc \-\-long\-help
  81 for a complete description
  82
  83 .SH FILES
  84 .I /etc/vpnc.conf
  85 .RS
  86 The default configuration file. You can specify the same config
  87 directives as with command line options and additionaly
  88 .B IPSec secret
  89 and
  90 .B Xauth password
  91 both supplying a cleartext password. Scrambled passwords from the Cisco
  92 configuration profiles are not supported.
  93
  94 See
  95 .BR EXAMPLES
  96 for further details.
  97 .RE
  98
  99 .I /etc/vpnc/*.conf
 100 .RS
 101 The vpnc\-connect will read configuration files in this directory when
 102 the config script name (without .conf) is specified on the command line.
 103 .RE
 104
 105
 106 .SH EXAMPLES
 107 This is an example vpnc.conf:
 108
 109 .RS
 110 .PD 0
 111 IPSec gateway vpn.rwth\-aachen.de
 112 .P
 113 IPSec ID MoPS
 114 .P
 115 IPSec secret mopsWLAN
 116 .P
 117 Xauth username abcdef
 118 .P
 119 Xauth password 123456
 120 .PD
 121 .RE
 122
 123 The lines begin with a keyword (no leading spaces!).
 124 The values start exactly one space after the keywords, and run to the end of
 125 line. This lets you put any kind of weird character (except EOL and NUL) in
 126 your strings, but it does mean you can't add comments after a string, or spaces
 127 before them.
 128
 129 See also the
 130 .B \-\-print\-config
 131 option to generate a config file, and the example file in the package
 132 documentation directory where more advanced usage is demonstrated.
 133
 134 Advanced features like manual setting of multiple target routes is
 135 documented in the example files of the vpnc package.
 136
 137 .SH TODO
 138 .PD 0
 139 Re-keying is not implemented yet (default rekey-intervall is 8 hours).
 140 .P
 141 Certificate support (Pre-Shared-Key + XAUTH is known to be insecure).
 142 .PD
 143
 144 .SH AUTHOR
 145 This man-page has been written by Eduard Bloch <blade(at)debian.org> and
 146 Christian Lackas <delta(at)lackas.net>, based on vpnc README by
 147 Maurice Massar <vpnc(at)unix\-ag.uni\-kl.de>.
 148 Permission is
 149 granted to copy, distribute and/or modify this document under
 150 the terms of the GNU General Public License, Version 2 any
 151 later version published by the Free Software Foundation.
 152 .PP
 153 On Debian systems, the complete text of the GNU General Public
 154 License can be found in /usr/share/common\-licenses/GPL.
 155 .SH "SEE ALSO"
 156 .BR ip (8),
 157 .BR ifconfig (8),
 158 .BR route (1),
 159 .BR http://www.unix\-ag.uni\-kl.de/~massar/vpnc/
 160