class/System/System.Net/Cookie.cs

   1 //
   2 // System.Net.Cookie.cs
   3 //
   4 // Authors:
   5 //      Lawrence Pit (loz@cable.a2000.nl)
   6 //      Gonzalo Paniagua Javier (gonzalo@ximian.com)
   7 //      Daniel Nauck    (dna(at)mono-project(dot)de)
   8 //      Sebastien Pouliot  <sebastien@ximian.com>
   9 //
  10 // Copyright (C) 2004,2009 Novell, Inc (http://www.novell.com)
  11 //
  12
  13 //
  14 // Permission is hereby granted, free of charge, to any person obtaining
  15 // a copy of this software and associated documentation files (the
  16 // "Software"), to deal in the Software without restriction, including
  17 // without limitation the rights to use, copy, modify, merge, publish,
  18 // distribute, sublicense, and/or sell copies of the Software, and to
  19 // permit persons to whom the Software is furnished to do so, subject to
  20 // the following conditions:
  21 //
  22 // The above copyright notice and this permission notice shall be
  23 // included in all copies or substantial portions of the Software.
  24 //
  25 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  29 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  30 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  31 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  32 //
  33
  34 using System;
  35 using System.Text;
  36 using System.Globalization;
  37 using System.Collections;
  38
  39 namespace System.Net {
  40
  41         // Supported cookie formats are:
  42         // Netscape: http://home.netscape.com/newsref/std/cookie_spec.html
  43         // RFC 2109: http://www.ietf.org/rfc/rfc2109.txt
  44         // RFC 2965: http://www.ietf.org/rfc/rfc2965.txt
  45         [Serializable]
  46         public sealed class Cookie
  47         {
  48                 string comment;
  49                 Uri commentUri;
  50                 bool discard;
  51                 string domain;
  52                 DateTime expires;
  53                 bool httpOnly;
  54                 string name;
  55                 string path;
  56                 string port;
  57                 int [] ports;
  58                 bool secure;
  59                 DateTime timestamp;
  60                 string val;
  61                 int version;
  62
  63                 static char [] reservedCharsName = new char [] {' ', '=', ';', ',', '\n', '\r', '\t'};
  64                 static char [] portSeparators = new char [] {'"', ','};
  65                 static string tspecials = "()<>@,;:\\\"/[]?={} \t";   // from RFC 2965, 2068
  66
  67                 public Cookie ()
  68                 {
  69                         expires = DateTime.MinValue;
  70                         timestamp = DateTime.Now;
  71                         domain = String.Empty;
  72                         name = String.Empty;
  73                         val = String.Empty;
  74                         comment = String.Empty;
  75                         port = String.Empty;
  76                 }
  77
  78                 public Cookie (string name, string value)
  79                         : this ()
  80                 {
  81                         Name = name;
  82                         Value = value;
  83                 }
  84
  85                 public Cookie (string name, string value, string path)
  86                         : this (name, value)
  87                 {
  88                         Path = path;
  89                 }
  90
  91                 public Cookie (string name, string value, string path, string domain)
  92                         : this (name, value, path)
  93                 {
  94                         Domain = domain;
  95                 }
  96
  97                 public string Comment {
  98                         get { return comment; }
  99                         set { comment = value == null ? String.Empty : value; }
 100                 }
 101
 102                 public Uri CommentUri {
 103                         get { return commentUri; }
 104                         set { commentUri = value; }
 105                 }
 106
 107                 public bool Discard {
 108                         get { return discard; }
 109                         set { discard = value; }
 110                 }
 111
 112                 public string Domain {
 113                         get { return domain; }
 114                         set {
 115                                 if (String.IsNullOrEmpty (value)) {
 116                                         domain = String.Empty;
 117                                         ExactDomain = true;
 118                                 } else {
 119                                         domain = value;
 120                                         ExactDomain = (value [0] != '.');
 121                                 }
 122                         }
 123                 }
 124
 125                 internal bool ExactDomain { get; set; }
 126
 127                 public bool Expired {
 128                         get {
 129                                 return expires <= DateTime.Now &&
 130                                        expires != DateTime.MinValue;
 131                         }
 132                         set {
 133                                 if (value)
 134                                         expires = DateTime.Now;
 135                         }
 136                 }
 137
 138                 public DateTime Expires {
 139                         get { return expires; }
 140                         set { expires = value; }
 141                 }
 142
 143                 public bool HttpOnly {
 144                         get { return httpOnly; }
 145                         set { httpOnly = value; }
 146                 }
 147
 148                 public string Name {
 149                         get { return name; }
 150                         set {
 151                                 if (String.IsNullOrEmpty (value))
 152                                         throw new CookieException ("Name cannot be empty");
 153
 154                                 if (value [0] == '$' || value.IndexOfAny (reservedCharsName) != -1) {
 155                                         // see CookieTest, according to MS implementation
 156                                         // the name value changes even though it's incorrect
 157                                         name = String.Empty;
 158                                         throw new CookieException ("Name contains invalid characters");
 159                                 }
 160
 161                                 name = value;
 162                         }
 163                 }
 164
 165                 public string Path {
 166                         get { return (path == null) ? String.Empty : path; }
 167                         set { path = (value == null) ? String.Empty : value; }
 168                 }
 169
 170                 public string Port {
 171                         get { return port; }
 172                         set {
 173                                 if (String.IsNullOrEmpty (value)) {
 174                                         port = String.Empty;
 175                                         return;
 176                                 }
 177                                 if (value [0] != '"' || value [value.Length - 1] != '"') {
 178                                         throw new CookieException("The 'Port'='" + value + "' part of the cookie is invalid. Port must be enclosed by double quotes.");
 179                                 }
 180                                 port = value;
 181                                 string [] values = port.Split (portSeparators);
 182                                 ports = new int[values.Length];
 183                                 for (int i = 0; i < ports.Length; i++) {
 184                                         ports [i] = Int32.MinValue;
 185                                         if (values [i].Length == 0)
 186                                                 continue;
 187                                         try {
 188                                                 ports [i] = Int32.Parse (values [i]);
 189                                         } catch (Exception e) {
 190                                                 throw new CookieException("The 'Port'='" + value + "' part of the cookie is invalid. Invalid value: " + values [i], e);
 191                                         }
 192                                 }
 193                                 Version = 1;
 194                         }
 195                 }
 196
 197                 internal int [] Ports {
 198                         get { return ports; }
 199                 }
 200
 201                 public bool Secure {
 202                         get { return secure; }
 203                         set { secure = value; }
 204                 }
 205
 206                 public DateTime TimeStamp {
 207                         get { return timestamp; }
 208                 }
 209
 210                 public string Value {
 211                         get { return val; }
 212                         set {
 213                                 if (value == null) {
 214                                         val = String.Empty;
 215                                         return;
 216                                 }
 217
 218                                 // LAMESPEC: According to .Net specs the Value property should not accept
 219                                 // the semicolon and comma characters, yet it does. For now we'll follow
 220                                 // the behaviour of MS.Net instead of the specs.
 221                                 /*
 222                                 if (value.IndexOfAny(reservedCharsValue) != -1)
 223                                         throw new CookieException("Invalid value. Value cannot contain semicolon or comma characters.");
 224                                 */
 225
 226                                 val = value;
 227                         }
 228                 }
 229
 230                 public int Version {
 231                         get { return version; }
 232                         set {
 233                                 if ((value < 0) || (value > 10))
 234                                         version = 0;
 235                                 else
 236                                         version = value;
 237                         }
 238                 }
 239
 240                 public override bool Equals (Object obj)
 241                 {
 242                         System.Net.Cookie c = obj as System.Net.Cookie;
 243
 244                         return c != null &&
 245                                String.Compare (this.name, c.name, true, CultureInfo.InvariantCulture) == 0 &&
 246                                String.Compare (this.val, c.val, false, CultureInfo.InvariantCulture) == 0 &&
 247                                String.Compare (this.Path, c.Path, false, CultureInfo.InvariantCulture) == 0 &&
 248                                String.Compare (this.domain, c.domain, true, CultureInfo.InvariantCulture) == 0 &&
 249                                this.version == c.version;
 250                 }
 251
 252                 public override int GetHashCode ()
 253                 {
 254                         return hash(CaseInsensitiveHashCodeProvider.DefaultInvariant.GetHashCode(name),
 255                                     val.GetHashCode (),
 256                                     Path.GetHashCode (),
 257                                     CaseInsensitiveHashCodeProvider.DefaultInvariant.GetHashCode (domain),
 258                                     version);
 259                 }
 260
 261                 private static int hash (int i, int j, int k, int l, int m)
 262                 {
 263                         return i ^ (j << 13 | j >> 19) ^ (k << 26 | k >> 6) ^ (l << 7 | l >> 25) ^ (m << 20 | m >> 12);
 264                 }
 265
 266                 // returns a string that can be used to send a cookie to an Origin Server
 267                 // i.e., only used for clients
 268                 // see para 4.2.2 of RFC 2109 and para 3.3.4 of RFC 2965
 269                 // see also bug #316017
 270                 public override string ToString ()
 271                 {
 272                         return ToString (null);
 273                 }
 274
 275                 internal string ToString (Uri uri)
 276                 {
 277                         if (name.Length == 0)
 278                                 return String.Empty;
 279
 280                         StringBuilder result = new StringBuilder (64);
 281
 282                         if (version > 0)
 283                                 result.Append ("$Version=").Append (version).Append ("; ");
 284
 285                         result.Append (name).Append ("=").Append (val);
 286
 287                         if (version == 0)
 288                                 return result.ToString ();
 289
 290                         if (!String.IsNullOrEmpty (path))
 291                                 result.Append ("; $Path=").Append (path);
 292                         else if (uri != null)
 293                                 result.Append ("; $Path=/").Append (path);
 294
 295                         bool append_domain = (uri == null) || (uri.Host != domain);
 296                         if (append_domain && !String.IsNullOrEmpty (domain))
 297                                 result.Append ("; $Domain=").Append (domain);
 298
 299                         if (port != null && port.Length != 0)
 300                                 result.Append ("; $Port=").Append (port);
 301
 302                         return result.ToString ();
 303                 }
 304
 305                 internal string ToClientString ()
 306                 {
 307                         if (name.Length == 0)
 308                                 return String.Empty;
 309
 310                         StringBuilder result = new StringBuilder (64);
 311
 312                         if (version > 0)
 313                                 result.Append ("Version=").Append (version).Append (";");
 314
 315                         result.Append (name).Append ("=").Append (val);
 316
 317                         if (path != null && path.Length != 0)
 318                                 result.Append (";Path=").Append (QuotedString (path));
 319
 320                         if (domain != null && domain.Length != 0)
 321                                 result.Append (";Domain=").Append (QuotedString (domain));
 322
 323                         if (port != null && port.Length != 0)
 324                                 result.Append (";Port=").Append (port);
 325
 326                         return result.ToString ();
 327                 }
 328
 329                 // See par 3.6 of RFC 2616
 330                 string QuotedString (string value)
 331                 {
 332                         if (version == 0 || IsToken (value))
 333                                 return value;
 334                         else
 335                                 return "\"" + value.Replace("\"", "\\\"") + "\"";
 336                 }
 337
 338                 bool IsToken (string value)
 339                 {
 340                         int len = value.Length;
 341                         for (int i = 0; i < len; i++) {
 342                                 char c = value [i];
 343                                 if (c < 0x20 || c >= 0x7f || tspecials.IndexOf (c) != -1)
 344                                         return false;
 345                         }
 346                         return true;
 347                 }
 348         }
 349 }
 350