| HTTP Working Group David M. Kristol INTERNET DRAFT AT&T Bell Laboratories Lou Montulli Netscape Communications Feb. 21, 1996 Expires August 21, 1996 Proposed HTTP State Management Mechanism Status of this Memo This document is an Internet-Draft. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet- Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet- Drafts as reference material or to cite them other than as ``work in progress.'' To learn the current status of any Internet-Draft, please check the ``1id-abstracts.txt'' listing contained in the Internet- Drafts Shadow Directories on ftp.is.co.za (Africa), nic.nordu.net (Europe), munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or ftp.isi.edu (US West Coast). This is authors' draft 2.6. | 1. ABSTRACT HTTP, the protocol that underpins the World-Wide Web (WWW), is stateless. That is, each request stands on its own; origin servers don't need to remember what happened with previous requests to service a new one. Statelessness is a mixed blessing, because there are potential WWW applications, like ``shopping baskets'' and library browsing, for which the history of a user's actions is useful or essential. This proposal outlines a way to introduce state into HTTP. New request and response headers, Cookie and Set-Cookie, carry the state back and forth, thus relieving the origin server from needing to keep an extensive per-user or per-connection database. The changes required to user agents, origin servers, and proxy servers to support state management are modest. | This proposal, while very similar to Netscape's original state | management (``Cookie'') proposal, differs slightly and incompatibly. It | assumes that origin servers, proxies, and user agents use the HTTP/1.1 | protocol. However, it can interoperate with HTTP/1.0 agents. (See the | Kristol draft-kristol-http-state-mgmt-00.txt [Page 1] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 HISTORICAL section.) 2. TERMINOLOGY The terms user agent, client, server, proxy, and origin server have the same meaning as in the HTTP/1.0 specification. Fully-qualified host name (FQHN) means either the numeric IP address of | a host, or its full Internet domain name, resolved to a top-level domain | such as .com or .uk. | The terms request-host and request-URI refer to the values the client | would send to the server in, respectively, the Host header and the | Request-URI portion of the HTTP request line. | Hosts can be specified either as an IP address or a FQHN string. | Sometimes we compare one host with another. Host A host-matches host B | if | +o both hosts are IP addresses and their host strings match exactly; | or | +o both hosts are FQHN strings and their host strings match exactly; | or | +o both hosts are FQHN strings and host A's string has the form N.B, | where B is host B's FQHN string, and N is a name string that may | include embedded dots. | Because it was used in Netscape's original implementation of state management, we will use the term cookie to refer to the state information that passes between an origin server and user agent, and that gets stored by the user agent. 3. STATE AND SESSIONS This proposal outlines how to introduce state into HTTP, the protocol that underpins the World-Wide Web (WWW). At present, HTTP is stateless: a WWW origin server obtains everything it needs to know about a request from the request itself. After it processes the request, the origin server can ``forget'' the transaction. What do we mean by ``state?'' ``State'' implies some relation between one request to an origin server and previous ones made by the same user agent to the same origin server. If the sequence of these requests is considered as a whole, they can be thought of as a ``session.'' Koen Holtman identified these dimensions for the ``solution space'' of stateful dialogs: Kristol draft-kristol-http-state-mgmt-00.txt [Page 2] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 +o simplicity of implementation +o simplicity of use +o time of general availability when standardized +o downward compatibility +o reliability +o amount of privacy protection +o maximum complexity of stateful dialogs supported +o amount of cache control possible +o risks when used with non-conforming caches The paradigm we have in mind obtains the same effect as if a user agent connected to an origin server, carried out many transactions at the user's direction, then disconnected. Two example applications we have in mind are a ``shopping cart,'' where the state information comprises what the user has bought, and a magazine browsing system, where the state information comprises the set of journals and articles the user has looked at already. Note some of the key points in the session paradigm: 1. The session has a beginning and an end. 2. The session is relatively short-lived. 3. Either the user agent or the origin server may terminate a session. There is no defined mechanism to inform the origin | server that the user agent has terminated a session. 4. State is a property of the session. The user agent can receive, | store, and send cookies that reflect this state. 4. PROPOSAL OUTLINE The proposal we outline here defines a way for an origin server to send state information to the user agent, and for the user agent to return the state information to the origin server. The goal of the proposal is to have a minimal impact on HTTP and user agents. Only origin servers that need to maintain sessions would suffer any significant impact, and that impact can largely be confined to Common Gateway Interface (CGI) programs, unless the server provides more sophisticated state management support. (See Implementation Considerations, below.) Kristol draft-kristol-http-state-mgmt-00.txt [Page 3] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 4.1 Syntax: General The two state management headers, Set-Cookie and Cookie, have common syntactic properties involving attribute-value pairs. The following uses the notation and tokens ALPHA (lower and upper case letters), DIGIT (decimal digits), and word (informally, a "-quoted string or sequence of non-special, non-white space characters) from the HTTP/1.1 specification | to describe their syntax. av-pairs = av-pair *(";" av-pair) | av-pair = attr 0,1*("=" value) ; optional value | attr = ALPHA *(ALPHA | DIGIT) | value = word | Attributes (attr) are case-insensitive. White space is permitted | between tokens. Note that while the above syntax description shows | value as optional, most attrs require them. | NOTE: The syntax above allows space between the attribute and the = | sign. 4.2 Origin Server Role 4.2.1 General The origin server initiates a session, if it so desires. (Note that ``session'' here is a logical connection, not a physical one. Don't confuse these logical sessions with various ``keepalive'' proposals for physical sessions.) To initiate a session, the origin server returns an extra response header to the client, Set-Cookie. (The details follow later.) A user agent returns a Cookie request header (see below) to the origin server if it chooses to continue a session. The origin server may ignore it or use it to determine the current state of the session. It may send back to the client a Set-Cookie response header with the same or different information, or it may send no Set-Cookie header at all. The origin server effectively ends a session by sending back a Set- Cookie header that has a null value. An origin server must be cognizant of the effect of possible caching by other agents of its responses that have a Set-Cookie header. Generally a document that has associated state information should not be cached: the cached resource or Set-Cookie may be specific to a particular user agent. The origin server must explicitly notify upstream agents not to cache them. To inhibit caching, the origin server should use one of the | standard mechanisms that inhibit document caching, such as Cache- control: no-cache or Expires: . Additionally, it's hard to imagine a circumstance in which the Set- | Cookie header itself should be cached. So servers should send a Cache- | Control: no-cache="set-cookie" response header to suppress its caching.. | Kristol draft-kristol-http-state-mgmt-00.txt [Page 4] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 An origin server may include multiple Set-Cookie headers in a response. | Note that an intervening gateway could fold multiple such headers into a | single header. 4.2.2 Set-Cookie Syntax The syntax for the Set-Cookie response header is | set-cookie = "Set-Cookie:" cookies | cookies = cookie *("," cookie) | cookie = NAME "=" VALUE *(";" cookie-av) | NAME = attr | VALUE = value | cookie-av = "Domain" "=" value | | "Max-Age" "=" value | | "Path" "=" value | | "Secure" | Informally, the Set-Cookie response header comprises the token Set- Cookie:, followed by a comma-separated list of one or more cookies. | Each cookie begins with a NAME=VALUE pair, followed by zero or more | semi-colon-separated attribute-value pairs. The syntax for attribute- | value pairs was shown earlier. The specific attributes and the semantics of their values follows. The NAME=VALUE attribute-value pair | must come first in each cookie. The others, if present, can occur in | any order. If an attribute appears more than once in a cookie, the | behavior is undefined. NAME=VALUE Required. The name of the state information (``cookie'') is NAME, and its value is VALUE. The VALUE is opaque and may be anything the origin server chooses to send, possibly in a server-selected printable ASCII encoding. ``Opaque'' implies that the content is of interest and relevance only to the origin server. The content may, in fact, be readable by anyone that examines the Set-Cookie header. * Domain=domain Optional. The Domain attribute specifies the host and domain name for which the cookie is valid. | Max-Age=delta-seconds | Optional. The Max-Age attribute defines the lifetime of the | cookie, in seconds. The delta-seconds value is a decimal non- | negative integer. After delta-seconds seconds elapse, the client | should discard the cookie. A value of zero means the cookie should | be discarded immediately. Path=path Optional. The Path attribute specifies the subset of URLs to which this cookie applies. Kristol draft-kristol-http-state-mgmt-00.txt [Page 5] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 Secure Optional. The Secure attribute (with no value) directs the user agent only to use (unspecified) secure means to contact the origin server whenever it sends back this cookie. 4.3 User Agent Role 4.3.1 Interpreting Set-Cookie The user agent keeps separate track of state information that arrives via Set-Cookie response headers from each origin server (as distinguished by name or IP address and port). The user agent applies these defaults for optional attributes that are missing: Domain Defaults to the host name of the server that generated the | response. | QUESTION: exactly how is this determined? From the URL? (May | not be completely specified.) | Max-AgeThe default behavior is to discard the cookie when the user agent | exits. Path Defaults to the path of the request URL that generated the Set- Cookie response. QUESTION: Don't we really mean the prefix? For example, if the URL were /a/b/x.html, the Path attribute would default to /a/b, I presume. | Secure If absent, the user agent may send the cookie over an insecure channel. 4.3.2 Rejecting Cookies A user agent rejects a cookie (shall not store | its information) if any of the following is true: | +o The value for the Path attribute is not a prefix of the request- | URI; or | +o The value for the Domain attribute does not host-match the | request-host. | 4.3.3 Cookie Management If a user agent receives a Set-Cookie response | header whose NAME=VALUE, Domain, and Path attribute values exactly match | those of a pre-existing cookie, the new one supercedes the old. However, if the Set-Cookie has a value for Max-Age of zero, the (old and | new) cookie is discarded. Otherwise cookies accumulate until they expire (resources permitting), at which time they are discarded. Because user agents have finite space in which to store cookies, they may also discard older cookies to make space for newer ones, using, for | example, a least-recently-used algorithm, along with constraints on the | maximum number of cookies that each origin server may set. Kristol draft-kristol-http-state-mgmt-00.txt [Page 6] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 Privacy considerations dictate that the user have considerable control over cookie management. The PRIVACY section contains more information. 4.3.4 Sending Cookies to the Origin Server When it sends a request to an origin server, the user agent sends a Cookie request header to the origin server if it has cookies that are applicable to the request, based on +o the origin server's fully-qualified host name; | +o the request URL; +o the cookie's age. | The syntax for the header is Cookie: followed by a semi-colon-separated list of the NAME=VALUE pairs for the applicable cookies. These rules apply to choosing applicable cookies from among all the cookies the user agent has. Domain Selection The Domain attribute of the cookie must host-match the origin | server's fully-qualified host name. Path Selection The Path attribute of the cookie must match a prefix of the request | URI. | Max-Age Selection Cookies that have expired should have been discarded and are thus not forwarded to an origin server. 4.3.5 Sending Cookies in Unverifiable Transactions A transaction is | verifiable if the user has the option to review the request-URI prior to | its use in the transaction. A transaction is unverifiable if the user | does not have that option. User agents typically use unverifiable | transactions when they automatically get inlined entities or when they | resolve redirection (3xx) responses. Typically the origin transaction, | the transaction that the user initiates, is verifiable, and that | transaction directly or indirectly causes the user agent to make | unverifiable transactions. | The following rule eases the implementation of user agent mechanisms | that give the user control over sessions (see PRIVACY section) by | restricting the number of cases where control is needed. The rule | prevents malicious service authors from using unverifiable transactions | to induce a user agent to start or continue a session with a server in a | different domain. The starting or continuation of such sessions could | be contrary to the privacy expectations of the user, and could also be a | security problem. | Kristol draft-kristol-http-state-mgmt-00.txt [Page 7] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 When it makes an unverifiable transaction, a user agent must only enable | the cookie functionality, that is the sending of Cookie request headers | and the processing of any Set-Cookie response headers, if a cookie with | a domain attribute D was sent or received in its origin transaction, | such that the host name in the Request-URI of the unverifiable | transaction host-matches D. | User agents may offer configurable options that allow the user agent, or | any autonomous programs that the user agent executes, to ignore the | above rule, so long as these override options default to ``off.'' | NB: Many current user agents already provide an acceptable review | option that would render many links verifiable. | +o When the mouse is over a link, the user agents display the link | that would be followed. | +o By letting a user view source, or save and examine source, the user | agents let a user examine the link that would be followed when a | form's submit button is selected. | +o When automatic image loading is disabled, users can review the | links that correspond to images by using one of the above | techniques. However, if automatic image loading is enabled, those | links would be unverifiable. | 4.4 Caching Proxy Role One reason for separating state information from both a URL and document content is to facilitate the scaling that caching permits. To support cookies, a caching proxy must obey these rules already in the HTTP specification: +o Honor requests from the cache, if possible, based on cache validity rules. +o Pass along a Cookie request header in any request that the proxy | must make of another server. | +o Return the response to the client. Include any Set-Cookie response | header. +o Cache the received response subject to the control of the usual headers, such as Expires, Cache-control: no-cache, and Cache- control: private, | +o Cache the Set-Cookie subject to the control of the usual header, | Cache-control: no-cache="set-cookie". (Usually the Set-Cookie | header should not be cached.) Kristol draft-kristol-http-state-mgmt-00.txt [Page 8] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 5. EXAMPLES 5.1 Example 1 Most detail of request and response headers has been omitted. Assume the user agent has no stored cookies. 1. User Agent -> Server POST /acme/login HTTP/1.0 [form data] User identifies self. 2. Server -> User Agent HTTP/1.0 200 OK Set-Cookie: Customer="WILE_E_COYOTE"; Path="/acme" | Cookie reflects user's identity. 3. User Agent -> Server POST /acme/pickitem HTTP/1.0 Cookie: Customer="WILE_E_COYOTE" [form data] User selects an item for ``shopping basket.'' 4. Server -> User Agent HTTP/1.0 200 OK Set-Cookie: Part_Number="Rocket_Launcher_0001"; Path="/acme" | Shopping basket contains an item. 5. User Agent -> Server POST /acme/shipping HTTP/1.0 Cookie: Customer="WILE_E_COYOTE"; Part_Number="Rocket_Launcher_0001" User selects shipping method from form. 6. Server -> User Agent HTTP/1.0 200 OK Set-Cookie: Shipping="FedEx"; Path="/acme" | New cookie reflects shipping method. Kristol draft-kristol-http-state-mgmt-00.txt [Page 9] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 7. User Agent -> Server POST /acme/process HTTP/1.0 Cookie: Customer="WILE_E_COYOTE"; Part_Number="Rocket_Launcher_0001";| Shipping="FedEx" | [form data] User chooses to process order. 8. Server -> User Agent HTTP/1.0 200 OK Transaction is complete. The user agent makes a series of requests on the origin server, after each of which it receives a new cookie. All the cookies have the same Path attribute and (default) domain. Because the request URLs all have /acme as a prefix, and that matches the Path attribute, each request contains all the cookies received so far. 5.2 Example 2 This example illustrates the effect of the Path attribute. All detail of request and response headers has been omitted. Assume the user agent has no stored cookies. Imagine the user agent has received, in response to earlier requests, the response headers Set-Cookie: Part_Number="Rocket_Launcher_0001"; Path="/acme" | and Set-Cookie: Part_Number="Riding_Rocket_0023"; Path="/acme/ammo" | A subsequent request by the user agent to the (same) server for URLs of the form /acme/ammo/... would include the following request header: Cookie: Part_Number="Riding_Rocket_0023"; Part_Number="Rocket_Launcher_0001" Note that the NAME=VALUE pair for the cookie with the more specific Path attribute comes before the one with the less specific Path attribute. Further note that the same cookie name appears more than once. A subsequent request by the user agent to the (same) server for URLs of the form /acme/... (assuming ... did not have the prefix ammo) would include the following request header: Kristol draft-kristol-http-state-mgmt-00.txt [Page 10] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 Cookie: Part_Number="Rocket_Launcher_0001" Here, the second cookie's Path attribute /acme/ammo is not a prefix of the request URL, so the cookie does not get forwarded to the server. 6. IMPLEMENTATION CONSIDERATIONS Here we speculate on likely or desirable details for an origin server that implements state management. 6.1 Set-Cookie Content An origin server's content should probably be divided into disjoint application areas, some of which require the use of state information. The application areas can be distinguished by their request URLs. The Set-Cookie header can incorporate information about the application areas by setting the Path attribute for each one. The session information can obviously be clear or encoded text that describes state. However, if it grows too large, it can become unwieldy. Therefore, an implementor might choose for the session information to be a key into a server-side database. Of course, using a database creates some problems that the state management proposal was meant to avoid, namely: 1. keeping real state on the server side; 2. how and when to garbage-collect the database entry, in case the user agent terminates the session by, for example, exiting. 6.2 Stateless Pages Caching benefits the scalability of WWW. Therefore it is important to | reduce the number of documents that have state embedded in them inherently. For example, if a shopping-basket-style application always displayed a user's current basket contents on each page, those pages could not be cached, because each user's basket's contents would be different. On the other hand, if each page contained just a link that allowed the user to ``Look at My Shopping Basket,'' the page could be cached. 6.3 Implementation Limits Practical user agent implementations have limits on the number and size of cookies that they can store. In general, user agents' cookie support should have no fixed limits. Furthermore, they should provide the following minimum capabilities: +o at least 300 cookies Kristol draft-kristol-http-state-mgmt-00.txt [Page 11] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 +o at least 4096 bytes per cookie (as measured by the size of the | characters that comprise the cookie non-terminal in the syntax | description of the Set-Cookie header) +o at least 20 cookies per unique host or domain name The information in a Set-Cookie response header must be retained in its entirety. If for some reason there is inadequate space to store the cookie, it must be discarded, not truncated. 6.3.1 Denial of Service Attacks User agents may choose to set an upper bound on the number of cookies to be stored from a given host or domain name or on the size of the cookie information. Otherwise a malicious server could attempt to flood a user agent with many cookies, or large cookies, on successive responses, which would force out cookies the user agent had received from other servers. However, the minima specified above must still be supported. 7. PRIVACY An origin server could create a Set-Cookie header to track the path of a user through the server. Users may object to this behavior as an intrusive accumulation of information, even if their identity is not evident. (Identity might become evident if a user subsequently fills out a form that contains identifying information.) The state management proposal therefore requires that a user agent give the user control over | such a possible intrusion, although the choice of mechanisms is | unspecified. However, the control mechanisms provided shall at least | allow the user +o to completely disable the sending of cookies. | +o to determine whether a stateful session is in progress. | +o to control the saving of a cookie on the basis of the cookie's | Domain attribute. | Such control could be provided by, for example, mechanisms | +o to notify the user when the user agent is about to send a cookie to | the origin server, offering the option not to begin a session. | +o to display a visual indication that a stateful session is in | progress. | +o to let the user decide which cookies, if any, should be saved when | the user concludes a window or user agent session. | +o to let the user examine the contents of a cookie at any time. Kristol draft-kristol-http-state-mgmt-00.txt [Page 12] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 A user agent usually begins execution with no remembered state | information. It should be possible to configure a user agent never to send Cookie headers, in which case it can never sustain state with an origin server. (The user agent would then behave like one that is unaware of how to handle Set-Cookie response headers.) When the user agent terminates execution, it should let the user discard all state information. Alternatively, the user agent may ask the user whether state information should be retained; the default should be ``no.'' Retained state information would then be restored the next time | the user agent runs. NOTE: User agents should probably be cautious about using files to store * cookies long-term. If a user runs more than one instance of the user agent, the cookies could be comingled or otherwise messed up. 8. SECURITY CONSIDERATIONS The information in the Set-Cookie and Cookie headers is unprotected. Two consequences are: 1. Any sensitive information that is conveyed in them is exposed to intruders. 2. A malicious intermediary could alter the headers as they travel in either direction, with unpredictable results. These facts imply that information of a personal and/or financial nature should only be sent over a secure channel. For less sensitive information, or when the content of the header is a database key, an origin server should be vigilant to prevent a bad Cookie value from | causing failures. 9. OTHER, SIMILAR, PROPOSALS Three other proposals have been made to accomplish similar goals. This proposal is an amalgam of Kristol's State-Info proposal and Netscape's Cookie proposal. Brian Behlendorf proposed a Session-ID header that would be user-agent- initiated and could be used by an origin server to track ``clickstreams.'' It would not carry any origin-server-defined state, however. | Kristol draft-kristol-http-state-mgmt-00.txt [Page 13] INTERNET DRAFT Proposed HTTP State Management Mechanism Feb. 21, 1996 10. HISTORICAL | HTTP/1.0 clients and servers may use Set-Cookie and Cookie headers that | reflect Netscape's original Cookie proposal. That proposal defined an | Expires header that took a date value in a fixed-length variant format | in place of Max-Age. Furthermore, the values in attribute-value pairs | did not accept "-quoted strings. To interoperate successfully, HTTP/1.1 | agents should adjust their behavior when they receive/send Cookie or | Set-Cookie headers from/to HTTP/1.0 agents. 11. ACKNOWLEDGEMENTS This document really represents the collective efforts of the following people, in addition to the authors: Roy Fielding, Marc Hedlund, Koen Holtman, Shel Kaphan, Rohit Khare. 12. AUTHORS' ADDRESSES David M. Kristol AT&T Bell Laboratories 600 Mountain Ave. Room 2A-227 Murray Hill, NJ 07974 Phone: (908) 582-2250 FAX: (908) 582-5809 Email: dmk@research.att.com Lou Montulli Netscape Communications Corp. 501 E. Middlefield Rd. Mountain View, CA 94043 Phone: (908) 528-2600 Email: montulli@netscape.com Kristol draft-kristol-http-state-mgmt-00.txt [Page 14]