icpv2-protocol.txt
上传用户:liugui
上传日期:2007-01-04
资源大小:822k
文件大小:19k
源码类别:

代理服务器

开发平台:

Unix_Linux

  1. Network Working Group                                         D. Wessels
  2. Internet-Draft                                                 K. Claffy
  3.                                          National Laboratory for Applied
  4. Obsoletes <draft-wessels-icp-v2-02.txt>            Network Research/UCSD
  5. Expires: November 27, 1997                                   27 May 1997
  6.                 Internet Cache Protocol (ICP), version 2
  7.                      <draft-wessels-icp-v2-03.txt>
  8. Status of this Memo
  9.    This document is an Internet-Draft. Internet-Drafts are working
  10.    documents of the Internet Engineering Task Force (IETF), its areas,
  11.    and its working groups. Note that other groups may also distribute
  12.    working documents as Internet-Drafts.
  13.    Internet-Drafts are draft documents valid for a maximum of six months
  14.    and may be updated, replaced, or obsoleted by other documents at any
  15.    time. It is inappropriate to use Internet-Drafts as reference
  16.    material or to cite them other than as ``work in progress.''
  17.    To learn the current status of any Internet-Draft, please check the
  18.    ``1id-abstracts.txt'' listing contained in the Internet-Drafts Shadow
  19.    Directories on ftp.is.co.za (Africa), nic.nordu.net (Europe),
  20.    munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or
  21.    ftp.isi.edu (US West Coast).
  22. Abstract
  23.    This draft document describes version 2 of the Internet Cache
  24.    Protocol (ICPv2) as currently implemented in two World-Wide Web proxy
  25.    cache packages[3,5].  ICP is a lightweight message format used for
  26.    communicating among Web caches.  ICP is used to exchange hints about
  27.    the existence of URLs in neighbor caches.  Caches exchange ICP
  28.    queries and replies to gather information to use in selecting the
  29.    most appropriate location from which to retrieve an object.
  30.    This document describes only the format and fields of ICP messages.
  31.    A companion document (RFCXXXX, <draft-wessels-icp-v2-appl-01.txt>)
  32.    describes the application of ICP to Web caches.  Several independent
  33.    caching implementations now use ICP, and we consider it important to
  34.    codify the existing practical uses of ICP for those trying to
  35.    implement, deploy, and extend its use for their own purposes.
  36. Wessels                                                         [Page 1]
  37. Internet-Draft                                             22 April 1997
  38. 1.  Introduction
  39.    ICP is a message format used for communicating between Web caches.
  40.    Although Web caches use HTTP[1] for the transfer of object data,
  41.    caches benefit from a simpler, lighter communication protocol.  ICP
  42.    is primarily used in a cache mesh to locate specific Web objects in
  43.    neighboring caches.  One cache sends an ICP query to its neighbors.
  44.    The neighbors send back ICP replies indicating a "HIT" or a "MISS."
  45.    In current practice, ICP is implemented on top of UDP, but there is
  46.    no requirement that it be limited to UDP.  We feel that ICP over UDP
  47.    offers features important to Web caching applications.  An ICP
  48.    query/reply exchange needs to occur quickly, typically within a sec-
  49.    ond or two.  A cache cannot wait longer than that before beginning to
  50.    retrieve an object.  Failure to receive a reply message most likely
  51.    means the network path is either congested or broken.  In either case
  52.    we would not want to select that neighbor.  As an indication of imme-
  53.    diate network conditions between neighbor caches, ICP over a
  54.    lightweight protocol such as UDP is better than one with the overhead
  55.    of TCP.
  56.    In addition to its use as an object location protocol, ICP messages
  57.    can be used for cache selection.  Failure to receive a reply from a
  58.    cache may indicate a network or system failure.  The ICP reply may
  59.    include information that could assist selection of the most appropri-
  60.    ate source from which to retrieve an object.
  61.    ICP was initially developed by Peter Danzig, et. al.  at the Univer-
  62.    sity of Southern California as a central part of hierarchical caching
  63.    in the Harvest research project[3].
  64. ICP Message Format
  65.    The ICP message format consists of a 20-octet fixed header plus a
  66.    variable sized payload (see Figure 1).
  67.    NOTE: All fields must be represented in network byte order.
  68.    Opcode
  69.       One of the opcodes defined below.
  70.    Version
  71.       The ICP protocol version number.  At the time of this writing,
  72.       both versions two and three are in use.  This document describes
  73.       only version two.  The version number field allows for future
  74.       development of this protocol.
  75.    Message Length
  76. Wessels                                                         [Page 2]
  77. Internet-Draft                                             22 April 1997
  78.      0                   1                   2                   3
  79.     0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  80.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  81.    |     Opcode    |    Version    |         Message Length        |
  82.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  83.    |                         Request Number                        |
  84.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  85.    |                            Options                            |
  86.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  87.    |                          Option Data                          |
  88.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  89.    |                       Sender Host Address                     |
  90.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  91.    |                                                               |
  92.    |                            Payload                            |
  93.    /                                                               /
  94.    /                                                               /
  95.    |                                                               |
  96.    +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  97.                        FIGURE 1: ICP message format.
  98.       The total length (octets) of the ICP message.  ICP messages MUST
  99.       not exceed 16,384 octets in length.
  100.    Request Number
  101.       An opaque identifier.  When responding to a query, this value must
  102.       be copied into the reply message.
  103.    Options
  104.       A 32-bit field of option flags that allows extension of this ver-
  105.       sion of the protocol in certain, limited ways.  See ``ICP Option
  106.       Flags'' below.
  107.    Option Data
  108.       A four-octet field to support optional features.  The following
  109.       ICP features make use of this field:
  110.       The ICP_FLAG_SRC_RTT option uses the low 16-bits of Option Data to
  111.       return RTT measurements.  The ICP_FLAG_SRC_RTT option is further
  112.       described below.
  113.    Sender Host Address
  114.       The IPv4 address of the host sending the ICP message.  This field
  115.       should probably not be trusted over what is  provided by getpeer-
  116.       name(), accept(), and recvfrom().  There is some ambiguity over
  117.       the original purpose of this field.  In practice it is not used.
  118. Wessels                                                         [Page 3]
  119. Internet-Draft                                             22 April 1997
  120.    Payload
  121.       The contents of the Payload field vary depending on the Opcode,
  122.       but most often it contains a null-terminated URL string.
  123. 2.  ICP Opcodes
  124. The following table shows currently defined ICP opcodes:
  125.    Value    Name
  126.    -----    -----------------
  127.        0    ICP_OP_INVALID
  128.        1    ICP_OP_QUERY
  129.        2    ICP_OP_HIT
  130.        3    ICP_OP_MISS
  131.        4    ICP_OP_ERR
  132.      5-9    UNUSED
  133.       10    ICP_OP_SECHO
  134.       11    ICP_OP_DECHO
  135.    12-20    UNUSED
  136.       21    ICP_OP_MISS_NOFETCH
  137.       22    ICP_OP_DENIED
  138.       23    ICP_OP_HIT_OBJ
  139.    ICP_OP_INVALID
  140.       A place holder to detect zero-filled or malformed messages.  A
  141.       cache must never intentionally send an ICP_OP_INVALID message.
  142.       ICP_OP_ERR should be used instead.
  143.    ICP_OP_QUERY
  144.       A query message.  NOTE this opcode has a different payload format
  145.       than most of the others.  First is the requester's IPv4 address,
  146.       followed by a URL.  The Requester Host Address is not that of the
  147.       cache generating the ICP message, but rather the address of the
  148.       caches's client that originated the request.  The Requester Host
  149.       Address is often zero filled.  An ICP message with an all-zero
  150.       Requester Host Address address should be taken as one where the
  151.       requester address is not specified; it does not indicate a valid
  152.       IPv4 address.
  153. Wessels                                                         [Page 4]
  154. Internet-Draft                                             22 April 1997
  155.       ICP_OP_QUERY payload format:
  156.         0                   1                   2                   3
  157.        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  158.       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  159.       |                     Requester Host Address                    |
  160.       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  161.       |                                                               |
  162.       /                       Null-Terminated URL                     /
  163.       /                                                               /
  164.       |                                                               |
  165.       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  166.       In response to an ICP_OP_QUERY, the recipient must return one of:
  167.       ICP_OP_HIT, ICP_OP_MISS, ICP_OP_ERR, ICP_OP_MISS_NOFETCH,
  168.       ICP_OP_DENIED, or ICP_OP_HIT_OBJ.
  169.    ICP_OP_SECHO
  170.       Similar to ICP_OP_QUERY, but for use in simulating a query to an
  171.       origin server.  When ICP is used to select the closest neighbor,
  172.       the origin server can be included in the algorithm by bouncing an
  173.       ICP_OP_SECHO message off it's echo port.  The payload is simply
  174.       the null-terminated URL.
  175.       NOTE: the echo server will not interpret the data (i.e. we could
  176.       send it anything).  This opcode is used to tell the difference
  177.       between a legitimate query or response, random garbage, and an
  178.       echo response.
  179.    ICP_OP_DECHO
  180.       Similar to ICP_OP_QUERY, but for use in simulating a query to a
  181.       cache which does not use ICP.  When ICP is used to choose the
  182.       closest neighbor, a non-ICP cache can be included in the algorithm
  183.       by bouncing an ICP_OP_DECHO message off it's echo port.  The pay-
  184.       load is simply the null-terminated URL.
  185.       NOTE: one problem with this approach is that while a system's echo
  186.       port may be functioning perfectly, the cache software may not be
  187.       running at all.
  188.    One of the following six ICP opcodes are sent in response to an
  189.    ICP_OP_QUERY message.  Unless otherwise noted, the payload must be
  190.    the null-terminated URL string.  Both the URL string and the Request
  191.    Number field must be exactly the same as from the ICP_OP_QUERY mes-
  192.    sage.
  193.    ICP_OP_HIT
  194. Wessels                                                         [Page 5]
  195. Internet-Draft                                             22 April 1997
  196.       An ICP_OP_HIT response indicates that the requested URL exists in
  197.       this cache and that the requester is allowed to retrieve it.
  198.    ICP_OP_MISS
  199.       An ICP_OP_MISS response indicates that the requested URL does not
  200.       exist in this cache.  The querying cache may still choose to fetch
  201.       the URL from the replying cache.
  202.    ICP_OP_ERR
  203.       An ICP_OP_ERR response indicates some kind of error in parsing or
  204.       handling the query message (e.g. invalid URL).
  205.    ICP_OP_MISS_NOFETCH
  206.       An ICP_OP_MISS_NOFETCH response indicates that this cache is up,
  207.       but is in a state where it does not want to handle cache misses.
  208.       An example of such a state is during a startup phase where a cache
  209.       might be rebuilding its object store.  A cache in such a mode may
  210.       wish to return ICP_OP_HIT for cache hits, but not ICP_OP_MISS for
  211.       misses.  ICP_OP_MISS_NOFETCH essentially means ``I am up and run-
  212.       ning, but please don't fetch this URL from me now.''
  213.       Note, ICP_OP_MISS_NOFETCH has a different meaning than
  214.       ICP_OP_MISS.  The ICP_OP_MISS reply is an invitation to fetch the
  215.       URL from the replying cache (if their relationship allows it), but
  216.       ICP_OP_MISS_NOFETCH is a request to NOT fetch the URL from the
  217.       replying cache.
  218.    ICP_OP_DENIED
  219.       An ICP_OP_DENIED response indicates that the querying site is not
  220.       allowed to retrieve the named object from this cache.  Caches and
  221.       proxies may implement complex access controls.  This reply must be
  222.       be interpreted to mean ``you are not allowed to request this par-
  223.       ticular URL from me at this particular time.''
  224.       Caches receiving a high percentage of ICP_OP_DENIED replies are
  225.       probably misconfigured.  Caches should track percentage of all
  226.       replies which are ICP_OP_DENIED and disable a neighbor which
  227.       exceeds a certain threshold (e.g. 95% of 100 or more queries).
  228.       Similarly, a cache should track the percent of ICP_OP_DENIED mes-
  229.       sages that are sent to a given address.  If the percent of denied
  230.       messages exceeds a certain threshold (e.g. 95% of 100 or more),
  231.       the cache may choose to ignore all subsequent ICP_OP_QUERY mes-
  232.       sages from that address until some sort of administrative inter-
  233.       vention occurs.
  234.    ICP_OP_HIT_OBJ
  235.       Just like an ICP_OP_HIT response, but the actual object data has
  236. Wessels                                                         [Page 6]
  237. Internet-Draft                                             22 April 1997
  238.       been included in this reply message.   Many requested objects are
  239.       small enough that it is possible to include them in the query
  240.       response and avoid the need to make a subsequent HTTP request for
  241.       the object.
  242.       CAVEAT: ICP_OP_HIT_OBJ has some negative side effects which make
  243.       its use undesirable.  It transfers object data without HTTP and
  244.       therefore bypasses the standard HTTP processing, including autho-
  245.       rization and age validation.  Another negative side effect is that
  246.       ICP_OP_HIT_OBJ messages will often be much larger than the path
  247.       MTU, thereby causing fragmentation to occur on the UDP packet.
  248.       For these reasons, use of ICP_OP_HIT_OBJ is NOT recommended.
  249.       A cache must not send an ICP_OP_HIT_OBJ unless the
  250.       ICP_FLAG_HIT_OBJ flag is set in the query message Options field.
  251.       ICP_OP_HIT_OBJ payload format:
  252.         0                   1                   2                   3
  253.        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
  254.       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  255.       |                                                               |
  256.       /                       Null-Terminated URL                     /
  257.       /                                                               /
  258.       |                                                               |
  259.       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  260.       |         Object Size           |                               |
  261.       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               |
  262.       |                                                               |
  263.       /                           Object Data                         /
  264.       /                                                               /
  265.       |                                                               |
  266.       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
  267.       The receiving application must check to make sure it actually
  268.       receives Object Size octets of data.  If it does not, then it
  269.       should treat the ICP_OP_HIT_OBJ reply as though it were a normal
  270.       ICP_OP_HIT.
  271.       NOTE: the Object Size field does not necessarily begin on a 32-bit
  272.       boundary as shown in the diagram above.  It begins immediately
  273.       following the NULL byte of the URL string.
  274.    UNRECOGNIZED OPCODES
  275.       ICP messages with unrecognized or unused opcodes should be
  276.       ignored, i.e. no reply generated.  The application may choose to
  277.       note the anomalous behaviour in a log file.
  278. Wessels                                                         [Page 7]
  279. Internet-Draft                                             22 April 1997
  280. 3.  ICP Option Flags
  281.    0x80000000  ICP_FLAG_HIT_OBJ
  282.       This flag is set in an ICP_OP_QUERY message indicating that it is
  283.       okay to respond with an ICP_OP_HIT_OBJ message if the object data
  284.       will fit in the reply.
  285.    0x40000000  ICP_FLAG_SRC_RTT
  286.       This flag is set in an ICP_OP_QUERY message indicating that the
  287.       requester would like the ICP reply to include the responder's mea-
  288.       sured RTT to the origin server.
  289.       Upon receipt of an ICP_OP_QUERY with ICP_FLAG_SRC_RTT bit set, a
  290.       cache should check an internal database of RTT measurements.  If
  291.       available, the RTT value MUST be expressed as a 16-bit integer, in
  292.       units of milliseconds.  If unavailable, the responder may either
  293.       set the RTT value to zero, or clear the ICP_FLAG_SRC_RTT bit in
  294.       the ICP reply.  The ICP reply MUST not be delayed while waiting
  295.       for the RTT measurement to occur.
  296.       This flag is set in an ICP reply message (ICP_OP_HIT, ICP_OP_MISS,
  297.       ICP_OP_MISS_NOFETCH, or ICP_OP_HIT_OBJ) to indicate that the low
  298.       16-bits of the Option Data field contain the measured RTT to the
  299.       host given in the requested URL.  If ICP_FLAG_SRC_RTT is clear in
  300.       the query then it MUST also be clear in the reply.  If
  301.       ICP_FLAG_SRC_RTT is set in the query, then it may or may not be
  302.       set in the reply.
  303. 4.  Security Considerations
  304.    The security issues relating to ICP are discussed in the companion
  305.    document, RFCXXXX (<draft-wessels-icp-v2-appl-01.txt>).
  306. 5.  References
  307.    [1] Fielding, R., et. al, "Hypertext Transfer Protocol -- HTTP/1.1",
  308.    RFC 2068, UC Irvine, January 1997.
  309.    [2] Berners-Lee, T., Masinter, L., and M. McCahill, "Uniform Resource
  310.    Locators (URL)", RFC 1738, CERN, Xerox PARC, University of Minnesota,
  311.    December 1994.
  312.    [3] Bowman M., Danzig P., Hardy D., Manber U., Schwartz M., and Wes-
  313.    sels D., "The Harvest Information Discovery and Access System",
  314.    Internet Research Task Force - Resource Discovery, http://har-
  315.    vest.transarc.com/.
  316. Wessels                                                         [Page 8]
  317. Internet-Draft                                             22 April 1997
  318.    [4] Wessels D., Claffy K., "ICP and the Squid Web Cache", National
  319.    Laboratory for Applied Network Research, http://www.nlanr.net/~wes-
  320.    sels/Papers/icp-squid.ps.gz
  321.    [5] Wessels D., "The Squid Internet Object Cache", National Labora-
  322.    tory for Applied Network Research, http://squid.nlanr.net/Squid/
  323. 6.  Acknowledgments
  324.    The authors wish to thank Paul A Vixie <paul@vix.com> for
  325.    providing excellent feedback on this document.
  326. 7.  Author's  Addresses:
  327.    Duane Wessels
  328.    National Laboratory for Applied Network Research
  329.    10100 Hopkins Drive
  330.    La Jolla, CA 92093
  331.    wessels@nlanr.net
  332.    K Claffy
  333.    National Laboratory for Applied Network Research
  334.    10100 Hopkins Drive
  335.    La Jolla, CA 92093
  336.    kc@nlanr.net
  337. Wessels                                                         [Page 9]