public inbox for gentoo-doc-cvs@lists.gentoo.org
 help / color / mirror / Atom feed
From: "swift" <swift@lark.gentoo.org>
To: gentoo-doc-cvs@lists.gentoo.org
Subject: [gentoo-doc-cvs] cvs commit: vpnc-howto.xml
Date: Tue,  9 May 2006 06:31:02 +0000	[thread overview]
Message-ID: <20060509063102.E60CA646E4@smtp.gentoo.org> (raw)

swift       06/05/09 06:31:02

  Modified:             vpnc-howto.xml
  Log:
  Some updates, mostly 1.12 (cf #97760) and line length

Revision  Changes    Path
1.4                  xml/htdocs/doc/en/draft/vpnc-howto.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/draft/vpnc-howto.xml?rev=1.4&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/draft/vpnc-howto.xml?rev=1.4&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/draft/vpnc-howto.xml.diff?r1=1.3&r2=1.4&cvsroot=gentoo

Index: vpnc-howto.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/draft/vpnc-howto.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- vpnc-howto.xml	29 Sep 2005 15:11:35 -0000	1.3
+++ vpnc-howto.xml	9 May 2006 06:31:02 -0000	1.4
@@ -1,15 +1,15 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
 
-<guide link="/doc/en/draft/vpnc-howto.xml">
+<guide link="/doc/en/vpnc-howto.xml">
 
 <title>Gentoo vpnc HOWTO</title>
 
 <author title="Author">
-  David H. Askew
+  <mail link="dhaskew@earthlink.net">David H. Askew</mail>
 </author>
 
-<!--
+<!-- 
 My email address is dhaskew on earthlink.net
 -->
 
@@ -23,7 +23,7 @@
 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
 <license/>
 
-<version>0.10</version>
+<version>0.11</version>
 <date>2005-08-07</date>
 
 <chapter>
@@ -47,7 +47,7 @@
 <body>
 
 <ul>
-  <li>A guide to the basic workings of vpnc</li>
+  <li>A guide to the basic workings of <c>vpnc</c></li>
   <li>A discussion of DNS and routing issues that relate to VPNs</li>
   <li>Examples of managing VPN sessions</li>
   <li>Useful tips and tricks (hopefully)</li>
@@ -61,7 +61,7 @@
 
 <ul>
   <li>An in-depth guide to VPN / encryption technologies</li>
-  <li>A feature by feature explanation of vpnc</li>
+  <li>A feature by feature explanation of <c>vpnc</c></li>
 </ul>
 
 </body>
@@ -115,10 +115,11 @@
 </p>
 
 <pre caption="Checking the kernel config">
-# <i>cat /usr/src/linux/.config | grep TUN</i>
+# <i> grep "TUN" /usr/src/linux/.config</i>
 CONFIG_INET_TUNNEL=m
 # CONFIG_INET6_TUNNEL is not set
 # CONFIG_IPV6_TUNNEL is not set
+<comment>(TUN/TAP enabled as a module)</comment>
 CONFIG_TUN=m
 # CONFIG_8139TOO_TUNE_TWISTER is not set
 </pre>
@@ -153,7 +154,7 @@
 </pre>
 
 <p>
-If you build TUN/TAP support as a module, you first must load the <c>tun</c>
+If you build TUN/TAP support as a module, you first must load the <c>tun</c> 
 module:
 </p>
 
@@ -166,7 +167,7 @@
 </pre>
 
 <p>
-Now that the <c>tun</c> module is loaded, check <c>dmesg</c> output.  You
+Now that the <c>tun</c> module is loaded, check <c>dmesg</c> output.  You 
 should see something like the following:
 </p>
 
@@ -185,12 +186,12 @@
 <body>
 
 <p>
-Now that you have a working kernel setup, you need to install
+Now that you have a working kernel setup, you need to install 
 <c>net-misc/vpnc</c>:
 </p>
 
 <pre caption="Installing vpnc">
-# <i>emerge net-misc/vpnc</i>
+# <i>emerge -av net-misc/vpnc</i>
 </pre>
 
 </body>
@@ -209,7 +210,7 @@
 255.255.255.0 network.  The LAN in question is run by a Gentoo box using an
 iptables firewall, DHCP, caching DNS, etc ... and it masquerades the LAN
 behind the public IP address it receives from an ISP.  You also have a
-workstation on the LAN from which you want to be able to VPN into your
+workstation on the LAN from which you want to be able to VPN into your 
 office with.
 </p>
 
@@ -268,19 +269,18 @@
 <body>
 
 <p>
-Now that you have vpnc installed and we have an example to work from, let's
-discuss the basics of setting up vpnc.  The configuration file for vpnc
-connection settings can be located in a couple places, depending on how many
-profiles you want to setup.  By default, vpnc looks first for
-<path>/etc/vpnc/default.conf</path> for its connection settings.  If it doesn't
+Now that you have <c>vpnc</c> installed and we have an example to work from, 
+let's discuss the basics of setting up <c>vpnc</c>.  The configuration file for
+<c>vpnc</c> connection settings can be located in a couple places, depending on
+how many profiles you want to setup.  By default, <c>vpnc</c> looks first for
+<path>/etc/vpnc/default.conf</path> for its connection settings.  If it doesn't 
 find that file, then it looks for <path>/etc/vpnc.conf</path>.  This setup will
-only address a single profile example and will use the configuration file
+only address a single profile example and will use the configuration file 
 location <path>/etc/vpnc.conf</path>. Make sure you do not have a
 <path>/etc/vpnc/default.conf</path> file.
 </p>
 
-<pre caption="Example vpnc configuration file">
-# <i>cat /etc/vpnc.conf</i>
+<pre caption="Example /etc/vpnc.conf file">
 IPSec gateway vpngateway.domain.org
 IPSec ID group_id
 IPSec secret group_password
@@ -289,25 +289,24 @@
 </pre>
 
 <p>
-The configuration file example above should be modified to reflect the
-appropriate values for your setup.  The gateway option
-<c>vpngateway.domain.org</c> can be a fully qualified domain name or an IP
-address.  The ID and secret options should be given to you by a network
-administrator.  If they are hesitant about giving you this info and you
-currently have a working setup on a Windows box which utilizes the official
-Cisco VPN client, then all you have to do is export your profile.  The
+The configuration file example above should be modified to reflect the 
+appropriate values for your setup.  The gateway option 
+<c>vpngateway.domain.org</c> can be a fully qualified domain name or an IP 
+address.  The ID and secret options should be given to you by a network 
+administrator.  If they are hesitant about giving you this info and you 
+currently have a working setup on a Windows box which utilizes the official 
+Cisco VPN client, then all you have to do is export your profile.  The 
 user name and password options are for your normal network
 sign-on, such as a Windows NT domain account.
 </p>
 
 <p>
 If you are forced to export your profile from a Windows machine, then what you
-will likely have is a file ending in <path>.pcf</path>.  This file will have
+will likely have is a file ending in <path>.pcf</path>.  This file will have 
 all the information you need.  Below is an example:
 </p>
 
-<pre caption="Example .pcf file">
-# <i>cat example.pcf</i>
+<pre caption="Example profile.pcf file">
 [main]
 Description=
 Host=VPNGATEWAY.DOMAIN.ORG
@@ -347,19 +346,19 @@
 </pre>
 
 <p>
-In the above example, we can see entries for <c>Host</c>, <c>GroupName</c> and
-<c>enc_GroupPwd</c>.  Your <c>Username</c> and <c>UserPassword</c> may or may
+In the above example, we can see entries for <c>Host</c>, <c>GroupName</c> and 
+<c>enc_GroupPwd</c>.  Your <c>Username</c> and <c>UserPassword</c> may or may 
 not be exported depending on the setup.
 </p>
 
 <note>
-The vpnc configuration file uses an unencrypted group password (IPSec secret),
-so if you do not know the group password, but you have a copy of the encrypted
-group password from an exported profile, then you need not worry.  The encoding
-scheme for these group passwords is widely known, and all you have to do is
-visit a web page that will offer to decrypt it for you.  The
+The <c>vpnc</c> configuration file uses an unencrypted group password (IPSec 
+secret), so if you do not know the group password, but you have a copy of the 
+encrypted group password from an exported profile, then you need not worry.  
+The encoding scheme for these group passwords is widely known, and all you 
+have to do is visit a web page that will offer to decrypt it for you.  The 
 <uri link="http://www.unix-ag.uni-kl.de/~massar/vpnc/">vpnc homepage</uri>
-has <uri link="http://www.unix-ag.uni-kl.de/~massar/bin/cisco-decode">a
+has <uri link="http://www.unix-ag.uni-kl.de/~massar/bin/cisco-decode">a 
 link</uri> to such a page.
 </note>
 
@@ -374,24 +373,25 @@
 start <c>vpnc</c> you do the following:
 </p>
 
-<pre caption="Example vpnc-connect usage">
-# <i>vpnc-connect</i>
-Enter password for username@vpngateway.domain.org:
+<pre caption="Example vpnc usage">
+# <i>vpnc</i>
+Enter password for username@vpngateway.domain.org: 
 VPNC started in background (pid: 14788)...
 </pre>
 
 <p>
-As you can see from the above command output, once you type <c>vpnc-connect</c>
-(as root), you are prompted for your password.  After entering your password,
-which will not be echoed back to you, the vpnc process will automatically
+As you can see from the above command output, once you type <c>vpnc</c>
+(as root), you are prompted for your password.  After entering your password, 
+which will not be echoed back to you, the <c>vpnc</c> process will automatically
 become a background process.
 </p>
 
 <note>
-If you specified the <c>Xauth password</c> option in your vpnc config file, then
-you will not be prompted for your password at vpnc startup.  Additionally, if
-vpnc needs some extra options not specified in the configuration file, or if
-you have forgotten something, don't worry, it will ask you for it.
+If you specified the <c>Xauth password</c> option in your <c>vpnc</c> config 
+file, then you will not be prompted for your password at <c>vpnc</c> startup. 
+Additionally, if <c>vpnc</c> needs some extra options not specified in the 
+configuration file, or if you have forgotten something, don't worry, it will
+ask you for it.
 </note>
 
 <pre caption="Sample interface configuration changes made by vpnc">
@@ -434,7 +434,7 @@
 </pre>
 
 <p>
-As you can see from the above command output(s), vpnc has done the following:
+As you can see from the above command output(s), <c>vpnc</c> has done the following:
 </p>
 
 <ul>
@@ -448,12 +448,12 @@
 
 <p>
 At this point, your workstation is capable of communicating with hosts via the
-VPN, but only by IP address.  As you might have noticed, vpnc did not alter
-your <path>/etc/resolv.conf</path>, thus not setting up DNS services for the
-virtual link.  Also, because vpnc sets your default route to your VPN gateway,
-all network traffic will travel across the VPN, even if it destined for the
-Internet or elsewhere not specifically specified by additional routes.  For
-some, this basic type of connection may be satisfactory, but for most,
+VPN, but only by IP address.  As you might have noticed, <c>vpnc</c> did not 
+alter your <path>/etc/resolv.conf</path>, thus not setting up DNS services for
+the virtual link.  Also, because <c>vpnc</c> sets your default route to your VP
+gateway, all network traffic will travel across the VPN, even if it destined 
+for the Internet or elsewhere not specifically specified by additional routes.
+For some, this basic type of connection may be satisfactory, but for most, 
 additional steps need to be taken.
 </p>
 
@@ -465,13 +465,13 @@
   <li>DNS for the VPN</li>
   <li>
     A routing setup that will only send traffic destined for the VPN down
-    the virtual tunnel.  This way, you can browse the Internet while connected
+    the virtual tunnel.  This way, you can browse the Internet while connected 
     to the VPN, without your personal web/p2p etc ... traffic going across the
     tunnel.
   </li>
   <li>
-    A script to manage all this, because <c>vpnc-connect</c> just doesn't do
-    enough
+    A script to manage all this, because <c>vpnc</c> just doesn't do
+    enough by default.
   </li>
 </ul>
 
@@ -502,13 +502,13 @@
 <p>
 Unfortunately, <c>vpnc</c> doesn't handle the setup and management of DNS for
 your newly established tunnel.  The user is left to decide how DNS should be
-handled.  You could just overwrite <c>/etc/resolv.conf</c> when you connect, but
-that would utilize your VPN DNS for all DNS queries regardless of whether or not
-the traffic is destined for your VPN tunnel.  This is a very functional solution
-and if you simply need to connect to the tunnel, do your work, and then
-disconnect, read no further.  But, if you want to be able to leave your tunnel
-connected for lengthy periods of time and don't want your work DNS servers
-handling requests for your personal traffic, read on.
+handled.  You could just overwrite <path>/etc/resolv.conf</path> when you 
+connect, but that would utilize your VPN DNS for all DNS queries regardless of 
+whether or not the traffic is destined for your VPN tunnel.  This is a very 
+functional solution and if you simply need to connect to the tunnel, do your 
+work, and then disconnect, read no further.  But, if you want to be able to 
+leave your tunnel connected for lengthy periods of time and don't want your 
+work DNS servers handling requests for your personal traffic, read on.
 </p>
 
 <p>
@@ -520,12 +520,12 @@
 </p>
 
 <note>
-We will consider VPN-related DNS queries to be any query belonging to the
+We will consider VPN-related DNS queries to be any query belonging to the 
 example.org domain, such as host1.example.org or server1.example.org.
 </note>
 
 <p>
-So how do you set things up, so that only requests made to hosts on the
+So how do you set things up, so that only requests made to hosts on the 
 example.org domain get sent to VPN supplied DNS servers?  Well, you're going to
 need to install a local DNS server, but don't worry, it's much easier than you
 think.  There are several software packages that can handle the type of setup
@@ -543,24 +543,24 @@
 </pre>
 
 <p>
-Now you need to add an option to your <c>dnsmasq</c> startup options.  Edit the
-following option to suit your needs.  Substitute .example.org with the
-appropriate domain and the IP address with a valid DNS server that belongs
+Now you need to add an option to your <c>dnsmasq</c> startup options.  Edit the 
+following option to suit your needs.  Substitute .example.org with the 
+appropriate domain and the IP address with a valid DNS server that belongs 
 to the VPN tunnel.
 </p>
 
 <pre caption="/etc/conf.d/dnsmasq">
-<comment># Config file for /etc/init.d/dnsmasq
+Config file for /etc/init.d/dnsmasq
 
-# See the dnsmasq(8) man page for possible options to put here.</comment>
+# See the dnsmasq(8) man page for possible options to put here.
 DNSMASQ_OPTS="-S /.example.org/192.168.125.10"
 </pre>
 
 <p>
-Next, make sure that the first entry in <path>/etc/resolv.conf</path>
+Next, make sure that the first entry in <path>/etc/resolv.conf</path> 
 is your local host <c>127.0.0.1</c>, followed by the location of the backup DNS
-servers that should handle the DNS traffic in case dnsmasq fails to start, or
-if it needs to forward a DNS query it doesn't currently have in its cache.  An
+servers that should handle the DNS traffic in case dnsmasq fails to start, or 
+if it needs to forward a DNS query it doesn't currently have in its cache.  An 
 example <path>/etc/resolv.conf</path> is shown below.
 </p>
 
@@ -593,15 +593,16 @@
 travel across the link.  At this point, you have a VPN tunnel setup and all
 traffic will travel across the tunnel, unless you specify additional routes. In
 order to fix this situation you need to know what networks are available to you
-on your VPN.  The easiest way to find out the needed information is to ask a
+on your VPN.  The easiest way to find out the needed information is to ask a 
 network administrator, but sometimes they are reluctant to answer such
 questions.  If your local network admin wont provide the needed information,
 some trial and error experiments will be required.
 </p>
 
 <p>
-When the VPN tunnel was started, vpnc set the default route to the tunnel.  So
-you must set your default route back to normal, so that things work as expected.
+When the VPN tunnel was started, <c>vpnc</c> set the default route to the 
+tunnel.  So you must set your default route back to normal, so that things 
+work as expected.
 </p>
 
 <pre caption="Resetting your default route">
@@ -609,7 +610,7 @@
 </pre>
 
 <p>
-Earlier, when DNS services were being configured for your VPN, you specified a
+Earlier, when DNS services were being configured for your VPN, you specified a 
 DNS server to handle your example.org domain.  You need to add a route for the
 192.168.125.0 subnet so that DNS queries will work.
 </p>
@@ -619,9 +620,9 @@
 </pre>
 
 <p>
-At this point, you should add any additional routes for known networks.  If
+At this point, you should add any additional routes for known networks.  If 
 your friendly network administrator gave you the required info,
-great.  Otherwise, you might need to ping hosts you will be connecting to
+great.  Otherwise, you might need to ping hosts you will be connecting to 
 frequently, to give yourself an idea about what your routing table should look
 like.
 </p>
@@ -641,8 +642,9 @@
 </pre>
 
 <p>
-As you can see from the above example, the ping probes to intranet1.example.org
-were unsuccessful.  So we need to add a route for that subnet.
+As you can see from the above example, the ping probes to
+<c>intranet1.example.org</c> were unsuccessful.  So we need to add a route for 
+that subnet.
 </p>
 
 <pre caption="another route command example">
@@ -650,7 +652,7 @@
 </pre>
 
 <p>
-A few ping and route commands later, you should be well on your way to a
+A few ping and route commands later, you should be well on your way to a 
 well working routing table.
 </p>
 
@@ -666,7 +668,7 @@
 <p>
 Next is an example script to manage the VPN connection. You could execute it
 (as root) from an xterm to start a connection to your VPN.  Then all you have
-to do is press return to disconnect the VPN.  Obviously you will need to
+to do is press return to disconnect the VPN.  Obviously you will need to 
 modify this for your setup, remembering to add all the additional routes that
 you may need.
 </p>
@@ -677,8 +679,8 @@
 source /sbin/functions.sh
 
 ebegin "Connecting to the VPN"
-vpnc-connect
-eend
+vpnc
+eend 
 
 ebegin "Modifying the routing table"
 route add default gw 192.168.0.1
@@ -693,7 +695,7 @@
 
 ebegin "Disconnecting from the VPN"
 vpnc-disconnect
-eend
+eend 
 ebegin "Reconfiguring the default routing table"
 route add default gw 192.168.0.1
 eend
@@ -711,10 +713,10 @@
 <body>
 
 <p>
-If you are looking for a linux application that supports RDP (Remote Desktop
+If you are looking for a linux application that supports RDP (Remote Desktop 
 Protocol) then give <c>grdesktop</c> a try.  It's a GUI app written in Gtk that
 fits in well with a gnome desktop, but doesn't require it.  If you don't want
-the GUI configuration dialogs that grdesktop provides, then just install
+the GUI configuration dialogs that grdesktop provides, then just install 
 <c>rdesktop</c>.  Ultimately, grdesktop is just a frontend for rdesktop.
 </p>
 
@@ -726,19 +728,19 @@
 <p>
 If you need to connect to a windows machine which doesn't have a DNS entry, and
 you know the address of an available WINS server, you can use a tool called
-<c>nmblookup</c> to query the WINS server for the host name of the machine you
+<c>nmblookup</c> to query the WINS server for the host name of the machine you 
 want to connect to.  Unfortunately, you have to install samba to get it, but if
 you are going to be working with boxes running Windows you might as well want to
 install samba, because it includes several other useful tools.
 </p>
 
 <pre caption="Installing samba">
-# <i>emerge samba</i>
+# <i>emerge -av samba</i>
 </pre>
 
 <p>
 When you have samba and its tools installed, test <c>nmblookup</c> by
-asking the WINS server at IP address 192.168.125.11 about a host named
+asking the WINS server at IP address 192.168.125.11 about a host named 
 wintelbox1.
 </p>
 
@@ -780,7 +782,7 @@
 
 <p>
 Hopefully by now you have been able to connect to your VPN on choice and are
-well on your way to remote office work.  Feel free to file a bug at
+well on your way to remote office work.  Feel free to file a bug at 
 <uri link="http://bugs.gentoo.org">bugs.gentoo.org</uri> should you find a
 mistake or wish to make a addition or recommendation regarding this document.
 </p>



-- 
gentoo-doc-cvs@gentoo.org mailing list



             reply	other threads:[~2006-05-09  6:30 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-05-09  6:31 swift [this message]
  -- strict thread matches above, loose matches on Subject: below --
2008-11-29  0:03 [gentoo-doc-cvs] cvs commit: vpnc-howto.xml Joshua Saddler
2008-01-24  7:39 Joshua Saddler
2008-01-14 17:37 Xavier Neys
2008-01-10  6:15 Joshua Saddler
2007-11-07 20:42 Josh Saddler
2007-05-23  8:50 Xavier Neys
2007-05-23  8:50 Xavier Neys
2005-08-07 20:15 swift
2005-08-07 20:09 swift

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20060509063102.E60CA646E4@smtp.gentoo.org \
    --to=swift@lark.gentoo.org \
    --cc=docs-team@lists.gentoo.org \
    --cc=gentoo-doc-cvs@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox