FormsAuthenticationUser Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Configures the user's credentials for Web applications that use forms-based authentication.
public ref class FormsAuthenticationUser sealed : System::Configuration::ConfigurationElement
public sealed class FormsAuthenticationUser : System.Configuration.ConfigurationElement
type FormsAuthenticationUser = class
inherit ConfigurationElement
Public NotInheritable Class FormsAuthenticationUser
Inherits ConfigurationElement
- Inheritance
Examples
The following code example shows how to obtain the FormsAuthenticationUserCollection to access the FormsAuthenticationUser objects of an existing Web application. The configuration file will contain a setup similar to the following.
Note
If you use the credentials Element for forms for authentication (ASP.NET Settings Schema) section, be sure to follow the guidelines explained at ASP.NET Authentication. For scalability and better security, it is recommended you use an external database to store the users' credentials. For more information about building secure ASP.NET applications, see Securing Your ASP.NET Application and Building Secure ASP.NET Applications: Authentication, Authorization, and Secure Communication.
This example uses SHA1. Due to collision problems with SHA1, Microsoft recommends SHA256.
<authentication mode="Forms">
<forms name="MyAppCookieName" loginUrl="/login.aspx">
defaultUrl="formsdefault.aspx"
protection="Encryption" timeout="5" path="aspnet"
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(
"/aspnet");
// Get the section.
AuthenticationSection authenticationSection =
(AuthenticationSection)configuration.GetSection(
"system.web/authentication");
// Get the users collection.
FormsAuthenticationUserCollection formsAuthenticationUsers =
authenticationSection.Forms.Credentials.Users;
' Get the Web application configuration.
Dim configuration _
As System.Configuration.Configuration = _
WebConfigurationManager.OpenWebConfiguration( _
"/aspnet")
' Get the section.
Dim authenticationSection _
As AuthenticationSection = _
CType(configuration.GetSection( _
"system.web/authentication"), AuthenticationSection)
' Get the users collection.
Dim formsAuthenticationUsers _
As FormsAuthenticationUserCollection = _
authenticationSection.Forms.Credentials.Users
Remarks
The FormsAuthenticationUser class provides a way to programmatically access and modify the credentials element for forms for authentication section of a configuration file.
This type is part of a group that includes the FormsAuthenticationCredentials, the FormsAuthenticationUserCollection, and the FormsAuthenticationConfiguration types. The types other than the collection type directly affect the underlying configuration tags.
Note
The FormsAuthenticationUser can write information into the related section of the configuration file at machine, site, or application level only. Any attempt to write in a configuration file at a different level 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.
Constructors
FormsAuthenticationUser(String, String) |
Initializes a new instance of the FormsAuthenticationUser class using the passed parameters. |
Properties
CurrentConfiguration |
Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement) |
ElementInformation |
Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement) |
ElementProperty |
Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement) |
EvaluationContext |
Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement) |
HasContext |
Gets a value that indicates whether the CurrentConfiguration property is |
Item[ConfigurationProperty] |
Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement) |
Item[String] |
Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement) |
LockAllAttributesExcept |
Gets the collection of locked attributes. (Inherited from ConfigurationElement) |
LockAllElementsExcept |
Gets the collection of locked elements. (Inherited from ConfigurationElement) |
LockAttributes |
Gets the collection of locked attributes. (Inherited from ConfigurationElement) |
LockElements |
Gets the collection of locked elements. (Inherited from ConfigurationElement) |
LockItem |
Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement) |
Name |
Gets or sets the logon user name. |
Password |
Gets or sets the user's password. |
Properties |
Gets the collection of properties. (Inherited from ConfigurationElement) |
Methods
DeserializeElement(XmlReader, Boolean) |
Reads XML from the configuration file. (Inherited from ConfigurationElement) |
Equals(Object) |
Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement) |
GetHashCode() |
Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement) |
GetTransformedAssemblyString(String) |
Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement) |
GetTransformedTypeString(String) |
Returns the transformed version of the specified type name. (Inherited from ConfigurationElement) |
GetType() |
Gets the Type of the current instance. (Inherited from Object) |
Init() |
Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement) |
InitializeDefault() |
Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement) |
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) |
IsReadOnly() |
Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement) |
ListErrors(IList) |
Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement) |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
OnDeserializeUnrecognizedAttribute(String, String) |
Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement) |
OnDeserializeUnrecognizedElement(String, XmlReader) |
Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement) |
OnRequiredPropertyNotFound(String) |
Throws an exception when a required property is not found. (Inherited from ConfigurationElement) |
PostDeserialize() |
Called after deserialization. (Inherited from ConfigurationElement) |
PreSerialize(XmlWriter) |
Called before serialization. (Inherited from ConfigurationElement) |
Reset(ConfigurationElement) |
Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement) |
ResetModified() |
Resets the value of the IsModified() method to |
SerializeElement(XmlWriter, Boolean) |
Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement) |
SerializeToXmlElement(XmlWriter, String) |
Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement) |
SetPropertyValue(ConfigurationProperty, Object, Boolean) |
Sets a property to the specified value. (Inherited from ConfigurationElement) |
SetReadOnly() |
Sets the IsReadOnly() property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement) |
ToString() |
Returns a string that represents the current object. (Inherited from Object) |
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement) |