Microsoft KB Archive/316748

= How to authenticate against the Active Directory by using Forms authentication and Visual C# .NET =

Article ID: 316748

Article Last Modified on 10/16/2007

-

APPLIES TO


 * Microsoft Visual C# .NET 2003 Standard Edition
 * Microsoft Visual C# .NET 2002 Standard Edition
 * Microsoft ASP.NET 1.1
 * Microsoft ASP.NET 1.0

-



This article was previously published under Q316748



This article refers to the following Microsoft .NET Framework Class Library namespaces:
 * System.Text
 * System.DirectoryServices
 * System.Security.Principal
 * System.Web.Security



SUMMARY
This step-by-step article demonstrates how an ASP.NET application can use Forms authentication to permit users to authenticate against the Active Directory by using the Lightweight Directory Access Protocol (LDAP). After the user is authenticated and redirected, you can use the Application_AuthenticateRequest method of the Global.asax file to store a GenericPrincipal object in the HttpContext.User property that flows throughout the request.

Create an ASP.NET Web application in Visual C# .NET
Follow these steps to create a new ASP.NET Web application named FormsAuthAd in Visual C# .NET:
 * 1) Start Microsoft Visual Studio .NET.
 * 2) On the File menu, point to New, and then click Project.
 * 3) Click Visual C# Projects under Project Types, and then click ASP.NET Web Application under Templates.
 * 4) In the Location box, replace WebApplication1 with FormsAuthAd.
 * 5) Click OK.
 * 6) Right-click the References node in Solution Explorer, and then click Add Reference.
 * 7) On the .NET tab in the Add Reference dialog box, click System.DirectoryServices.dll, click Select, and then click OK.

Write the authentication code
Follow these steps to create a new class file named LdapAuthentication.cs:  In Solution Explorer, right-click the project node, point to Add, and then click Add New Item. Click Class under Templates. Type LdapAuthentication.cs in the Name box, and then click Open.  Replace the existing code in the LdapAuthentication.cs file with the following code. using System; using System.Text; using System.Collections; using System.DirectoryServices;

namespace FormsAuth {    public class LdapAuthentication {   private String _path; private String _filterAttribute;

public LdapAuthentication(String path) {     _path = path; }   public bool IsAuthenticated(String domain, String username, String pwd) {     String domainAndUsername = domain + @&quot;\&quot; + username; DirectoryEntry entry = new DirectoryEntry(_path, domainAndUsername, pwd); try { //Bind to the native AdsObject to force authentication. Object obj = entry.NativeObject;

DirectorySearcher search = new DirectorySearcher(entry);

search.Filter = &quot;(SAMAccountName=&quot; + username + &quot;)&quot;; search.PropertiesToLoad.Add(&quot;cn&quot;); SearchResult result = search.FindOne;

if(null == result) {     return false; }

//Update the new path to the user in the directory. _path = result.Path; _filterAttribute = (String)result.Properties[&quot;cn&quot;][0]; }     catch (Exception ex) {       throw new Exception(&quot;Error authenticating user. &quot; + ex.Message); }

return true; }

public String GetGroups {      DirectorySearcher search = new DirectorySearcher(_path); search.Filter = &quot;(cn=&quot; + _filterAttribute + &quot;)&quot;; search.PropertiesToLoad.Add(&quot;memberOf&quot;); StringBuilder groupNames = new StringBuilder;

try {        SearchResult result = search.FindOne;

int propertyCount = result.Properties[&quot;memberOf&quot;].Count;

String dn; int equalsIndex, commaIndex; for(int propertyCounter = 0; propertyCounter < propertyCount; propertyCounter++) {      dn = (String)result.Properties[&quot;memberOf&quot;][propertyCounter];

equalsIndex = dn.IndexOf(&quot;=&quot;, 1); commaIndex = dn.IndexOf(&quot;,&quot;, 1); if(-1 == equalsIndex) {        return null; }

groupNames.Append(dn.Substring((equalsIndex + 1), (commaIndex - equalsIndex) - 1)); groupNames.Append(&quot;|&quot;);

}      }       catch(Exception ex) {        throw new Exception(&quot;Error obtaining group names. &quot; + ex.Message); }                  return groupNames.ToString; }  } }                    

The authentication code accepts a domain, a user name, a password, and a path to the tree in the Active Directory. This code uses the LDAP directory provider.

The code in the Logon.aspx page calls the LdapAuthentication.IsAuthenticated method and passes in the credentials that are collected from the user. Then, a DirectoryEntry object is created with the path to the directory tree, the user name, and the password. The user name must be in the &quot;domain\username&quot; format. The DirectoryEntry object then tries to force the AdsObject binding by obtaining the NativeObject property. If this succeeds, the CN attribute for the user is obtained by creating a DirectorySearcher object and by filtering on the SAMAccountName. After the user is authenticated, the IsAuthenticated method returns true.

To obtain a list of groups that the user belongs to, this code calls the LdapAuthentication.GetGroups method. The LdapAuthentication.GetGroups method obtains a list of security and distribution groups that the user belongs to by creating a DirectorySearcher object and by filtering according to the memberOf attribute. This method returns a list of groups that is separated by pipes (|).

Notice that the LdapAuthentication.GetGroups method manipulates and truncates strings. This reduces the length of the string that is stored in the authentication cookie. If the string is not truncated, the format of each group appears as follows. CN=...,...,DC=domain,DC=com This can create a very long string. If the length of this string is greater than the length of the cookie, browsers may not accept the authentication cookie, and you will be redirected to the logon page. However, if you are in a multi-domain environment, you may have to keep the domain name with the group name because groups in different domains can have the same group name. You have to keep the domain name to differentiate one group from another.

Most browsers support cookies of up to 4096 bytes. If this string may potentially exceed the length of the cookie, you may want to store the group information in the ASP.NET Cache object or in a database. Alternatively, you may want to encrypt the group information and store this information in a hidden form field.

Write the Global.asax code
The code in the Global.asax file provides an Application_AuthenticateRequest event handler. This event handler retrieves the authentication cookie from the Context.Request.Cookies collection, decrypts the cookie, and retrieves the list of groups that will be stored in the FormsAuthenticationTicket.UserData property. The groups appear in a pipe-separated list that is created in the Logon.aspx page.

The code parses the string in a string array to create a GenericPrincipal object. After the GenericPrincipal object is created, this object is placed in the HttpContext.User property.  In Solution Explorer, right-click Global.asax, and then click View Code.  Add the following code at the top of the code-behind Global.asax.cs file: using System.Web.Security; using System.Security.Principal; </li>  Replace the existing empty event handler for the Application_AuthenticateRequest with the following code. void Application_AuthenticateRequest(Object sender, EventArgs e) { String cookieName = FormsAuthentication.FormsCookieName; HttpCookie authCookie = Context.Request.Cookies[cookieName];

if(null == authCookie) {//There is no authentication cookie. return; }  FormsAuthenticationTicket authTicket = null; try {   authTicket = FormsAuthentication.Decrypt(authCookie.Value); } catch(Exception ex) {   //Write the exception to the Event Log. return; } if(null == authTicket) {//Cookie failed to decrypt. return; }      //When the ticket was created, the UserData property was assigned a  //pipe-delimited string of group names. String[] groups = authTicket.UserData.Split(new char[]{'|'});

//Create an Identity. GenericIdentity id = new GenericIdentity(authTicket.Name, &quot;LdapAuthentication&quot;); //This principal flows throughout the request. GenericPrincipal principal = new GenericPrincipal(id, groups);

Context.User = principal; }                   </li></ol>

Modify the Web.config file
In this section, you configure the  , the  , and the   elements in the Web.config file. With these changes, only authenticated users can access the application, and unauthenticated requests are redirected to a Logon.aspx page. You can modify this configuration to permit only certain users and groups access to the application.

Replace the existing code in the Web.config file with the following code. <?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot; ?> <system.web> <authentication mode=&quot;Forms&quot;> <forms loginUrl=&quot;logon.aspx&quot; name=&quot;adAuthCookie&quot; timeout=&quot;10&quot; path=&quot;/&quot; > <deny users=&quot;?&quot; /> <allow users=&quot;*&quot; /> <identity impersonate=&quot;true&quot; /> </system.web> Notice the <identity impersonate=&quot;true&quot; /> configuration element. This causes ASP.NET to impersonate the account that is configured as the anonymous account from Microsoft Internet Information Services (IIS). As a result of this configuration, all requests to this application run under the security context of the configured account. The user provides credentials to authenticate against the Active Directory, but the account that accesses the Active Directory is the configured account. For more information, see the References section.

Configure IIS for anonymous authentication
To configure IIS for anonymous authentication, follow these steps:
 * 1) In IIS, expand the computer node for your server, expand Web Sites, expand Default Web Site, right-click FormsAuthAd, and then click Properties.
 * 2) Click the Directory Security Tab, and then click Edit under Anonymous Access and Authentication Control.
 * 3) Make the anonymous account for the application an account that has permission to the Active Directory.
 * 4) Click to clear the Allow IIS To Control Password check box.
 * 5) In the “Authenticated Access” section, uncheck the “Integrated Windows Authentication” check box.
 * 6) Click OK.
 * 7) Click Apply

The default IUSR_ account does not have permission to the Active Directory.

Create the Logon.aspx page
Follow these steps to create a new ASP.NET Web Form named Logon.aspx:  In Solution Explorer, right-click the project node, point to Add, and then click Add Web Form.</li> Type Logon.aspx in the Name box, and then click Open.</li> In Solution Explorer, right-click Logon.aspx, and then click View Designer.</li> Click the HTML tab in the Designer.</li>  Replace the existing code with the following code. <%@ Page language=&quot;c#&quot; AutoEventWireup=&quot;true&quot; %> <%@ Import Namespace=&quot;FormsAuth&quot; %> <form id=&quot;Login&quot; method=&quot;post&quot; runat=&quot;server&quot;> <asp:Label ID=&quot;Label1&quot; Runat=server >Domain:</asp:Label> <asp:TextBox ID=&quot;txtDomain&quot; Runat=server ></asp:TextBox> <asp:Label ID=&quot;Label2&quot; Runat=server >Username:</asp:Label> <asp:TextBox ID=txtUsername Runat=server ></asp:TextBox> <asp:Label ID=&quot;Label3&quot; Runat=server >Password:</asp:Label> <asp:TextBox ID=&quot;txtPassword&quot; Runat=server TextMode=Password></asp:TextBox> <asp:Button ID=&quot;btnLogin&quot; Runat=server Text=&quot;Login&quot; OnClick=&quot;Login_Click&quot;></asp:Button> <asp:Label ID=&quot;errorLabel&quot; Runat=server ForeColor=#ff3300></asp:Label> <asp:CheckBox ID=chkPersist Runat=server Text=&quot;Persist Cookie&quot; /> void Login_Click(Object sender, EventArgs e) { String adPath = &quot;LDAP://corp.com&quot;; //Fully-qualified Domain Name LdapAuthentication adAuth = new LdapAuthentication(adPath); try {   if(true == adAuth.IsAuthenticated(txtDomain.Text, txtUsername.Text, txtPassword.Text)) {     String groups = adAuth.GetGroups;

//Create the ticket, and add the groups. bool isCookiePersistent = chkPersist.Checked; FormsAuthenticationTicket authTicket = new FormsAuthenticationTicket(1, txtUsername.Text,    DateTime.Now, DateTime.Now.AddMinutes(60), isCookiePersistent, groups); //Encrypt the ticket. String encryptedTicket = FormsAuthentication.Encrypt(authTicket); //Create a cookie, and then add the encrypted ticket to the cookie as data. HttpCookie authCookie = new HttpCookie(FormsAuthentication.FormsCookieName, encryptedTicket);

if(true == isCookiePersistent) authCookie.Expires = authTicket.Expiration; //Add the cookie to the outgoing cookies collection. Response.Cookies.Add(authCookie);

//You can redirect now. Response.Redirect(FormsAuthentication.GetRedirectUrl(txtUsername.Text, false)); }   else {     errorLabel.Text = &quot;Authentication did not succeed. Check user name and password.&quot;; } }  catch(Exception ex) {   errorLabel.Text = &quot;Error authenticating. &quot; + ex.Message; } } </li> Modify the path in the Logon.aspx page to point to your LDAP Directory server.</li></ol>

The Logon.aspx page is a page that collects the information from the user and call methods on the LdapAuthentication class. After the code authenticates the user and obtains a list of groups, the code creates a FormsAuthenticationTicket object, encrypts the ticket, adds the encrypted ticket to a cookie, adds the cookie to the HttpResponse.Cookies collection, and then redirects the request to the URL that was originally requested.

Modify the WebForm1.aspx page
The WebForm1.aspx page is the page that is requested originally. When the user requests this page, the request is redirected to the Logon.aspx page. After the request is authenticated, the request is redirected to the WebForm1.aspx page.  In Solution Explorer, right-click WebForm1.aspx, and then click View Designer.</li> Click the HTML tab in the Designer.</li>  Replace the existing code with the following code. <%@ Page language=&quot;c#&quot; AutoEventWireup=&quot;true&quot; %> <%@ Import Namespace=&quot;System.Security.Principal&quot; %> <form id=&quot;Form1&quot; method=&quot;post&quot; runat=&quot;server&quot;> <asp:Label ID=&quot;lblName&quot; Runat=server /> <asp:Label ID=&quot;lblAuthType&quot; Runat=server /> void Page_Load(Object sender, EventArgs e) { lblName.Text = &quot;Hello &quot; + Context.User.Identity.Name + &quot;.&quot;; lblAuthType.Text = &quot;You were authenticated using &quot; +  Context.User.Identity.AuthenticationType + &quot;.&quot;; }                   </li> Save all files, and then compile the project.</li> Request the WebForm1.aspx page. Notice that you are redirected to Logon.aspx.</li> Type the logon credentials, and then click Submit. When you are redirected to WebForm1.aspx, notice that your user name appears and that LdapAuthentication is the authentication type for the Context.User.AuthenticationType property.</li></ol>

Note Microsoft recommends that you use Secure Sockets Layer (SSL) encryption when you use Forms authentication. This is because the user is identified based on the authentication cookie, and SSL encryption on this application prevents anyone from compromising the authentication cookie and any other valuable information that is being transmitted.

<div class="references_section">