Export (0) Print
Expand All

AuthenticationSection Class

Configures the authentication for a Web application. This class cannot be inherited.

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

public sealed class AuthenticationSection : ConfigurationSection
public final class AuthenticationSection extends ConfigurationSection
public final class AuthenticationSection extends ConfigurationSection
Not applicable.

The AuthenticationSection class provides a way to programmatically access and modify the authentication section of a configuration file.

NoteNote:

The AuthenticationSection can write information into the related section of the configuration file according to the restrictions defined by the section property AllowDefinition 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.

This section provides two code examples. The first demonstrates how to specify values declaratively for several attributes of the authentication section, which can also be accessed as members of the AuthenticationSection class. The second demonstrates how to use the AuthenticationSection class.

The following configuration file example shows how to specify values declaratively for the authentication section.

NoteNote:

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 the use of an external database to store the users' credentials. For more information about building secure ASP.NET applications search the Microsoft MSDN Web site (http://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="MyAppCookieName" loginUrl="login.aspx">
    <credentials passwordFormat="SHA1">
      <user name="Kim"
         password="07B7F3EE06F278DB966BE960E7CBBD103DF30CA6"/>
      <user name="John"
         password="BA56E5E0366D003E98EA1C7F04ABF8FCB3753889"/>
    </credentials>
  </forms>
</authentication>

The following code example demonstrates how to use the AuthenticationSection class.

// Get the Web application configuration.
System.Configuration.Configuration configuration =
    System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(
    "/aspnetTest");

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


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

Windows 98, Windows Server 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft