SqlMembershipProvider Class

Reference

Definition

Namespace:: System.Web.Security

Assembly:: System.Web.dll

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.

Manages storage of membership information for an ASP.NET application in a SQL Server database.

public ref class SqlMembershipProvider : System::Web::Security::MembershipProvider

public class SqlMembershipProvider : System.Web.Security.MembershipProvider

type SqlMembershipProvider = class
    inherit MembershipProvider

Public Class SqlMembershipProvider
Inherits MembershipProvider

Inheritance: Object

ProviderBase

MembershipProvider
SqlMembershipProvider

Examples

The following code example shows the Web.config file for an ASP.NET application configured to use a SqlMembershipProvider.

<configuration>  
  <connectionStrings>  
    <add name="SqlServices" connectionString="Data Source=localhost;Integrated Security=SSPI;Initial Catalog=aspnetdb;" />  
  </connectionStrings>  
  <system.web>  
    <authentication mode="Forms" >  
      <forms loginUrl="login.aspx"  
        name=".ASPXFORMSAUTH" />  
    </authentication>  
    <authorization>  
      <deny users="?" />  
    </authorization>  
    <membership defaultProvider="SqlProvider"  
      userIsOnlineTimeWindow="15">  
      <providers>  
        <add   
          name="SqlProvider"   
          type="System.Web.Security.SqlMembershipProvider"   
          connectionStringName="SqlServices"  
          applicationName="MyApplication"  
          enablePasswordRetrieval="false"  
          enablePasswordReset="true"  
          requiresQuestionAndAnswer="true"  
          requiresUniqueEmail="false"  
          passwordFormat="Hashed"  
          maxInvalidPasswordAttempts="5"  
          passwordAttemptWindow="10" />  
      </providers>  
    </membership>  
  </system.web>  
</configuration>

Remarks

Note

ASP.NET membership providers have been superseded by ASP.NET Identity. We strongly recommend updating apps to use the ASP.NET Identity platform instead of the membership providers.

This class is used by the Membership and MembershipUser classes to provide membership services for an ASP.NET application using a SQL Server database. You cannot use a SqlMembershipProvider without SQL Server. When your computer has SQL Server Express installed with the default instance name and user-instancing enabled, the SqlMembershipProvider object will create a database called aspnetdb in the application's App_Data directory the first time the application is run.

To manually create the database, run the Aspnet_regsql.exe executable found in the %systemroot%\Microsoft.NET\Framework\ versionNumber folder and specify the -A m option (for example aspnet_regsql.exe -A m). The database created is called Aspnetdb. Alternatively, run Aspnet_regsql.exe to pull up the GUI configuration mode and choose to configure all ASP.NET Features.

If the membership provider is configured with a connection string that uses integrated security, the process account of the ASP.NET application must have rights to connect to the SQL Server database.

The Machine.config file defines a default SqlMembershipProvider instance named AspNetSqlMembershipProvider that connects to the default SQL Server Express instance on the local machine. You can use this instance of the provider if you installed SQL Server Express with the default instance name, or you can define your own instance in the Web.config file for your ASP.NET application.

If you set the passwordCompatMode attribute to Framework40, the application can use the hashing and encryption membership options that were added in ASP.NET 4. However, if the passwordCompatMode attribute is set to Framework20, only the hashing and encryption membership options from the ASP.NET 2.0, ASP.NET 3.5, and ASP.NET 3.5 SP1 can be used. The default value is Framework20. For more information, see MembershipPasswordCompatibilityMode.

Constructors

SqlMembershipProvider()

Initializes a new instance of the SqlMembershipProvider class.

Properties

ApplicationName	Gets or sets the name of the application to store and retrieve membership information for.
Description	Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs). (Inherited from ProviderBase)
EnablePasswordReset	Gets a value indicating whether the SQL Server membership provider is configured to allow users to reset their passwords.
EnablePasswordRetrieval	Gets a value indicating whether the SQL Server membership provider is configured to allow users to retrieve their passwords.
MaxInvalidPasswordAttempts	Gets the number of invalid password or password-answer attempts allowed before the membership user is locked out.
MinRequiredNonAlphanumericCharacters	Gets the minimum number of special characters that must be present in a valid password.
MinRequiredPasswordLength	Gets the minimum length required for a password.
Name	Gets the friendly name used to refer to the provider during configuration. (Inherited from ProviderBase)
PasswordAttemptWindow	Gets the time window between which consecutive failed attempts to provide a valid password or password answers are tracked.
PasswordFormat	Gets a value indicating the format for storing passwords in the SQL Server membership database.
PasswordStrengthRegularExpression	Gets the regular expression used to evaluate a password.
RequiresQuestionAndAnswer	Gets a value indicating whether the SQL Server membership provider is configured to require the user to answer a password question for password reset and retrieval.
RequiresUniqueEmail	Gets a value indicating whether the SQL Server membership provider is configured to require a unique email address for each user name.

Methods

ChangePassword(String, String, String)	Modifies a user's password.
ChangePasswordQuestionAndAnswer(String, String, String, String)	Updates the password question and answer for a user in the SQL Server membership database.
CreateUser(String, String, String, String, String, Boolean, Object, MembershipCreateStatus)	Adds a new user to the SQL Server membership database.
DecryptPassword(Byte[])	Decrypts an encrypted password. (Inherited from MembershipProvider)
DeleteUser(String, Boolean)	Removes a user's membership information from the SQL Server membership database.
EncryptPassword(Byte[], MembershipPasswordCompatibilityMode)	Encrypts the specified password using the specified password-compatibility mode. (Inherited from MembershipProvider)
EncryptPassword(Byte[])	Encrypts a password. (Inherited from MembershipProvider)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindUsersByEmail(String, Int32, Int32, Int32)	Returns a collection of membership users for which the email address field contains the specified email address.
FindUsersByName(String, Int32, Int32, Int32)	Gets a collection of membership users where the user name contains the specified user name to match.
GeneratePassword()	Generates a random password that is at least 14 characters long.
GetAllUsers(Int32, Int32, Int32)	Gets a collection of all the users in the SQL Server membership database.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetNumberOfUsersOnline()	Returns the number of users currently accessing the application.
GetPassword(String, String)	Returns the password for the specified user name from the SQL Server membership database.
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetUser(Object, Boolean)	Gets the information from the data source for the membership user associated with the specified unique identifier and updates the last activity date/time stamp for the user, if specified.
GetUser(String, Boolean)	Returns information from the SQL Server membership database for a user and provides an option to update the last activity date/time stamp for the user.
GetUserNameByEmail(String)	Gets the user name associated with the specified email address.
Initialize(String, NameValueCollection)	Initializes the SQL Server membership provider with the property values specified in the ASP.NET application's configuration file. This method is not intended to be used directly from your code.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnValidatingPassword(ValidatePasswordEventArgs)	Raises the ValidatingPassword event if an event handler has been defined. (Inherited from MembershipProvider)
ResetPassword(String, String)	Resets a user's password to a new, automatically generated password.
ToString()	Returns a string that represents the current object. (Inherited from Object)
UnlockUser(String)	Clears the user's locked-out status so that the membership user can be validated.
UpdateUser(MembershipUser)	Updates information about a user in the SQL Server membership database.
ValidateUser(String, String)	Verifies that the specified user name and password exist in the SQL Server membership database.

Events

ValidatingPassword

Occurs when a user is created, a password is changed, or a password is reset.

(Inherited from MembershipProvider)

Applies to

Share via