FormsAuthentication::HashPasswordForStoringInConfigFile Method
Produces a hash password suitable for storing in a configuration file based on the specified password and hash algorithm.
Assembly: System.Web (in System.Web.dll)
public: static String^ HashPasswordForStoringInConfigFile( String^ password, String^ passwordFormat )
Parameters
- password
- Type: System::String
The password to hash.
- passwordFormat
- Type: System::String
The hash algorithm to use. passwordFormat is a String that represents one of the FormsAuthPasswordFormat enumeration values.
| Exception | Condition |
|---|---|
| ArgumentNullException | password is nullptr -or- passwordFormat is nullptr. |
| ArgumentException | passwordFormat is not a valid FormsAuthPasswordFormat value. |
The HashPasswordForStoringInConfigFile method creates a hashed password value that can be used when storing forms-authentication credentials in the configuration file for an application.
Authentication credentials stored in the configuration file for an application are used by the Authenticate method to verify passwords for users of an application. Alternatively, you can use ASP.NET membership to store user credentials. For more information, see Managing Users by Using Membership.
The following code example takes a user name, password, and hash type and displays the credentials section of the configuration that includes the user definition and hashed password.
Security 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. |
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Security Note