Export (0) Print
Expand All

FormsAuthentication Class

Manages forms-authentication services for Web applications. This class cannot be inherited.

System::Object
  System.Web.Security::FormsAuthentication

Namespace:  System.Web.Security
Assembly:  System.Web (in System.Web.dll)

public ref class FormsAuthentication sealed

The FormsAuthentication type exposes the following members.

  NameDescription
Public methodFormsAuthenticationInitializes a new instance of the FormsAuthentication class.
Top

  NameDescription
Public propertyStatic memberCookieDomainGets the value of the domain of the forms-authentication cookie.
Public propertyStatic memberCookieModeGets a value that indicates whether the application is configured for cookieless forms authentication.
Public propertyStatic memberCookiesSupportedGets a value that indicates whether the application is configured to support cookieless forms authentication.
Public propertyStatic memberDefaultUrlGets the URL that the FormsAuthentication class will redirect to if no redirect URL is specified.
Public propertyStatic memberEnableCrossAppRedirectsGets a value indicating whether authenticated users can be redirected to URLs in other Web applications.
Public propertyStatic memberFormsCookieNameGets the name of the cookie used to store the forms-authentication ticket.
Public propertyStatic memberFormsCookiePathGets the path for the forms-authentication cookie.
Public propertyStatic memberIsEnabledGets a value that indicates whether forms authentication is enabled.
Public propertyStatic memberLoginUrlGets the URL for the login page that the FormsAuthentication class will redirect to.
Public propertyStatic memberRequireSSLGets a value indicating whether the forms-authentication cookie requires SSL in order to be returned to the server.
Public propertyStatic memberSlidingExpirationGets a value indicating whether sliding expiration is enabled.
Public propertyStatic memberTicketCompatibilityModeGets a value that indicates whether to use Coordinated Universal Time (UTC) or local time for the ticket expiration date.
Public propertyStatic memberTimeoutGets the amount of time before an authentication ticket expires.
Top

  NameDescription
Public methodStatic memberAuthenticate Obsolete. Validates a user name and password against credentials stored in the configuration file for an application.
Public methodStatic memberDecryptCreates a FormsAuthenticationTicket object based on the encrypted forms-authentication ticket passed to the method.
Public methodStatic memberEnableFormsAuthenticationEnables forms authentication.
Public methodStatic memberEncryptCreates a string containing an encrypted forms-authentication ticket suitable for use in an HTTP cookie.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodStatic memberGetAuthCookie(String, Boolean)Creates an authentication cookie for a given user name. This does not set the cookie as part of the outgoing response, so that an application can have more control over how the cookie is issued.
Public methodStatic memberGetAuthCookie(String, Boolean, String)Creates an authentication cookie for a given user name. This does not set the cookie as part of the outgoing response.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodStatic memberGetRedirectUrlReturns the redirect URL for the original request that caused the redirect to the login page.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodStatic memberHashPasswordForStoringInConfigFile Obsolete. Produces a hash password suitable for storing in a configuration file based on the specified password and hash algorithm.
Public methodStatic memberInitializeInitializes the FormsAuthentication object based on the configuration settings for the application.
Public methodStatic memberRedirectFromLoginPage(String, Boolean)Redirects an authenticated user back to the originally requested URL or the default URL.
Public methodStatic memberRedirectFromLoginPage(String, Boolean, String)Redirects an authenticated user back to the originally requested URL or the default URL using the specified cookie path for the forms-authentication cookie.
Public methodStatic memberRedirectToLoginPage()Redirects the browser to the login URL.
Public methodStatic memberRedirectToLoginPage(String)Redirects the browser to the login URL with the specified query string.
Public methodStatic memberRenewTicketIfOldConditionally updates the issue date and time and expiration date and time for a FormsAuthenticationTicket.
Public methodStatic memberSetAuthCookie(String, Boolean)Creates an authentication ticket for the supplied user name and adds it to the cookies collection of the response, or to the URL if you are using cookieless authentication.
Public methodStatic memberSetAuthCookie(String, Boolean, String)Creates an authentication ticket for the supplied user name and adds it to the cookies collection of the response, using the supplied cookie path, or using the URL if you are using cookieless authentication.
Public methodStatic memberSignOutRemoves the forms-authentication ticket from the browser.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Forms authentication enables user and password validation for Web applications that do not require Windows authentication. With forms authentication, user information is stored in an external data source, such as a Membership database, or in the configuration file for an application. Once a user is authenticated, forms authentication maintains an authentication ticket in a cookie or in the URL so that an authenticated user does not need to supply credentials with each request.

Forms authentication is enabled by setting the mode attribute of the authentication configuration element to Forms. You can require that all requests to an application contain a valid user authentication ticket by using the authorization configuration element to deny the request of any unknown user, as shown in the following example.

<system.web>
  <authentication mode="Forms">
    <forms loginUrl="login.aspx" />
  </authentication>
  <authorization>
    <deny users="?" />
  </authorization>
</system.web>

In the previous example, any request for an ASP.NET page that is part of the application requires a valid user name that is supplied by forms authentication. If no user name exists, then the request is redirected to the configured LoginUrl.

The FormsAuthentication class provides access to methods and properties that you can use in an application that authenticates users. The RedirectToLoginPage method redirects a browser to the configured LoginUrl for users to log into an application. The RedirectFromLoginPage method redirects an authenticated user back to the original protected URL that was requested or to the DefaultUrl. There are also methods that enable you to manage forms-authentication tickets, if needed.

TopicLocation
How to: Implement Simple Forms AuthenticationBuilding ASP .NET Web Applications
How to: Use Advanced Features of the ASP.NET Login ControlBuilding ASP .NET Web Applications
How to: Create an ASP.NET Login PageBuilding ASP .NET Web Applications
How to: Implement Simple Forms AuthenticationBuilding ASP .NET Web Applications
How to: Use Advanced Features of the ASP.NET Login ControlBuilding ASP .NET Web Applications
How to: Create an ASP.NET Login PageBuilding ASP .NET Web Applications
Walkthrough: Creating a Web Site with Membership and User Login (Visual Studio)Building ASP .NET Web Applications in Visual Studio
How to: Create an ASP.NET Login PageBuilding ASP .NET Web Applications in Visual Studio

The following code example shows the Web.config file for an ASP.NET application that uses the ASP.NET membership provider for forms authentication and requires all users to be authenticated.

<configuration>
  <connectionStrings>
    <add name="SqlServices" connectionString="Data Source=MySqlServer;Integrated Security=SSPI;Initial Catalog=aspnetdb;" />
  </connectionStrings>
  <system.web>
    <membership defaultProvider="SqlProvider" userIsOnlineTimeWindow="20">
      <providers>
        <add name="SqlProvider"
          type="System.Web.Security.SqlMembershipProvider"
          connectionStringName="SqlServices"
          enablePasswordRetrieval="false"
          enablePasswordReset="true"
          requiresQuestionAndAnswer="true"
          passwordFormat="Hashed"
          applicationName="/" />
      </providers>
    </membership>
  </system.web>
</configuration>

The following code example shows the login page for an ASP.NET application that uses forms authentication and ASP.NET membership.

Security noteSecurity Note

This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft