home *** CD-ROM | disk | FTP | other *** search
/ PC World 2003 May / PCWorld_2003-05_cd.bin / Komunik / apache / apache_2.0.45-win32-x86-no_ssl.msi / Data.Cab / F233081_details.html.en < prev    next >
Extensible Markup Language  |  2003-03-30  |  21KB  |  431 lines
  1. <?xml version="1.0" encoding="ISO-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
  4.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  5.               This file is generated from xml source: DO NOT EDIT
  6.         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
  7.       -->
  8. <title>An In-Depth Discussion of Virtual Host Matching - Apache HTTP Server</title>
  9. <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10. <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11. <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body id="manual-page"><div id="page-header">
  14. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  15. <p class="apache">Apache HTTP Server Version 2.0</p>
  16. <img alt="" src="../images/feather.gif" /></div>
  17. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  18. <div id="path">
  19. <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Virtual Hosts</a></div><div id="page-content"><div id="preamble"><h1>An In-Depth Discussion of Virtual Host Matching</h1>
  20.  
  21.     <p>The virtual host code was completely rewritten in
  22.     <strong>Apache 1.3</strong>. This document attempts to explain
  23.     exactly what Apache does when deciding what virtual host to
  24.     serve a hit from. With the help of the new
  25.     <code class="directive"><a href="../mod/core.html#namevirtualhost">NameVirtualHost</a></code>
  26.     directive virtual host configuration should be a lot easier and
  27.     safer than with versions prior to 1.3.</p>
  28.  
  29.     <p>If you just want to <cite>make it work</cite> without
  30.     understanding how, here are <a href="examples.html">some
  31.     examples</a>.</p>
  32.  
  33. </div>
  34. <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#configparsing">Config File Parsing</a></li>
  35. <li><img alt="" src="../images/down.gif" /> <a href="#hostmatching">Virtual Host Matching</a></li>
  36. <li><img alt="" src="../images/down.gif" /> <a href="#tips">Tips</a></li>
  37. </ul></div>
  38. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  39. <div class="section">
  40. <h2><a name="configparsing" id="configparsing">Config File Parsing</a></h2>
  41.  
  42.     <p>There is a <em>main_server</em> which consists of all the
  43.     definitions appearing outside of
  44.     <code><VirtualHost></code> sections. There are virtual
  45.     servers, called <em>vhosts</em>, which are defined by
  46.     <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code>
  47.     sections.</p>
  48.  
  49.     <p>The directives
  50.     <code class="directive"><a href="../mod/mpm_common.html#listen">Listen</a></code>,
  51.     <code class="directive"><a href="../mod/core.html#servername">ServerName</a></code>,
  52.     <code class="directive"><a href="../mod/core.html#serverpath">ServerPath</a></code>,
  53.     and <code class="directive"><a href="../mod/core.html#serveralias">ServerAlias</a></code>
  54.     can appear anywhere within the definition of a server. However,
  55.     each appearance overrides the previous appearance (within that
  56.     server).</p>
  57.  
  58.     <p>The default value of the <code>Listen</code> field for
  59.     main_server is 80. The main_server has no default
  60.     <code>ServerPath</code>, or <code>ServerAlias</code>. The
  61.     default <code>ServerName</code> is deduced from the servers IP
  62.     address.</p>
  63.  
  64.     <p>The main_server Listen directive has two functions.  One
  65.     function is to determine the default network port Apache will
  66.     bind to.  The second function is to specify the port number
  67.     which is used in absolute URIs during redirects.</p>
  68.  
  69.     <p>Unlike the main_server, vhost ports <em>do not</em> affect
  70.     what ports Apache listens for connections on.</p>
  71.  
  72.     <p>Each address appearing in the <code>VirtualHost</code>
  73.     directive can have an optional port. If the port is unspecified
  74.     it defaults to the value of the main_server's most recent
  75.     <code>Listen</code> statement. The special port <code>*</code>
  76.     indicates a wildcard that matches any port. Collectively the
  77.     entire set of addresses (including multiple <code>A</code>
  78.     record results from DNS lookups) are called the vhost's
  79.     <em>address set</em>.</p>
  80.  
  81.     <p>Unless a <code class="directive"><a href="../mod/core.html#namevirtualhost">NameVirtualHost</a></code>
  82.     directive is used for a specific IP address the first vhost
  83.     with that address is treated as an IP-based vhost. The IP
  84.     address can also be the wildcard <code>*</code>.</p>
  85.  
  86.     <p>If name-based vhosts should be used a
  87.     <code>NameVirtualHost</code> directive <em>must</em> appear
  88.     with the IP address set to be used for the name-based vhosts.
  89.     In other words, you must specify the IP address that holds the
  90.     hostname aliases (CNAMEs) for your name-based vhosts via a
  91.     <code>NameVirtualHost</code> directive in your configuration
  92.     file.</p>
  93.  
  94.     <p>Multiple <code>NameVirtualHost</code> directives can be used
  95.     each with a set of <code>VirtualHost</code> directives but only
  96.     one <code>NameVirtualHost</code> directive should be used for
  97.     each specific IP:port pair.</p>
  98.  
  99.     <p>The ordering of <code>NameVirtualHost</code> and
  100.     <code>VirtualHost</code> directives is not important which
  101.     makes the following two examples identical (only the order of
  102.     the <code>VirtualHost</code> directives for <em>one</em>
  103.     address set is important, see below):</p>
  104.  
  105. <table><tr>
  106. <td><div class="example"><p><code>
  107.   NameVirtualHost 111.22.33.44<br />
  108.   <VirtualHost 111.22.33.44><br />
  109.   # server A<br />
  110.   ...<br />
  111.   </VirtualHost><br />
  112.   <VirtualHost 111.22.33.44><br />
  113.   # server B<br />
  114.   ...<br />
  115.   </VirtualHost><br />
  116.   <br />
  117.   NameVirtualHost 111.22.33.55<br />
  118.   <VirtualHost 111.22.33.55><br />
  119.   # server C<br />
  120.   ...<br />
  121.   </VirtualHost><br />
  122.   <VirtualHost 111.22.33.55><br />
  123.   # server D<br />
  124.   ...<br />
  125.   </VirtualHost>
  126. </code></p></div></td>
  127. <td><div class="example"><p><code>
  128.   <VirtualHost 111.22.33.44><br />
  129.   # server A<br />
  130.   </VirtualHost><br />
  131.   <VirtualHost 111.22.33.55><br />
  132.   # server C<br />
  133.   ...<br />
  134.   </VirtualHost><br />
  135.   <VirtualHost 111.22.33.44><br />
  136.   # server B<br />
  137.   ...<br />
  138.   </VirtualHost><br />
  139.   <VirtualHost 111.22.33.55><br />
  140.   # server D<br />
  141.   ...<br />
  142.   </VirtualHost><br />
  143.   <br />
  144.   NameVirtualHost 111.22.33.44<br />
  145.   NameVirtualHost 111.22.33.55<br />
  146.   <br />
  147. </code></p></div></td>
  148. </tr></table>
  149.  
  150.  
  151.     <p>(To aid the readability of your configuration you should
  152.     prefer the left variant.)</p>
  153.  
  154.     <p>After parsing the <code>VirtualHost</code> directive, the
  155.     vhost server is given a default <code>Listen</code> equal to the
  156.     port assigned to the first name in its <code>VirtualHost</code>
  157.     directive.</p>
  158.  
  159.     <p>The complete list of names in the <code>VirtualHost</code>
  160.     directive are treated just like a <code>ServerAlias</code> (but
  161.     are not overridden by any <code>ServerAlias</code> statement)
  162.     if all names resolve to the same address set. Note that
  163.     subsequent <code>Listen</code> statements for this vhost will not
  164.     affect the ports assigned in the address set.</p>
  165.  
  166.     <p>During initialization a list for each IP address is
  167.     generated and inserted into an hash table. If the IP address is
  168.     used in a <code>NameVirtualHost</code> directive the list
  169.     contains all name-based vhosts for the given IP address. If
  170.     there are no vhosts defined for that address the
  171.     <code>NameVirtualHost</code> directive is ignored and an error
  172.     is logged. For an IP-based vhost the list in the hash table is
  173.     empty.</p>
  174.  
  175.     <p>Due to a fast hashing function the overhead of hashing an IP
  176.     address during a request is minimal and almost not existent.
  177.     Additionally the table is optimized for IP addresses which vary
  178.     in the last octet.</p>
  179.  
  180.     <p>For every vhost various default values are set. In
  181.     particular:</p>
  182.  
  183.     <ol>
  184.       <li>If a vhost has no <code class="directive"><a href="../mod/core.html#serveradmin">ServerAdmin</a></code>,
  185.       <code class="directive"><a href="../mod/core.html#resourceconfig">ResourceConfig</a></code>,
  186.       <code class="directive"><a href="../mod/core.html#accessconfig">AccessConfig</a></code>,
  187.       <code class="directive"><a href="../mod/core.html#timeout">Timeout</a></code>,
  188.       <code class="directive"><a href="../mod/core.html#keepalivetimeout">KeepAliveTimeout</a></code>,
  189.       <code class="directive"><a href="../mod/core.html#keepalive">KeepAlive</a></code>,
  190.       <code class="directive"><a href="../mod/core.html#maxkeepaliverequests">MaxKeepAliveRequests</a></code>,
  191.       or <code class="directive"><a href="../mod/core.html#sendbuffersize">SendBufferSize</a></code>
  192.       directive then the respective value is inherited from the
  193.       main_server. (That is, inherited from whatever the final
  194.       setting of that value is in the main_server.)</li>
  195.  
  196.       <li>The "lookup defaults" that define the default directory
  197.       permissions for a vhost are merged with those of the
  198.       main_server. This includes any per-directory configuration
  199.       information for any module.</li>
  200.  
  201.       <li>The per-server configs for each module from the
  202.       main_server are merged into the vhost server.</li>
  203.     </ol>
  204.  
  205.     <p>Essentially, the main_server is treated as "defaults" or a
  206.     "base" on which to build each vhost. But the positioning of
  207.     these main_server definitions in the config file is largely
  208.     irrelevant -- the entire config of the main_server has been
  209.     parsed when this final merging occurs. So even if a main_server
  210.     definition appears after a vhost definition it might affect the
  211.     vhost definition.</p>
  212.  
  213.     <p>If the main_server has no <code>ServerName</code> at this
  214.     point, then the hostname of the machine that httpd is running
  215.     on is used instead. We will call the <em>main_server address
  216.     set</em> those IP addresses returned by a DNS lookup on the
  217.     <code>ServerName</code> of the main_server.</p>
  218.  
  219.     <p>For any undefined <code>ServerName</code> fields, a
  220.     name-based vhost defaults to the address given first in the
  221.     <code>VirtualHost</code> statement defining the vhost.</p>
  222.  
  223.     <p>Any vhost that includes the magic <code>_default_</code>
  224.     wildcard is given the same <code>ServerName</code> as the
  225.     main_server.</p>
  226.  
  227. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  228. <div class="section">
  229. <h2><a name="hostmatching" id="hostmatching">Virtual Host Matching</a></h2>
  230.  
  231.     <p>The server determines which vhost to use for a request as
  232.     follows:</p>
  233.  
  234.     <h3><a name="hashtable" id="hashtable">Hash table lookup</a></h3>
  235.  
  236.     <p>When the connection is first made by a client, the IP
  237.     address to which the client connected is looked up in the
  238.     internal IP hash table.</p>
  239.  
  240.     <p>If the lookup fails (the IP address wasn't found) the
  241.     request is served from the <code>_default_</code> vhost if
  242.     there is such a vhost for the port to which the client sent the
  243.     request. If there is no matching <code>_default_</code> vhost
  244.     the request is served from the main_server.</p>
  245.  
  246.     <p>If the IP address is not found in the hash table then the
  247.     match against the port number may also result in an entry
  248.     corresponding to a <code>NameVirtualHost *</code>, which is
  249.     subsequently handled like other name-based vhosts.</p>
  250.  
  251.     <p>If the lookup succeeded (a corresponding list for the IP
  252.     address was found) the next step is to decide if we have to
  253.     deal with an IP-based or a name-base vhost.</p>
  254.  
  255.     
  256.  
  257.     <h3><a name="ipbased" id="ipbased">IP-based vhost</a></h3>
  258.  
  259.     <p>If the entry we found has an empty name list then we have
  260.     found an IP-based vhost, no further actions are performed and
  261.     the request is served from that vhost.</p>
  262.  
  263.     
  264.  
  265.     <h3><a name="namebased" id="namebased">Name-based vhost</a></h3>
  266.  
  267.     <p>If the entry corresponds to a name-based vhost the name list
  268.     contains one or more vhost structures. This list contains the
  269.     vhosts in the same order as the <code>VirtualHost</code>
  270.     directives appear in the config file.</p>
  271.  
  272.     <p>The first vhost on this list (the first vhost in the config
  273.     file with the specified IP address) has the highest priority
  274.     and catches any request to an unknown server name or a request
  275.     without a <code>Host:</code> header field.</p>
  276.  
  277.     <p>If the client provided a <code>Host:</code> header field the
  278.     list is searched for a matching vhost and the first hit on a
  279.     <code>ServerName</code> or <code>ServerAlias</code> is taken
  280.     and the request is served from that vhost. A <code>Host:</code>
  281.     header field can contain a port number, but Apache always
  282.     matches against the real port to which the client sent the
  283.     request.</p>
  284.  
  285.     <p>If the client submitted a HTTP/1.0 request without
  286.     <code>Host:</code> header field we don't know to what server
  287.     the client tried to connect and any existing
  288.     <code>ServerPath</code> is matched against the URI from the
  289.     request. The first matching path on the list is used and the
  290.     request is served from that vhost.</p>
  291.  
  292.     <p>If no matching vhost could be found the request is served
  293.     from the first vhost with a matching port number that is on the
  294.     list for the IP to which the client connected (as already
  295.     mentioned before).</p>
  296.  
  297.     
  298.  
  299.     <h3><a name="persistent" id="persistent">Persistent connections</a></h3>
  300.  
  301.     <p>The IP lookup described above is only done <em>once</em> for a
  302.     particular TCP/IP session while the name lookup is done on
  303.     <em>every</em> request during a KeepAlive/persistent
  304.     connection. In other words a client may request pages from
  305.     different name-based vhosts during a single persistent
  306.     connection.</p>
  307.  
  308.     
  309.  
  310.     <h3><a name="absoluteURI" id="absoluteURI">Absolute URI</a></h3>
  311.  
  312.     <p>If the URI from the request is an absolute URI, and its
  313.     hostname and port match the main server or one of the
  314.     configured virtual hosts <em>and</em> match the address and
  315.     port to which the client sent the request, then the
  316.     scheme/hostname/port prefix is stripped off and the remaining
  317.     relative URI is served by the corresponding main server or
  318.     virtual host. If it does not match, then the URI remains
  319.     untouched and the request is taken to be a proxy request.</p>
  320.  
  321.  
  322. <h3><a name="observations" id="observations">Observations</a></h3>
  323.  
  324.     <ul>
  325.       <li>A name-based vhost can never interfere with an IP-base
  326.       vhost and vice versa. IP-based vhosts can only be reached
  327.       through an IP address of its own address set and never
  328.       through any other address. The same applies to name-based
  329.       vhosts, they can only be reached through an IP address of the
  330.       corresponding address set which must be defined with a
  331.       <code>NameVirtualHost</code> directive.</li>
  332.  
  333.       <li><code>ServerAlias</code> and <code>ServerPath</code>
  334.       checks are never performed for an IP-based vhost.</li>
  335.  
  336.       <li>The order of name-/IP-based, the <code>_default_</code>
  337.       vhost and the <code>NameVirtualHost</code> directive within
  338.       the config file is not important. Only the ordering of
  339.       name-based vhosts for a specific address set is significant.
  340.       The one name-based vhosts that comes first in the
  341.       configuration file has the highest priority for its
  342.       corresponding address set.</li>
  343.  
  344.       <li>For security reasons the port number given in a
  345.       <code>Host:</code> header field is never used during the
  346.       matching process. Apache always uses the real port to which
  347.       the client sent the request.</li>
  348.  
  349.       <li>If a <code>ServerPath</code> directive exists which is a
  350.       prefix of another <code>ServerPath</code> directive that
  351.       appears later in the configuration file, then the former will
  352.       always be matched and the latter will never be matched. (That
  353.       is assuming that no <code>Host:</code> header field was
  354.       available to disambiguate the two.)</li>
  355.  
  356.       <li>If two IP-based vhosts have an address in common, the
  357.       vhost appearing first in the config file is always matched.
  358.       Such a thing might happen inadvertently. The server will give
  359.       a warning in the error logfile when it detects this.</li>
  360.  
  361.       <li>A <code>_default_</code> vhost catches a request only if
  362.       there is no other vhost with a matching IP address
  363.       <em>and</em> a matching port number for the request. The
  364.       request is only caught if the port number to which the client
  365.       sent the request matches the port number of your
  366.       <code>_default_</code> vhost which is your standard
  367.       <code>Listen</code> by default. A wildcard port can be
  368.       specified (<em>i.e.</em>, <code>_default_:*</code>) to catch
  369.       requests to any available port. This also applies to
  370.       <code>NameVirtualHost *</code> vhosts.</li>
  371.  
  372.       <li>The main_server is only used to serve a request if the IP
  373.       address and port number to which the client connected is
  374.       unspecified and does not match any other vhost (including a
  375.       <code>_default_</code> vhost). In other words the main_server
  376.       only catches a request for an unspecified address/port
  377.       combination (unless there is a <code>_default_</code> vhost
  378.       which matches that port).</li>
  379.  
  380.       <li>A <code>_default_</code> vhost or the main_server is
  381.       <em>never</em> matched for a request with an unknown or
  382.       missing <code>Host:</code> header field if the client
  383.       connected to an address (and port) which is used for
  384.       name-based vhosts, <em>e.g.</em>, in a
  385.       <code>NameVirtualHost</code> directive.</li>
  386.  
  387.       <li>You should never specify DNS names in
  388.       <code>VirtualHost</code> directives because it will force
  389.       your server to rely on DNS to boot. Furthermore it poses a
  390.       security threat if you do not control the DNS for all the
  391.       domains listed. There's <a href="../dns-caveats.html">more
  392.       information</a> available on this and the next two
  393.       topics.</li>
  394.  
  395.       <li><code>ServerName</code> should always be set for each
  396.       vhost. Otherwise A DNS lookup is required for each
  397.       vhost.</li>
  398.       </ul>
  399.       
  400.  
  401. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  402. <div class="section">
  403. <h2><a name="tips" id="tips">Tips</a></h2>
  404.  
  405.     <p>In addition to the tips on the <a href="../dns-caveats.html#tips">DNS Issues</a> page, here are
  406.     some further tips:</p>
  407.  
  408.     <ul>
  409.       <li>Place all main_server definitions before any
  410.       <code>VirtualHost</code> definitions. (This is to aid the
  411.       readability of the configuration -- the post-config merging
  412.       process makes it non-obvious that definitions mixed in around
  413.       virtual hosts might affect all virtual hosts.)</li>
  414.  
  415.       <li>Group corresponding <code>NameVirtualHost</code> and
  416.       <code>VirtualHost</code> definitions in your configuration to
  417.       ensure better readability.</li>
  418.  
  419.       <li>Avoid <code>ServerPaths</code> which are prefixes of
  420.       other <code>ServerPaths</code>. If you cannot avoid this then
  421.       you have to ensure that the longer (more specific) prefix
  422.       vhost appears earlier in the configuration file than the
  423.       shorter (less specific) prefix (<em>i.e.</em>, "ServerPath
  424.       /abc" should appear after "ServerPath /abc/def").</li>
  425.     </ul>
  426.  
  427. </div></div>
  428. <div id="footer">
  429. <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
  430. <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
  431. </body></html>