Элемент roleManager (схема параметров ASP.NET)

  • Статья

Настраивает приложение для управления ролями.

Этот элемент не использовался до .NET Framework версии 2.0.

<roleManager
    cacheRolesInCookie="true|false"
    cookieName="name"
    cookiePath="/"
    cookieProtection="All|Encryption|Validation|None"
    cookieRequireSSL="true|false "
    cookieSlidingExpiration="true|false "
    cookieTimeout="number of minutes"
    createPersistentCookie="true|false"
    defaultProvider="provider name"
    domain="cookie domain">
    enabled="true|false"
    maxCachedResults="maximum number of role names cached"
    <providers>...</providers>
</roleManager>

Атрибуты и элементы

В следующих разделах описаны атрибуты, дочерние элементы и родительские элементы для данного раздела.

Атрибуты

Атрибут

Описание

cacheRolesInCookie

Необязательный атрибут элемента Boolean.

Указывает, что при проверке пользователя с конкретной ролью файл cookie был проверен до использования поставщика ролей для проверки списка ролей в источнике данных. Если значение — true, список имен ролей в файле cookie кэшируется для текущего пользователя, в противном случае значение — false.

Значение по умолчанию — false.

cookieName

Необязательный атрибут String.

Указывает имя файла cookie, в котором хранятся имена ролей.

Значение по умолчанию — ".ASPXROLES".

cookiePath

Необязательный атрибут String.

Путь к файлу cookie с именами ролей.

Значение по умолчанию — "/".

cookieProtection

Необязательный атрибут CookieProtection.

Указывает одно из значений перечисления CookieProtection.

Значение по умолчанию — All.

cookieRequireSSL

Необязательный атрибут Boolean.

Указывает, требуется ли протокол SSL для отправки файла cookie на сервер.

Если значение — true, для отправки файлов cookie с именами ролей необходим протокол SSL.

Значение по умолчанию — false.

cookieSlidingExpiration

Необязательный атрибут Boolean.

Указывает, будет ли выполняться периодический сброс значений даты и времени файла cookie с ролями пользователя.

Если задано значение true, дата истечения срока файла cookie будет установлена в соответствии с текущими значениями даты и времени плюс значение CookieTimeout, выраженное в минутах. Пока пользователь продолжает работать в приложении ASP.NET, дата и время срока истечения файла cookie автоматически обновляются, если оставшееся значение CookieTimeout становится меньше половины. Дополнительные сведения см. в разделе Expires.

Значение по умолчанию — true.

cookieTimeout

Необязательный атрибут Int32.

Количество минут до истечения срока файла cookie с именами ролей.

Значение по умолчанию — "30" (минут).

createPersistentCookie

Необязательный атрибут Boolean.

Указывает, является ли файл cookie с именами ролей файлом cookie сеанса, то есть при закрытии обозревателя этот файл будет потерян.

Если задано значение true, файл cookie с именами ролей является постоянным и доступен в нескольких сеансах обозревателя. Дата истечения срока постоянного файла cookie будет установлена в соответствии с текущими значениями даты и времени плюс значение CookieTimeout, выраженное в минутах.

Значение по умолчанию — false.

defaultProvider

Необязательный атрибут String.

Имя поставщика ролей по умолчанию. Дополнительные сведения см. в разделе Provider.

Значение по умолчанию — "AspNetSqlRoleProvider".

domain

Необязательный атрибут String.

Указывает значение Domain файла с именами ролей.

Значение по умолчанию — HttpCookie, которое является пустой строкой.

enabled

Необязательный атрибут Boolean.

Указывает, будет ли включено управление ролями.

Если задано значение true, управление ролями включено.

По умолчанию в файле Machine.config используется значение false.

maxCachedResults

Необязательный атрибут Int32.

Указывает максимальное количество имен ролей, кэшированных в файле cookie с ролями.

Значение по умолчанию — 25.

Наследуемые атрибуты

Необязательные атрибуты.

Атрибуты, наследуемые всеми элементами section. Дополнительные сведения см. в разделе Общие атрибуты, наследуемые элементами раздела.

Дочерние элементы

Элемент

Описание

providers

Необязательный элемент.

Определяет коллекцию поставщиков ролей для управления ролями.

Родительские элементы

Элемент

Описание

configuration

Задает обязательный корневой элемент любого файла конфигурации, который используется средой CLR и приложениями .NET Framework.

system.web

Задает корневой элемент для раздела конфигурации ASP.NET.

Заметки

Элемент roleManager настраивает приложение для управления ролями.

Сведения о доступе к значениям конфигурации элемента roleManager кода приложения и об изменении этих значений см. в RoleManagerSection.

Настройки по умолчанию

Следующий элемент roleManager по умолчанию не настроен явно в файле Machine.config или корневом файле Web.config. Однако это конфигурация, используемая по умолчанию, возвращаемая приложением. Файл Machine.config явно настроен поставщиками.

<roleManager 
   enabled="false" 
   cacheRolesInCookie="false" 
   cookieName=".ASPXROLES" 
   cookieTimeout="30" 
   cookiePath="/" 
   cookieRequireSSL="false" 
   cookieSlidingExpiration="true" 
   cookieProtection="All" 
   defaultProvider="AspNetSqlRoleProvider" 
   createPersistentCookie="false" 
   maxCachedResults="25">
   <providers>
      <clear />
      <add 
         connectionStringName="LocalSqlServer" 
         applicationName="/" 
         name="AspNetSqlRoleProvider" 
         type="System.Web.Security.SqlRoleProvider, System.Web, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
      <add 
         applicationName="/" 
         name="AspNetWindowsTokenRoleProvider" 
         type="System.Web.Security.WindowsTokenRoleProvider, System.Web, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a" />
   </providers>
</roleManager>

Пример

В следующем примере кода показано, как настроить приложение ASP.NET на использование класса SqlRoleProvider для хранения и извлечения сведений о ролях.

<configuration>
  <system.web>
    <roleManager defaultProvider="SqlProvider" 
      enabled="true"
      cacheRolesInCookie="true"
      cookieName=".ASPROLES"
      cookieTimeout="30"
      cookiePath="/"
      cookieRequireSSL="false"
      cookieSlidingExpiration="true"
      cookieProtection="All" >
      <providers>
        <add
          name="SqlProvider"
          type="System.Web.Security.SqlRoleProvider"
          connectionStringName="SqlServices" 
          applicationName="SampleApplication" />
      </providers>
    </roleManager>
  </system.web>
</configuration>

Сведения об элементе

Обработчик раздела конфигурации

RoleManagerSection

Элемент конфигурации

RoleManager

Настраиваемые расположения

Machine.config

Файл Web.config корневого уровня

Файл Web.config уровня приложения

Требования

Microsoft IIS версии 5.0, 5.1 или 6.0

.NET Framework версии 2.0

Microsoft Visual Studio 2003 или Visual Studio 2005

См. также

Задачи

Практическое руководство. Настройка отдельных каталогов с помощью параметров расположения

Пошаговое руководство. Отключение параметров конфигурации ASP.NET

Ссылки

Элемент system.web (схема параметров ASP.NET)

Элемент providers для элемента roleManager (схема параметров ASP.NET)

Элемент configuration (схема общих параметров)

System.Configuration

System.Web.Configuration

RoleManagerSection

RoleManager

Основные понятия

Основные сведения об управлении ролями

Настройка обеспечения безопасности ASP.NET

Сценарии конфигурации ASP.NET

Другие ресурсы

Общие параметры конфигурации (ASP.NET)

Параметры конфигурации ASP.NET

Справочные сведения о ASP.NET

Администрирование веб-сайта ASP.NET

Конфигурационный API-интерфейс настройки ASP.NET