2 // System.Web.Security.FormsAuthentication
5 // Gonzalo Paniagua Javier (gonzalo@ximian.com)
7 // (C) 2002,2003 Ximian, Inc (http://www.ximian.com)
8 // Copyright (c) 2005 Novell, Inc (http://www.novell.com)
12 // Permission is hereby granted, free of charge, to any person obtaining
13 // a copy of this software and associated documentation files (the
14 // "Software"), to deal in the Software without restriction, including
15 // without limitation the rights to use, copy, modify, merge, publish,
16 // distribute, sublicense, and/or sell copies of the Software, and to
17 // permit persons to whom the Software is furnished to do so, subject to
18 // the following conditions:
20 // The above copyright notice and this permission notice shall be
21 // included in all copies or substantial portions of the Software.
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 using System.Collections;
34 using System.Security.Cryptography;
35 using System.Security.Permissions;
38 using System.Web.Configuration;
39 using System.Web.Util;
40 using System.Globalization;
42 namespace System.Web.Security
44 // CAS - no InheritanceDemand here as the class is sealed
45 [AspNetHostingPermission (SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
46 public sealed class FormsAuthentication
48 const int MD5_hash_size = 16;
49 const int SHA1_hash_size = 20;
51 static string authConfigPath = "system.web/authentication";
52 static string machineKeyConfigPath = "system.web/machineKey";
54 const string Forms_initialized = "Forms.initialized";
55 const string Forms_cookieName = "Forms.cookieName";
56 const string Forms_cookiePath = "Forms.cookiePath";
57 const string Forms_timeout = "Forms.timeout";
58 const string Forms_protection = "Forms.protection";
59 const string Forms_init_vector = "Forms.init_vector";
60 static bool initialized
63 object o = AppDomain.CurrentDomain.GetData (Forms_initialized);
64 return o != null ? (bool) o : false;
66 set { AppDomain.CurrentDomain.SetData (Forms_initialized, value); }
68 static string cookieName
70 get { return (string) AppDomain.CurrentDomain.GetData (Forms_cookieName); }
71 set { AppDomain.CurrentDomain.SetData (Forms_cookieName, value); }
73 static string cookiePath
75 get { return (string) AppDomain.CurrentDomain.GetData (Forms_cookiePath); }
76 set { AppDomain.CurrentDomain.SetData (Forms_cookiePath, value); }
81 object o = AppDomain.CurrentDomain.GetData (Forms_timeout);
82 return o != null ? (int) o : 0;
84 set { AppDomain.CurrentDomain.SetData (Forms_timeout, value); }
86 static FormsProtectionEnum protection
88 get { return (FormsProtectionEnum) AppDomain.CurrentDomain.GetData (Forms_protection); }
89 set { AppDomain.CurrentDomain.SetData (Forms_protection, value); }
91 static byte [] init_vector
93 get { return (byte []) AppDomain.CurrentDomain.GetData (Forms_init_vector); }
94 set { AppDomain.CurrentDomain.SetData (Forms_init_vector, value); }
96 static object locker = new object ();
98 static bool initialized;
99 static string cookieName;
100 static string cookiePath;
102 static FormsProtectionEnum protection;
103 static object locker = new object ();
104 static byte [] init_vector; // initialization vector used for 3DES
108 const string Forms_requireSSL = "Forms.requireSSL";
109 const string Forms_slidingExpiration = "Forms.slidingExpiration";
111 static bool requireSSL
114 object o = AppDomain.CurrentDomain.GetData (Forms_requireSSL);
115 return o != null ? (bool) o : false;
117 set { AppDomain.CurrentDomain.SetData (Forms_requireSSL, value); }
119 static bool slidingExpiration
122 object o = AppDomain.CurrentDomain.GetData (Forms_slidingExpiration);
123 return o != null ? (bool) o : false;
125 set { AppDomain.CurrentDomain.SetData (Forms_slidingExpiration, value); }
128 static bool requireSSL;
129 static bool slidingExpiration;
134 const string Forms_cookie_domain = "Forms.cookie_domain";
135 const string Forms_cookie_mode = "Forms.cookie_mode";
136 const string Forms_cookies_supported = "Forms.cookies_supported";
137 const string Forms_default_url = "Forms.default_url";
138 const string Forms_enable_crossapp_redirects = "Forms.enable_crossapp_redirects";
139 const string Forms_login_url = "Forms.login_url";
140 static string cookie_domain
142 get { return (string) AppDomain.CurrentDomain.GetData (Forms_cookie_domain); }
143 set { AppDomain.CurrentDomain.SetData (Forms_cookie_domain, value); }
145 static HttpCookieMode cookie_mode
147 get { return (HttpCookieMode) AppDomain.CurrentDomain.GetData (Forms_cookie_mode); }
148 set { AppDomain.CurrentDomain.SetData (Forms_cookie_mode, value); }
150 static bool cookies_supported
153 object o = AppDomain.CurrentDomain.GetData (Forms_cookies_supported);
154 return o != null ? (bool) o : false;
156 set { AppDomain.CurrentDomain.SetData (Forms_cookies_supported, value); }
158 static string default_url
160 get { return (string) AppDomain.CurrentDomain.GetData (Forms_default_url); }
161 set { AppDomain.CurrentDomain.SetData (Forms_default_url, value); }
163 static bool enable_crossapp_redirects
166 object o = AppDomain.CurrentDomain.GetData (Forms_enable_crossapp_redirects);
167 return o != null ? (bool) o : false;
169 set { AppDomain.CurrentDomain.SetData (Forms_enable_crossapp_redirects, value); }
171 static string login_url
173 get { return (string) AppDomain.CurrentDomain.GetData (Forms_login_url); }
174 set { AppDomain.CurrentDomain.SetData (Forms_login_url, value); }
177 static string cookie_domain;
178 static HttpCookieMode cookie_mode;
179 static bool cookies_supported;
180 static string default_url;
181 static bool enable_crossapp_redirects;
182 static string login_url;
185 // same names and order used in xsp
186 static string [] indexFiles = { "index.aspx",
192 public FormsAuthentication ()
196 public static bool Authenticate (string name, string password)
198 if (name == null || password == null)
202 HttpContext context = HttpContext.Current;
204 throw new HttpException ("Context is null!");
206 name = name.ToLower ();
208 AuthenticationSection section = (AuthenticationSection) WebConfigurationManager.GetSection (authConfigPath);
209 FormsAuthenticationCredentials config = section.Forms.Credentials;
210 FormsAuthenticationUser user = config.Users[name];
211 string stored = null;
214 stored = user.Password;
216 AuthConfig config = context.GetConfig (authConfigPath) as AuthConfig;
217 Hashtable users = config.CredentialUsers;
218 string stored = users [name] as string;
223 switch (config.PasswordFormat) {
224 case FormsAuthPasswordFormat.Clear:
227 case FormsAuthPasswordFormat.MD5:
228 password = HashPasswordForStoringInConfigFile (password, "MD5");
230 case FormsAuthPasswordFormat.SHA1:
231 password = HashPasswordForStoringInConfigFile (password, "SHA1");
235 return (password == stored);
238 static FormsAuthenticationTicket Decrypt2 (byte [] bytes)
240 if (protection == FormsProtectionEnum.None)
241 return FormsAuthenticationTicket.FromByteArray (bytes);
244 MachineKeySection config = (MachineKeySection) WebConfigurationManager.GetSection (machineKeyConfigPath);
246 MachineKeyConfig config = HttpContext.GetAppConfig (machineKeyConfigPath) as MachineKeyConfig;
248 bool all = (protection == FormsProtectionEnum.All);
250 byte [] result = bytes;
251 if (all || protection == FormsProtectionEnum.Encryption) {
252 ICryptoTransform decryptor;
253 decryptor = TripleDES.Create ().CreateDecryptor (config.DecryptionKey192Bits, init_vector);
254 result = decryptor.TransformFinalBlock (bytes, 0, bytes.Length);
258 if (all || protection == FormsProtectionEnum.Validation) {
260 MachineKeyValidation validationType;
263 validationType = config.Validation;
265 validationType = config.ValidationType;
267 if (validationType == MachineKeyValidation.MD5)
268 count = MD5_hash_size;
270 count = SHA1_hash_size; // 3DES and SHA1
273 byte [] vk = config.ValidationKeyBytes;
275 byte [] vk = config.ValidationKey;
277 byte [] mix = new byte [result.Length - count + vk.Length];
278 Buffer.BlockCopy (result, 0, mix, 0, result.Length - count);
279 Buffer.BlockCopy (vk, 0, mix, result.Length - count, vk.Length);
282 switch (validationType) {
283 case MachineKeyValidation.MD5:
284 hash = MD5.Create ().ComputeHash (mix);
286 // From MS docs: "When 3DES is specified, forms authentication defaults to SHA1"
287 case MachineKeyValidation.TripleDES:
288 case MachineKeyValidation.SHA1:
289 hash = SHA1.Create ().ComputeHash (mix);
293 if (result.Length < count)
294 throw new ArgumentException ("Error validating ticket (length).", "encryptedTicket");
297 for (i = result.Length - count, k = 0; k < count; i++, k++) {
298 if (result [i] != hash [k])
299 throw new ArgumentException ("Error validating ticket.", "encryptedTicket");
303 return FormsAuthenticationTicket.FromByteArray (result);
306 public static FormsAuthenticationTicket Decrypt (string encryptedTicket)
308 if (encryptedTicket == null || encryptedTicket == String.Empty)
309 throw new ArgumentException ("Invalid encrypted ticket", "encryptedTicket");
313 FormsAuthenticationTicket ticket;
315 byte [] bytes = MachineKeySection.GetBytes (encryptedTicket, encryptedTicket.Length);
317 byte [] bytes = MachineKeyConfig.GetBytes (encryptedTicket, encryptedTicket.Length);
320 ticket = Decrypt2 (bytes);
321 } catch (Exception) {
328 public static string Encrypt (FormsAuthenticationTicket ticket)
331 throw new ArgumentNullException ("ticket");
334 byte [] ticket_bytes = ticket.ToByteArray ();
335 if (protection == FormsProtectionEnum.None)
336 return GetHexString (ticket_bytes);
338 byte [] result = ticket_bytes;
340 MachineKeySection config = (MachineKeySection) WebConfigurationManager.GetSection (machineKeyConfigPath);
342 MachineKeyConfig config = HttpContext.GetAppConfig (machineKeyConfigPath) as MachineKeyConfig;
344 bool all = (protection == FormsProtectionEnum.All);
345 if (all || protection == FormsProtectionEnum.Validation) {
346 byte [] valid_bytes = null;
348 byte [] vk = config.ValidationKeyBytes;
350 byte [] vk = config.ValidationKey;
352 byte [] mix = new byte [ticket_bytes.Length + vk.Length];
353 Buffer.BlockCopy (ticket_bytes, 0, mix, 0, ticket_bytes.Length);
354 Buffer.BlockCopy (vk, 0, mix, result.Length, vk.Length);
360 config.ValidationType
363 case MachineKeyValidation.MD5:
364 valid_bytes = MD5.Create ().ComputeHash (mix);
366 // From MS docs: "When 3DES is specified, forms authentication defaults to SHA1"
367 case MachineKeyValidation.TripleDES:
368 case MachineKeyValidation.SHA1:
369 valid_bytes = SHA1.Create ().ComputeHash (mix);
373 int tlen = ticket_bytes.Length;
374 int vlen = valid_bytes.Length;
375 result = new byte [tlen + vlen];
376 Buffer.BlockCopy (ticket_bytes, 0, result, 0, tlen);
377 Buffer.BlockCopy (valid_bytes, 0, result, tlen, vlen);
380 if (all || protection == FormsProtectionEnum.Encryption) {
381 ICryptoTransform encryptor;
382 encryptor = TripleDES.Create ().CreateEncryptor (config.DecryptionKey192Bits, init_vector);
383 result = encryptor.TransformFinalBlock (result, 0, result.Length);
386 return GetHexString (result);
389 public static HttpCookie GetAuthCookie (string userName, bool createPersistentCookie)
391 return GetAuthCookie (userName, createPersistentCookie, null);
394 public static HttpCookie GetAuthCookie (string userName, bool createPersistentCookie, string strCookiePath)
398 if (userName == null)
399 userName = String.Empty;
401 if (strCookiePath == null || strCookiePath.Length == 0)
402 strCookiePath = cookiePath;
404 DateTime now = DateTime.Now;
406 if (createPersistentCookie)
407 then = now.AddYears (50);
409 then = now.AddMinutes (timeout);
411 FormsAuthenticationTicket ticket = new FormsAuthenticationTicket (1,
415 createPersistentCookie,
419 if (!createPersistentCookie)
420 then = DateTime.MinValue;
422 HttpCookie cookie = new HttpCookie (cookieName, Encrypt (ticket), strCookiePath, then);
424 cookie.Secure = true;
428 internal static string ReturnUrl
430 get { return HttpContext.Current.Request ["RETURNURL"]; }
433 public static string GetRedirectUrl (string userName, bool createPersistentCookie)
435 if (userName == null)
439 HttpRequest request = HttpContext.Current.Request;
440 string returnUrl = ReturnUrl;
441 if (returnUrl != null)
444 returnUrl = request.ApplicationPath;
445 string apppath = request.PhysicalApplicationPath;
448 foreach (string indexFile in indexFiles) {
449 string filePath = Path.Combine (apppath, indexFile);
450 if (File.Exists (filePath)) {
451 returnUrl = UrlUtils.Combine (returnUrl, indexFile);
458 returnUrl = UrlUtils.Combine (returnUrl, "index.aspx");
463 static string GetHexString (byte [] bytes)
465 StringBuilder result = new StringBuilder (bytes.Length * 2);
466 foreach (byte b in bytes)
467 result.AppendFormat ("{0:X2}", (int) b);
469 return result.ToString ();
472 public static string HashPasswordForStoringInConfigFile (string password, string passwordFormat)
474 if (password == null)
475 throw new ArgumentNullException ("password");
477 if (passwordFormat == null)
478 throw new ArgumentNullException ("passwordFormat");
481 if (String.Compare (passwordFormat, "MD5", true, CultureInfo.InvariantCulture) == 0) {
482 bytes = MD5.Create ().ComputeHash (Encoding.UTF8.GetBytes (password));
483 } else if (String.Compare (passwordFormat, "SHA1", true, CultureInfo.InvariantCulture) == 0) {
484 bytes = SHA1.Create ().ComputeHash (Encoding.UTF8.GetBytes (password));
486 throw new ArgumentException ("The format must be either MD5 or SHA1", "passwordFormat");
489 return GetHexString (bytes);
492 public static void Initialize ()
502 AuthenticationSection section = (AuthenticationSection)WebConfigurationManager.GetSection (authConfigPath);
503 FormsAuthenticationConfiguration config = section.Forms;
505 cookieName = config.Name;
506 timeout = (int)config.Timeout.TotalMinutes;
507 cookiePath = config.Path;
508 protection = config.Protection;
509 requireSSL = config.RequireSSL;
510 slidingExpiration = config.SlidingExpiration;
511 cookie_domain = config.Domain;
512 cookie_mode = config.Cookieless;
513 cookies_supported = true; /* XXX ? */
514 default_url = MapUrl(config.DefaultUrl);
515 enable_crossapp_redirects = config.EnableCrossAppRedirects;
516 login_url = MapUrl(config.LoginUrl);
518 HttpContext context = HttpContext.Current;
519 AuthConfig authConfig = context.GetConfig (authConfigPath) as AuthConfig;
520 if (authConfig != null) {
521 cookieName = authConfig.CookieName;
522 timeout = authConfig.Timeout;
523 cookiePath = authConfig.CookiePath;
524 protection = authConfig.Protection;
526 requireSSL = authConfig.RequireSSL;
527 slidingExpiration = authConfig.SlidingExpiration;
530 cookieName = ".MONOAUTH";
533 protection = FormsProtectionEnum.All;
535 slidingExpiration = true;
540 // IV is 8 bytes long for 3DES
541 init_vector = new byte [8];
542 int len = cookieName.Length;
543 for (int i = 0; i < 8; i++) {
547 init_vector [i] = (byte) cookieName [i];
555 static string MapUrl (string url) {
556 if (UrlUtils.IsRelativeUrl (url))
557 return UrlUtils.Combine (HttpRuntime.AppDomainAppVirtualPath, url);
559 return UrlUtils.ResolveVirtualPathFromAppAbsolute (url);
563 public static void RedirectFromLoginPage (string userName, bool createPersistentCookie)
565 RedirectFromLoginPage (userName, createPersistentCookie, null);
568 public static void RedirectFromLoginPage (string userName, bool createPersistentCookie, string strCookiePath)
570 if (userName == null)
574 SetAuthCookie (userName, createPersistentCookie, strCookiePath);
575 Redirect (GetRedirectUrl (userName, createPersistentCookie), false);
578 public static FormsAuthenticationTicket RenewTicketIfOld (FormsAuthenticationTicket tOld)
583 DateTime now = DateTime.Now;
584 TimeSpan toIssue = now - tOld.IssueDate;
585 TimeSpan toExpiration = tOld.Expiration - now;
586 if (toExpiration > toIssue)
589 FormsAuthenticationTicket tNew = tOld.Clone ();
590 tNew.SetDates (now, now + (tOld.Expiration - tOld.IssueDate));
594 public static void SetAuthCookie (string userName, bool createPersistentCookie)
597 SetAuthCookie (userName, createPersistentCookie, cookiePath);
600 public static void SetAuthCookie (string userName, bool createPersistentCookie, string strCookiePath)
602 HttpContext context = HttpContext.Current;
604 throw new HttpException ("Context is null!");
606 HttpResponse response = context.Response;
607 if (response == null)
608 throw new HttpException ("Response is null!");
610 response.Cookies.Add (GetAuthCookie (userName, createPersistentCookie, strCookiePath));
613 public static void SignOut ()
617 HttpContext context = HttpContext.Current;
619 throw new HttpException ("Context is null!");
621 HttpResponse response = context.Response;
622 if (response == null)
623 throw new HttpException ("Response is null!");
625 HttpCookieCollection cc = response.Cookies;
626 cc.Remove (cookieName);
627 HttpCookie expiration_cookie = new HttpCookie (cookieName, "");
628 expiration_cookie.Expires = new DateTime (1999, 10, 12);
629 expiration_cookie.Path = cookiePath;
630 cc.Add (expiration_cookie);
633 Roles.DeleteCookie ();
637 public static string FormsCookieName
645 public static string FormsCookiePath
653 public static bool RequireSSL {
660 public static bool SlidingExpiration {
663 return slidingExpiration;
669 public static string CookieDomain {
670 get { Initialize (); return cookie_domain; }
673 public static HttpCookieMode CookieMode {
674 get { Initialize (); return cookie_mode; }
677 public static bool CookiesSupported {
678 get { Initialize (); return cookies_supported; }
681 public static string DefaultUrl {
682 get { Initialize (); return default_url; }
685 public static bool EnableCrossAppRedirects {
686 get { Initialize (); return enable_crossapp_redirects; }
689 public static string LoginUrl {
690 get { Initialize (); return login_url; }
693 public static void RedirectToLoginPage ()
698 [MonoTODO ("needs more tests")]
699 public static void RedirectToLoginPage (string extraQueryString)
701 // TODO: if ? is in LoginUrl (legal?), ? in query (legal?) ...
702 Redirect (LoginUrl + "?" + extraQueryString);
705 private static void Redirect (string url)
707 HttpContext.Current.Response.Redirect (url);
711 private static void Redirect (string url, bool end)
713 HttpContext.Current.Response.Redirect (url, end);