3cf0eb9441d4205c3245b583f670dc65a7a770f0
[infodrom/cgilib] / cookies.txt
1 Internet Cookies
2 ================
3
4 This gives a short overview about cookies in general and their
5 implementation in the CGI library in detail.  The use of cookies is
6 described in two partially different ways.  Netscape has released
7 their standard and an RFC (2109) has been filed from Bell Labs.  Both
8 documents are found through "More Information".
9
10 Server Side
11 -----------
12
13   The server initiates a session by sending a cookie to the client.
14   The server may transmit one or more cookies by using the additional
15   HTTP header "Set-Cookie" like
16
17      Set-Cookie: foo=bar; Version=1; Path=/foo; Domain=.foo.org
18
19   This cookie would only be available within any host that matches
20   *.foo.org.  According to RFC 2109 * may not contain a dot, according
21   to Netscape's documentation it may.  The client would only send the
22   cookie back to the server if the URL is within /foo on that server.
23
24   When more than one cookie are to be transmitted they are separated
25   with a comma.  Attributes are separated with a semicolon.
26
27   If the current URL doesn't match the Path attribute or the hostname
28   doesn't match the Domain attribute, the client will ignore the
29   cookie.
30
31 Client Side
32 -----------
33
34   When the client requests a web page, it checks if the location is
35   within the scope of one or more cookies.  If so it sends them, ordered
36   by the most matching one, like:
37
38      Cookie: $Version=1; foo=bar; $path=/; bar=foo; $path=/foo
39
40   Attributes belong to the most left name=value pair.  Attributes
41   specified before such a pair are valid for all subsequent cookies.
42
43 Syntax
44 ------
45
46      Cookie        ::= <header> ":" <attr> *( ";" <attr> )
47      <header>      ::= "Cookie" | "Set-Cookie"
48      <attr>        ::= <attr-name> [ "=" <value> ]
49      <attr-name>   ::= <token>
50      <value>       ::= <token> | <quoted-string>
51      <token>       ::= sequence of non-special, non-white space characters
52
53   Attribut names (<attr-name>) are case-insensitive.  Spaces may be
54   used between tokens and within attribute values.  Some attributes
55   don't require a value.
56
57   The Set-Cookie header uses these attributes:
58
59      <cookie>        ::= NAME "=" VALUE *( ";" <attr> )   # required
60      <attr>          ::= "Comment" "=" value              # optional
61                        | "Domain" "=" value               # optional
62                        | "Max-Age" "=" value              # optional
63                        | "Path" "=" value                 # optional
64                        | "Secure"                         # optional
65                        | "Version" "=" 1*DIGIT            # required
66
67   Apart from the cookie itself as NAME "=" VALUE the Cookie header as
68   sent by the client uses only $Version, $Path and $Domain which are
69   both optional.  The value of the Version attribute must be the value
70   from the Version attribute, if any, of the corresponding Set-Cookie
71   response header.
72
73      <cookie>        ::= <version> *( ( ";" | "," ) <cookie-value> )
74      <cookie-value>  ::= NAME "=" VALUE [";" <path>] [";" <domain>]
75      <path>          ::= "$Path" "=" value
76      <domain>        ::= "$Domain" "=" value
77
78    Note: For backward compatibility, the separator in the Cookie
79    header is semi-colon (;) everywhere.  A server should also accept
80    comma (,) as the separator between cookie-values for future
81    compatibility.
82
83   
84 More Information
85 ----------------
86
87   If you want to find out more about cookies, please go to
88   http://www.infodrom.north.de/linx/ and search for "cookie".