AuthorizationStoreRoleProvider AuthorizationStoreRoleProvider AuthorizationStoreRoleProvider AuthorizationStoreRoleProvider Class

Definition

Manages storage of role-membership information for an ASP.NET application in an authorization-manager policy store, either in an XML file, in an Active Directory, or on an Active Directory Application Mode server.

public ref class AuthorizationStoreRoleProvider : System::Web::Security::RoleProvider
public class AuthorizationStoreRoleProvider : System.Web.Security.RoleProvider
type AuthorizationStoreRoleProvider = class
    inherit RoleProvider
Public Class AuthorizationStoreRoleProvider
Inherits RoleProvider
Inheritance
AuthorizationStoreRoleProviderAuthorizationStoreRoleProviderAuthorizationStoreRoleProviderAuthorizationStoreRoleProvider

Examples

The following code example shows a Web.config file set to use the AuthorizationStoreRoleProvider for role management.

<configuration>  
  <connectionStrings>  
    <add name="AuthorizationServices" connectionString="msxml://~\App_Data\SampleStore.xml" />  
  </connectionStrings>  

  <system.web>  

    <authentication mode="Windows" />  
    <identity impersonate="true" />  

    <roleManager defaultProvider="AuthorizationStoreRoleProvider"   
      enabled="true"  
      cacheRolesInCookie="true"  
      cookieName=".ASPROLES"  
      cookieTimeout="30"  
      cookiePath="/"  
      cookieRequireSSL="false"  
      cookieSlidingExpiration="true"  
      cookieProtection="All" >  
      <providers>  
        <clear />  
          <add  
            name="AuthorizationStoreRoleProvider"  
            type="System.Web.Security.AuthorizationStoreRoleProvider"  
            connectionStringName="AuthorizationServices"  
            applicationName="SampleApplication"   
            cacheRefreshInterval="60"  
            scopeName="" />  
      </providers>  
    </roleManager>  

  </system.web>  
</configuration>  

Remarks

This class is used by the Roles and RolePrincipal classes to provide role-management services for an ASP.NET application using an authorization-manager store. You can use role management to specify different levels of authorization for your application. The authorization manager can be accessed using the Microsoft Management Console.

The AuthorizationStoreRoleProvider object works with both Windows authentication and forms authentication modes.

You can configure the AuthorizationStoreRoleProvider object to use either a local XML file or an Active Directory or Active Directory Application Mode (ADAM) server. When using a local file, the connection string should look like the following example.

msxml://<path to xml file>  

If the local file is stored in the directory tree of an ASP.NET Web application, you can use the tilde ("~") character to indicate the root directory. For example, to indicate that the local file is stored in the Web application's data directory, you would use a connection string similar to the following example.

msxml://~\App_Data\datafilename.xml

Important

Storing an XML data file in the Web application directory is a potential security threat. By default, IIS will serve XML data files to the Web. To improve security when using a local data file in an ASP.NET application, you should store the data file in the App_Data directory. Files stored in the App_Data directory will not be served to the Web.

If you are using an Active Directory or ADAM server for the policy store, your connection string should be similar to the following example.

msldap://myserver/CN=MyAzManStore,OU=MyOU,DC=MyDomain,DC=MyDC,DC=Com

The exceptions listed in the documentation for AuthorizationStoreRoleProvider object methods are the exceptions that are raised by the AuthorizationStoreRoleProvider object. Since the provider relies on the underlying Authentication Manager runtime, a COMException exception may be thrown whenever the AuthorizationStoreRoleProvider object forwards a method call to the Authentication Manager runtime.

Important

The AuthorizationStoreRoleProvider object has the following requirements for running in partial-trust environments:

When using a file-based policy store in an ASP.NET application, the file I/O permissions granted by the current trust level determine whether read and write actions are allowed by the provider. The ASP.NET application must have read permission on the file to read data from the policy store, and must have write permission to save new information or update existing information in the policy store. The default Medium-trust policy file gives an ASP.NET application read/write permissions in its application directory. The default Low-trust policy file only gives an ASP.NET application read permission in its application directory. In addition, the process identity under which the ASP.NET application runs must have file-system permissions to read and/or write the policy file.

When using an Active Directory or ADAM server, the ASP.NET application needs unmanaged-code permission because the internal AuthorizationStoreRoleProvider object code uses COM interop.

When using the AuthorizationStoreRoleProvider object outside of ASP.NET, the calling code needs unmanaged-code permission.

Constructors

AuthorizationStoreRoleProvider() AuthorizationStoreRoleProvider() AuthorizationStoreRoleProvider() AuthorizationStoreRoleProvider()

Initializes a new instance of the AuthorizationStoreRoleProvider class.

Properties

ApplicationName ApplicationName ApplicationName ApplicationName

Gets or sets the name of the authorization store application for which to store and retrieve role information.

CacheRefreshInterval CacheRefreshInterval CacheRefreshInterval CacheRefreshInterval

Gets the number of minutes between refreshes of the cache of the policy-store data.

Description Description Description Description

Gets a brief, friendly description suitable for display in administrative tools or other user interfaces (UIs).

(Inherited from ProviderBase)
Name Name Name Name

Gets the friendly name used to refer to the provider during configuration.

(Inherited from ProviderBase)
ScopeName ScopeName ScopeName ScopeName

Gets or sets the scope name for the authorization store.

Methods

AddUsersToRoles(String[], String[]) AddUsersToRoles(String[], String[]) AddUsersToRoles(String[], String[]) AddUsersToRoles(String[], String[])

Adds the specified user names to each of the specified roles.

CreateRole(String) CreateRole(String) CreateRole(String) CreateRole(String)

Adds a new role to the role authorization-manager policy store.

DeleteRole(String, Boolean) DeleteRole(String, Boolean) DeleteRole(String, Boolean) DeleteRole(String, Boolean)

Removes a role from the authorization-manager policy store.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
FindUsersInRole(String, String) FindUsersInRole(String, String) FindUsersInRole(String, String) FindUsersInRole(String, String)

This method is not supported by the authorization store role provider.

GetAllRoles() GetAllRoles() GetAllRoles() GetAllRoles()

Gets a list of all the roles for the application.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetRolesForUser(String) GetRolesForUser(String) GetRolesForUser(String) GetRolesForUser(String)

Gets a list of the roles that a user is in.

GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetUsersInRole(String) GetUsersInRole(String) GetUsersInRole(String) GetUsersInRole(String)

Gets a list of users in the specified role.

Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection) Initialize(String, NameValueCollection)

Initializes the authorization-manager role 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.

IsUserInRole(String, String) IsUserInRole(String, String) IsUserInRole(String, String) IsUserInRole(String, String)

Gets a value indicating whether the specified user is in the specified role.

MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
RemoveUsersFromRoles(String[], String[]) RemoveUsersFromRoles(String[], String[]) RemoveUsersFromRoles(String[], String[]) RemoveUsersFromRoles(String[], String[])

Removes the specified user names from the specified roles.

RoleExists(String) RoleExists(String) RoleExists(String) RoleExists(String)

Gets a value indicating whether the specified role name already exists in the authorization-manager policy store.

ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to