System.Web.Security Namespace

---

.NET Framework version 2.0

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

SqlRoleProvider Class Members

Show Inherited Members

Constructors Visibility Constructor Parameters public SqlRoleProvider ( )   Properties Visibility Name Value Type Accessibility public ApplicationName String [ Get , Set ]   Methods Visibility Name Parameters Return Type public AddUsersToRoles ( String usernames , String roleNames ) Void public CreateRole ( String roleName ) Void public DeleteRole ( String roleName , Boolean throwOnPopulatedRole ) Boolean public FindUsersInRole ( String roleName , String usernameToMatch ) String public GetAllRoles ( ) String public GetRolesForUser ( String username ) String public GetUsersInRole ( String roleName ) String public Initialize ( String name , NameValueCollection config ) Void public IsUserInRole ( String username , String roleName ) Boolean public RemoveUsersFromRoles ( String usernames , String roleNames ) Void public RoleExists ( String roleName ) Boolean

This class is used by the Roles and RolePrincipal classes to provide role-management services for an ASP.NET application using a SQL Server database. You can use role management to specify different levels of authorization for your application.

To use the SqlRoleProvider class, you must first create the SQL Server database used by the SqlRoleProvider. To create the database used by the SqlRoleProvider class, run the aspnet_regsql.exe executable found in the C:\WINDOWS\Microsoft.NET\Framework\ versionNumber folder and specify the -Ar option ( for example, aspnet_regsql.exe -Ar ). 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 role 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 is configured with a SqlRoleProvider instance named AspNetSqlProvider that connects to the SQL Server on the local machine. You can use this instance of the provider, or specify your own in the Web.config file for your ASP.NET application. To use the AspNetSqlProvider instance, specify AspNetSqlProvider as the defaultProvider in your roleManager configuration.

You can configure the SqlRoleProvider to use the same database and user information as the SqlMembershipProvider in order to use a single database for authentication and authorization information. To use the same database for membership and role information, run the aspnet_regsql.exe executable and install the membership feature. Then, specify the same connection string in your configuration for both your SqlRoleProvider and SqlMembershipProvider instances. Also ensure that both provider instances are configured with the same ApplicationName.

The following example shows the Web.config file for an ASP.NET application configured to use a SqlRoleProvider object and the SqlMembershipProvider. The authorization element is configured to only allow access to authenticated users in the Administrators role.

<configuration>
   <connectionStrings>
      <add name = "SqlServices" connectionString = 
         "Data Source=localhost;Integrated Security=SSPI;Initial Catalog=aspnetdb;" />
   </connectionStrings>
   <system.web>
      <authentication mode = "Forms" >
         <forms loginUrl = "logincs.aspx"
         name = ".ASPXFORMSAUTH" />
      </authentication>
      <authorization>
         <deny users = "?" />
             <allow roles = "Administrators" />
             <deny users = "*" />
      </authorization>
      <membership defaultProvider = "SqlProvider"
         userIsOnlineTimeWindow = "15">
         <providers>
            <add
               name = "SqlProvider"
               type = "System.Web.Security.SqlMembershipProvider"
               connectionStringName = "SqlServices"
               enablePasswordRetrieval = "false"
               enablePasswordReset = "false"
               requiresQuestionAndAnswer = "false"
               passwordFormat = "Hashed"
               applicationName = "SampleApplication" />
         </providers>
      </membership>
      <roleManager defaultProvider = "SqlProvider"
         enabled = "true"
         cacheRolesInCookie = "true"
         cookieName = ".ASPROLES"
         cookieTimeout = "30"
         cookiePath = "/"
         cookieRequireSSL = "true"
         cookieSlidingExpiration = "true"
         cookieProtection = "All" >
         <providers>
            <add
               name = "SqlProvider"
               type = "System.Web.Security.SqlRoleProvider"
               connectionStringName = "SqlServices"
               applicationName = "SampleApplication" />
         </providers>
      </roleManager>
   </system.web>
</configuration>

SqlMembershipProvider Class

Suggested Reading