FormsAuthenticationConfiguration Class
 

Configures an ASP.NET application to use the AuthenticationMode forms modality.

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

Inheritance Hierarchy
SystemObject
   System.ConfigurationConfigurationElement
    System.Web.ConfigurationFormsAuthenticationConfiguration

Syntax
public sealed class FormsAuthenticationConfiguration : ConfigurationElement
public ref class FormsAuthenticationConfiguration sealed : ConfigurationElement
[<Sealed>]
type FormsAuthenticationConfiguration = 
    class
        inherit ConfigurationElement
    end
Public NotInheritable Class FormsAuthenticationConfiguration
	Inherits ConfigurationElement
Constructors
NameDescription
System_CAPS_pubmethod FormsAuthenticationConfiguration

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the FormsAuthenticationConfiguration class.

Properties
NameDescription
System_CAPS_pubproperty

Gets or sets a value indicating whether forms-based authentication should use cookies.

System_CAPS_pubproperty

Gets the FormsAuthenticationCredentials collection of user names and passwords.

System_CAPS_pubproperty

Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.(Inherited from ConfigurationElement.)

System_CAPS_pubproperty

Gets or sets the default URL.

System_CAPS_pubproperty

Gets or sets the domain name to be sent with forms authentication cookies.

System_CAPS_pubproperty

Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement.)

System_CAPS_protproperty

Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.(Inherited from ConfigurationElement.)

System_CAPS_pubproperty

Gets or sets a value indicating whether authenticated users can be redirected to URLS in other applications.

System_CAPS_protproperty

Gets or sets a property or attribute of this configuration element.(Inherited from ConfigurationElement.)

System_CAPS_protproperty

Gets or sets a property, attribute, or child element of this configuration element.(Inherited from ConfigurationElement.)

System_CAPS_pubproperty

Gets the collection of locked attributes.(Inherited from ConfigurationElement.)

System_CAPS_pubproperty

Gets the collection of locked elements.(Inherited from ConfigurationElement.)

System_CAPS_pubproperty

Gets the collection of locked attributes (Inherited from ConfigurationElement.)

System_CAPS_pubproperty

Gets the collection of locked elements.(Inherited from ConfigurationElement.)

System_CAPS_pubproperty

Gets or sets a value indicating whether the element is locked.(Inherited from ConfigurationElement.)

System_CAPS_pubproperty

Gets or sets the redirection URL for the request.

System_CAPS_pubproperty

Gets or sets the cookie name.

System_CAPS_pubproperty

Gets or sets the cookie path.

System_CAPS_protproperty

Gets the collection of properties.(Inherited from ConfigurationElement.)

System_CAPS_pubproperty

Gets or sets the encryption type used to encrypt the cookie.

System_CAPS_pubproperty

Gets or sets a value indicating whether a Secure Sockets Layer (SSL) connection is required when transmitting authentication information.

System_CAPS_pubproperty

Gets or sets the authentication sliding expiration.

System_CAPS_pubproperty

Gets or sets a value that indicates whether to use Coordinated Universal Time (UTC) or local time for the ticket expiration date.

System_CAPS_pubproperty

Gets or sets the authentication time-out.

Methods
NameDescription
System_CAPS_protmethod DeserializeElement

Reads XML from the configuration file.(Inherited from ConfigurationElement.)

System_CAPS_pubmethod Equals

Compares the current ConfigurationElement instance to the specified object.(Inherited from ConfigurationElement.)

System_CAPS_pubmethod GetHashCode

Gets a unique value representing the current ConfigurationElement instance.(Inherited from ConfigurationElement.)

System_CAPS_pubmethod GetType

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethod Init

Sets the ConfigurationElement object to its initial state.(Inherited from ConfigurationElement.)

System_CAPS_protmethod InitializeDefault

Used to initialize a default set of values for the ConfigurationElement object.(Inherited from ConfigurationElement.)

System_CAPS_protmethod IsModified

Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_pubmethod IsReadOnly

Gets a value indicating whether the ConfigurationElement object is read-only.(Inherited from ConfigurationElement.)

System_CAPS_protmethod Reset

Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.(Inherited from ConfigurationElement.)

System_CAPS_protmethod ResetModified

Resets the value of the IsModified method to false when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_protmethod SerializeElement

Writes the contents of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_protmethod SerializeToXmlElement

Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.(Inherited from ConfigurationElement.)

System_CAPS_protmethod SetReadOnly

Sets the IsReadOnly property for the ConfigurationElement object and all subelements.(Inherited from ConfigurationElement.)

System_CAPS_pubmethod ToString

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethod Unmerge

Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement.)

Remarks

The FormsAuthenticationConfiguration class provides a way to programmatically access and modify the forms element of a configuration authentication section.

This type is part of a group that includes the FormsAuthenticationCredentials,the FormsAuthenticationUserCollection, and the FormsAuthenticationUser types. The types other than the collection type directly affect the underlying configuration tags.

System_CAPS_noteNote

The FormsAuthenticationConfiguration can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is MachineToApplication. Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. For safety and scalability, it is recommended that you use an external repository, such as a database, to keep the users' credentials.

Examples

The following code example shows how to obtain the FormsAuthenticationConfiguration object from the configuration file of an existing Web application. You can use this object to access its members. The configuration file will contain a setup similar to the following.

Note   If you use the credentials section, be sure to follow the guidelines explained at ASP.NET Authentication. For scalability and better security, it is recommended that you use an external database to store the users' credentials. For more information about building secure ASP.NET applications search the Microsoft MSDN Web site (msdn.microsoft.com) for "Securing Your ASP.NET Application" and "Building Secure ASP.NET Applications: Authentication, Authorization, and Secure Communication."

<authentication mode="Forms">
  <forms name="MyAppCookie" loginUrl="login.aspx"
    defaultUrl="default.aspx"
    protection="Encryption" timeout="5" path="aspnetTest"
    slidingExpiration="false"
    cookieless="UseCookies" domain="domainName">
    <credentials passwordFormat="SHA1">
      <user name="aspnetuser1"
        password="5BAA61E4C9B93F3F0682250B6CF8331B7EE68FD8"/>
       <user name="aspnetuser2"
         password="E38AD214943DAAD1D64C102FAEC29DE4AFE9DA3D"/>
    </credentials>          
  </forms>
</authentication> 
// Get the Web application configuration.
System.Configuration.Configuration configuration = 
    WebConfigurationManager.OpenWebConfiguration("/aspnetTest");

// Get the external Authentication section.
AuthenticationSection authenticationSection = 
    (AuthenticationSection)configuration.GetSection(
    "system.web/authentication");

// Get the external Forms section .
FormsAuthenticationConfiguration formsAuthentication =
    authenticationSection.Forms;
' Get the Web application configuration.
  Dim configuration As System.Configuration.Configuration = _
  WebConfigurationManager.OpenWebConfiguration( _
  "/aspnetTest")

' Get the external Authentication section.
  Dim authenticationSection _
  As AuthenticationSection = _
  CType(configuration.GetSection( _
  "system.web/authentication"), AuthenticationSection)

' Get the external Forms section .
  Dim formsAuthentication _
  As FormsAuthenticationConfiguration = _
  authenticationSection.Forms
Version Information
.NET Framework
Available since 2.0
Thread Safety

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

Return to top