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