Microsoft KB Archive/301240

= How To Implement Forms-Based Authentication in Your ASP.NET Application by Using C# .NET =

Article ID: 301240

Article Last Modified on 5/13/2007

-

APPLIES TO


 * Microsoft ASP.NET 1.1
 * Microsoft Visual C# .NET 2003 Standard Edition
 * Microsoft ASP.NET 1.0
 * Microsoft Visual C# .NET 2002 Standard Edition
 * Microsoft SQL Server 2000 Standard Edition
 * Microsoft SQL Server 7.0 Standard Edition
 * Microsoft SQL Server 2000 64-bit Edition

-



This article was previously published under Q301240



For a Microsoft Visual Basic .NET version of this article, see 308157.

This article refers to the following Microsoft .NET Framework Class Library namespaces:
 * System.Data.SqlClient
 * System.Web.Security

IN THIS TASK
SUMMARY
 * Requirements
 * Create an ASP.NET Application Using Visual C# .NET
 * Configure the Security Settings in the Web.config File
 * Create a Sample Database Table to Store Users Details
 * Create a Logon.aspx Page
 * Code the Event Handler So That It Validates the User Credentials
 * Create a Default.aspx Page
 * Additional Notes

REFERENCES



SUMMARY
This article demonstrates how to implement forms-based authentication by using a database to store the users.

back to the top

Requirements
The following list outlines the recommended hardware, software, network infrastructure, and service packs that you need:
 * Microsoft Visual Studio .NET
 * Microsoft Internet Information Services (IIS) version 5.0 or later
 * Microsoft SQL Server

back to the top

Create an ASP.NET Application Using C# .NET

 * 1) Open Visual Studio .NET.
 * 2) Create a new ASP.NET Web application, and specify the name and location.

back to the top

Configure the Security Settings in the Web.config File
This section demonstrates how to add and modify the   and   configuration sections to configure the ASP.NET application to use forms-based authentication.  In Solution Explorer, open the Web.config file. Change the authentication mode to Forms.  Insert the  tag, and fill the appropriate attributes. (For more information about these attributes, refer to the MSDN documentation or the QuickStart documentation that is listed in the REFERENCES section.) Copy the following code, and then click Paste as HTML on the Edit menu to paste the code in the   section of the file:     Deny access to the anonymous user in the   section as follows:   </li></ol>

back to the top

Create a Sample Database Table to Store Users Details
This section demonstrates how to create a sample database to store the user name, password, and role for the users. You need the role column if you want to store user roles in the database and implement role-based security. <ol> On the Start menu, click Run, and then type notepad to open Notepad.</li>  Highlight the following SQL script code, right-click the code, and then click Copy. In Notepad, click Paste on the Edit menu to paste the following code: if exists (select * from sysobjects where id = object_id(N'[dbo].[Users]') and OBJECTPROPERTY(id, N'IsUserTable') = 1) drop table [dbo].[Users] GO CREATE TABLE [dbo].[Users] (  [uname] [varchar] (15) NOT NULL,   [Pwd] [varchar] (25) NOT NULL ,   [userRole] [varchar] (25) NOT NULL , ) ON [PRIMARY] GO ALTER TABLE [dbo].[Users] WITH NOCHECK ADD CONSTRAINT [PK_Users] PRIMARY KEY NONCLUSTERED (     [uname]   )  ON [PRIMARY] GO

INSERT INTO Users values('user1','user1','Manager') INSERT INTO Users values('user2','user2','Admin') INSERT INTO Users values('user3','user3','User') GO </li> Save the file as Users.sql.</li> On the Microsoft SQL Server computer, open Users.sql in Query Analyzer. From the list of databases, click pubs, and run the script. This creates a sample users table and populates the table in the Pubs database to be used with this sample application.</li></ol>

back to the top

Create a Logon.aspx Page
<ol> Add a new Web Form to the project named Logon.aspx.</li> Open the Logon.aspx page in the editor, and switch to HTML view.</li>  Copy the following code, and use the Paste as HTML option on the Edit menu to insert the code between the tags: <font face=&quot;Verdana&quot;>Logon Page <input type=&quot;submit&quot; Value=&quot;Logon&quot; runat=&quot;server&quot; ID=&quot;cmdLogin&quot;> <asp:Label id=&quot;lblMsg&quot; ForeColor=&quot;red&quot; Font-Name=&quot;Verdana&quot; Font-Size=&quot;10&quot; runat=&quot;server&quot; /> This Web Form is used to present a logon form to users so that they can provide their user name and password to log on to the application. </li> Switch to Design view, and save the page.</li></ol>

back to the top

Code the Event Handler So That It Validates the User Credentials
This section presents the code that is placed in the code-behind page (Logon.aspx.cs). <ol> Double-click Logon to open the Logon.aspx.cs file.</li>  Import the required namespaces in the code-behind file: using System.Data.SqlClient; using System.Web.Security; </li>  Create a ValidateUser function to validate the user credentials by looking in the database. (Make sure that you change the Connection string to point to your database). private bool ValidateUser( string userName, string passWord ) {   SqlConnection conn; SqlCommand cmd; string lookupPassword = null;

// Check for invalid userName. // userName must not be null and must be between 1 and 15 characters. if ( ( null == userName ) || ( 0 == userName.Length ) || ( userName.Length > 15 ) ) {       System.Diagnostics.Trace.WriteLine( &quot;[ValidateUser] Input validation of userName failed.&quot; ); return false; }

// Check for invalid passWord. // passWord must not be null and must be between 1 and 25 characters. if ( ( null == passWord ) || ( 0 == passWord.Length ) || ( passWord.Length > 25 ) ) {       System.Diagnostics.Trace.WriteLine( &quot;[ValidateUser] Input validation of passWord failed.&quot; ); return false; }

try {       // Consult with your SQL Server administrator for an appropriate connection // string to use to connect to your local SQL Server. conn = new SqlConnection( &quot;server=localhost;Integrated Security=SSPI;database=pubs&quot; ); conn.Open;

// Create SqlCommand to select pwd field from users table given supplied userName. cmd = new SqlCommand( &quot;Select pwd from users where uname=@userName&quot;, conn ); cmd.Parameters.Add( &quot;@userName&quot;, SqlDbType.VarChar, 25 ); cmd.Parameters[&quot;@userName&quot;].Value = userName;

// Execute command and fetch pwd field into lookupPassword string. lookupPassword = (string) cmd.ExecuteScalar;

// Cleanup command and connection objects. cmd.Dispose; conn.Dispose; }   catch ( Exception ex ) {       // Add error handling here for debugging. // This error message should not be sent back to the caller. System.Diagnostics.Trace.WriteLine( &quot;[ValidateUser] Exception &quot; + ex.Message ); }

// If no password found, return false. if ( null == lookupPassword ) {       // You could write failed login attempts here to event log for additional security. return false; }

// Compare lookupPassword and input passWord, using a case-sensitive comparison. return ( 0 == string.Compare( lookupPassword, passWord, false ) );

}                   </li> You can use one of two methods to generate the forms authentication cookie and redirect the user to an appropriate page in the cmdLogin_ServerClick event. Sample code is provided for both scenarios. Use either of them according to your requirement. <ul>  Call the RedirectFromLoginPage method to automatically generate the forms authentication cookie and redirect the user to an appropriate page in the cmdLogin_ServerClick event: private void cmdLogin_ServerClick(object sender, System.EventArgs e) { if (ValidateUser(txtUserName.Value,txtUserPass.Value) ) FormsAuthentication.RedirectFromLoginPage(txtUserName.Value,       chkPersistCookie.Checked); else Response.Redirect(&quot;logon.aspx&quot;, true); }                       </li>  Generate the authentication ticket, encrypt it, create a cookie, add it to the response, and redirect the user. This gives you more control in how you create the cookie. You can also include custom data along with the FormsAuthenticationTicket in this case. private void cmdLogin_ServerClick(object sender, System.EventArgs e) { if (ValidateUser(txtUserName.Value,txtUserPass.Value) ) {     FormsAuthenticationTicket tkt; string cookiestr; HttpCookie ck; tkt = new FormsAuthenticationTicket(1, txtUserName.Value, DateTime.Now, DateTime.Now.AddMinutes(30), chkPersistCookie.Checked, &quot;your custom data&quot;); cookiestr = FormsAuthentication.Encrypt(tkt); ck = new HttpCookie(FormsAuthentication.FormsCookieName, cookiestr); if (chkPersistCookie.Checked) ck.Expires=tkt.Expiration; ck.Path = FormsAuthentication.FormsCookiePath; Response.Cookies.Add(ck);

string strRedirect; strRedirect = Request[&quot;ReturnUrl&quot;]; if (strRedirect==null) strRedirect = &quot;default.aspx&quot;; Response.Redirect(strRedirect, true); }  else Response.Redirect(&quot;logon.aspx&quot;, true); }                       </li></ul> </li>  Make sure that the following code is added to the InitializeComponent method in the code that the Web Form Designer generates: this.cmdLogin.ServerClick += new System.EventHandler(this.cmdLogin_ServerClick); </li></ol>

back to the top

Create a Default.aspx Page
This section creates a test page to which users are redirected after they authenticate. If users browse to this page without first logging on to the application, they are redirected to the logon page. <ol> Rename the existing WebForm1.aspx page as Default.aspx, and open it in the editor.</li> <li> Switch to HTML view, and copy the following code between the tags: <input type=&quot;submit&quot; Value=&quot;SignOut&quot; runat=&quot;server&quot; id=&quot;cmdSignOut&quot;> This button is used to log off the forms authentication session. </li> <li>Switch to Design view, and save the page.</li> <li> Import the required namespaces in the code-behind file: using System.Web.Security; </li> <li> Double-click SignOut to open the code-behind page (Default.aspx.cs), and copy the following code in the cmdSignOut_ServerClick event handler: private void cmdSignOut_ServerClick(object sender, System.EventArgs e) { FormsAuthentication.SignOut; Response.Redirect(&quot;logon.aspx&quot;, true); }                   </li> <li> Make sure that the following code is added to the InitializeComponent method in the code that the Web Form Designer generates: this.cmdSignOut.ServerClick += new System.EventHandler(this.cmdSignOut_ServerClick); </li> <li>Save and compile the project. You can now use the application.</li></ol>

back to the top

Additional Notes

 * You may want to store passwords securely in a database. You can use the FormsAuthentication class utility function named HashPasswordForStoringInConfigFile to encrypt the passwords before you store them in the database or configuration file.
 * You may want to store the SQL connection information in the configuration file (Web.config) so that you can easily modify it if necessary.
 * You may consider adding code to prevent hackers who try to use different combinations of passwords from logging on. For example, you can include logic that accepts only two or three logon attempts. If the user cannot log on in a certain number of attempts, you may want to set a flag in the database to not allow that user to log on until that user re-enables his or her account by visiting a different page or by calling your support line. In addition, you should add appropriate error handling wherever necessary.
 * Because the user is identified based on the authentication cookie, you may want to use Secure Sockets Layer (SSL) on this application so that no one can deceive the authentication cookie and any other valuable information that is being transmitted.
 * Forms-based authentication requires that your client accept or enable cookies on their browser.
 * The timeout parameter of the   configuration section controls the interval at which the authentication cookie is regenerated. You can choose a value that provides better performance and security.
 * Certain intermediary proxies and caches on the Internet may cache Web server responses that contain Set-Cookie headers, which are then returned to a different user. Because forms-based authentication uses a cookie to authenticate users, this can cause users to accidentally (or intentionally) impersonate another user by receiving a cookie from an intermediary proxy or cache that was not originally intended for them.

back to the top

<div class="references_section">