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