Поделиться через


FormsAuthenticationConfiguration Класс

Определение

Настройка приложения ASP.NET на использование модальности форм AuthenticationMode.

public ref class FormsAuthenticationConfiguration sealed : System::Configuration::ConfigurationElement
public sealed class FormsAuthenticationConfiguration : System.Configuration.ConfigurationElement
type FormsAuthenticationConfiguration = class
    inherit ConfigurationElement
Public NotInheritable Class FormsAuthenticationConfiguration
Inherits ConfigurationElement
Наследование
FormsAuthenticationConfiguration

Примеры

В следующем примере кода показано, как получить FormsAuthenticationConfiguration объект из файла конфигурации существующего веб-приложения. Этот объект можно использовать для доступа к его членам. Файл конфигурации будет содержать программу установки, аналогичную приведенной ниже.

Примечание Если вы используете credentials этот раздел, обязательно следуйте рекомендациям, приведенным в статье проверка подлинности ASP.NET. Для обеспечения масштабируемости и повышения безопасности рекомендуется использовать внешнюю базу данных для хранения учетных данных пользователей. Дополнительные сведения о создании безопасных приложений ASP.NET см. в статьях Защита приложения ASP.NET и Создание безопасных приложений ASP.NET: проверка подлинности, авторизация и безопасный обмен данными.

В этом примере используется SHA1. Из-за конфликта с SHA1 корпорация Майкрософт рекомендует использовать SHA256.

<authentication mode="Forms">
  <forms name="MyAppCookie" loginUrl="login.aspx"
    defaultUrl="default.aspx"
    protection="Encryption" timeout="5" path="aspnetTest"
    slidingExpiration="false"
    cookieless="UseCookies" domain="domainName">
    <credentials passwordFormat="SHA1">
      <user name="aspnetuser1"
        password="5BAA61E4C9B93F3F0682250B6CF8331B7EE68FD8"/>
       <user name="aspnetuser2"
         password="E38AD214943DAAD1D64C102FAEC29DE4AFE9DA3D"/>
    </credentials>
  </forms>
</authentication>
// Get the Web application configuration.
System.Configuration.Configuration configuration = 
    WebConfigurationManager.OpenWebConfiguration("/aspnetTest");

// Get the external Authentication section.
AuthenticationSection authenticationSection = 
    (AuthenticationSection)configuration.GetSection(
    "system.web/authentication");

// Get the external Forms section .
FormsAuthenticationConfiguration formsAuthentication =
    authenticationSection.Forms;
' Get the Web application configuration.
  Dim configuration As System.Configuration.Configuration = _
  WebConfigurationManager.OpenWebConfiguration( _
  "/aspnetTest")

' Get the external Authentication section.
  Dim authenticationSection _
  As AuthenticationSection = _
  CType(configuration.GetSection( _
  "system.web/authentication"), AuthenticationSection)

' Get the external Forms section .
  Dim formsAuthentication _
  As FormsAuthenticationConfiguration = _
  authenticationSection.Forms

Комментарии

Класс FormsAuthenticationConfiguration предоставляет способ программного доступа к элементу forms раздела конфигурации authentication и его изменения.

Этот тип является частью группы, включающей FormsAuthenticationCredentialsтипы , FormsAuthenticationUserCollectionи FormsAuthenticationUser . Типы, отличные от типа коллекции, напрямую влияют на базовые теги конфигурации.

Примечание

может FormsAuthenticationConfiguration записывать сведения в связанный раздел файла конфигурации в соответствии с ограничениями, определенными свойством AllowDefinition section, значением которого является MachineToApplication. Любая попытка записи в файл конфигурации на уровне, который не разрешен в иерархии, приведет к порождению средства синтаксического анализа сообщения об ошибке. Однако этот класс можно использовать для чтения сведений о конфигурации на любом уровне иерархии. Для обеспечения безопасности и масштабируемости рекомендуется использовать внешний репозиторий, например базу данных, для хранения учетных данных пользователей.

Конструкторы

FormsAuthenticationConfiguration()

Инициализирует новый экземпляр класса FormsAuthenticationConfiguration.

Свойства

Cookieless

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

CookieSameSite

Получает или устанавливает значение атрибута SameSite файла cookie.

Credentials

Возврат коллекции FormsAuthenticationCredentials, в которой содержатся имена пользователей и пароли.

CurrentConfiguration

Возвращает ссылку на экземпляр Configuration верхнего уровня, представляющий иерархию конфигурации, к которой относится текущий экземпляр ConfigurationElement.

(Унаследовано от ConfigurationElement)
DefaultUrl

Получает или задает используемый по умолчанию URL-адрес.

Domain

Получает или задает имя домена, которое передается в файлах cookie при проверке подлинности на основе форм.

ElementInformation

Возвращает объект ElementInformation, содержащий неизменяемую информацию и функциональность объекта ConfigurationElement.

(Унаследовано от ConfigurationElement)
ElementProperty

Возвращает объект ConfigurationElementProperty, представляющий сам объект ConfigurationElement.

(Унаследовано от ConfigurationElement)
EnableCrossAppRedirects

Получает или задает значение, определяющее возможность перенаправления пользователей, прошедших проверку подлинности, по URL-адресам других приложений.

EvaluationContext

Возвращает объект ContextInformation для объекта ConfigurationElement.

(Унаследовано от ConfigurationElement)
HasContext

Возвращает значение, указывающее, имеет ли свойство CurrentConfiguration значение null.

(Унаследовано от ConfigurationElement)
Item[ConfigurationProperty]

Возвращает или задает свойство или атрибут данного элемента конфигурации.

(Унаследовано от ConfigurationElement)
Item[String]

Получает или задает свойство, атрибут или дочерний элемент данного элемента конфигурации.

(Унаследовано от ConfigurationElement)
LockAllAttributesExcept

Возвращает коллекцию заблокированных атрибутов.

(Унаследовано от ConfigurationElement)
LockAllElementsExcept

Возвращает коллекцию заблокированных элементов.

(Унаследовано от ConfigurationElement)
LockAttributes

Возвращает коллекцию заблокированных атрибутов.

(Унаследовано от ConfigurationElement)
LockElements

Возвращает коллекцию заблокированных элементов.

(Унаследовано от ConfigurationElement)
LockItem

Возвращает или задает значение, указывающее, заблокирован ли элемент.

(Унаследовано от ConfigurationElement)
LoginUrl

Получает или задает URL-адрес, по которому перенаправляется запрос.

Name

Возвращает или задает имя файла cookie.

Path

Получает или задает путь к файлу cookie.

Properties

Возвращает коллекцию свойств.

(Унаследовано от ConfigurationElement)
Protection

Возвращает или задает тип шифрования для файла cookie.

RequireSSL

Возвращает или задает значение, показывающее, требуется ли подключение по протоколу SSL при передаче информации проверки подлинности.

SlidingExpiration

Получает или задает скользящий срок действия проверки подлинности.

TicketCompatibilityMode

Получает или задает значение, указывающее, какое время используется для даты окончания срока действия билета при проверке подлинности форм: в формате UTC или местное.

Timeout

Получает или задает время ожидания проверки подлинности.

Методы

DeserializeElement(XmlReader, Boolean)

Считывает XML из файла конфигурации.

(Унаследовано от ConfigurationElement)
Equals(Object)

Сравнивает текущий экземпляр ConfigurationElement с указанным объектом.

(Унаследовано от ConfigurationElement)
GetHashCode()

Получает уникальное значение, представляющее текущий экземпляр ConfigurationElement.

(Унаследовано от ConfigurationElement)
GetTransformedAssemblyString(String)

Возвращает преобразованную версию указанного имени сборки.

(Унаследовано от ConfigurationElement)
GetTransformedTypeString(String)

Возвращает преобразованную версию указанного имени типа.

(Унаследовано от ConfigurationElement)
GetType()

Возвращает объект Type для текущего экземпляра.

(Унаследовано от Object)
Init()

Задает объект ConfigurationElement в исходное состояние.

(Унаследовано от ConfigurationElement)
InitializeDefault()

Используется для инициализации набора значений по умолчанию для объекта ConfigurationElement.

(Унаследовано от ConfigurationElement)
IsModified()

При реализации в производном классе указывает, был ли изменен данный элемент конфигурации с момента последнего сохранения или загрузки.

(Унаследовано от ConfigurationElement)
IsReadOnly()

Получает значение, показывающее, является ли объект ConfigurationElement доступным только для чтения.

(Унаследовано от ConfigurationElement)
ListErrors(IList)

Добавляет ошибку "недействительное свойство" в данном объекте ConfigurationElement и всех его дочерних элементах к переданному списку.

(Унаследовано от ConfigurationElement)
MemberwiseClone()

Создает неполную копию текущего объекта Object.

(Унаследовано от Object)
OnDeserializeUnrecognizedAttribute(String, String)

Возвращает значение, указывающее, встретился ли неизвестный атрибут при десериализации.

(Унаследовано от ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

Возвращает значение, указывающее, встретился ли неизвестный элемент при десериализации.

(Унаследовано от ConfigurationElement)
OnRequiredPropertyNotFound(String)

Выдает исключение, если требуемое свойство не найдено.

(Унаследовано от ConfigurationElement)
PostDeserialize()

Вызывается после десериализации.

(Унаследовано от ConfigurationElement)
PreSerialize(XmlWriter)

Вызывается до сериализации.

(Унаследовано от ConfigurationElement)
Reset(ConfigurationElement)

Восстанавливает внутреннее состояние объекта ConfigurationElement, включая блокировки и коллекции свойств.

(Унаследовано от ConfigurationElement)
ResetModified()

Переустанавливает значение метода IsModified() в false при реализации в производном классе.

(Унаследовано от ConfigurationElement)
SerializeElement(XmlWriter, Boolean)

Записывает содержание данного элемента конфигурации в файл конфигурации при реализации в производном классе.

(Унаследовано от ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)

Записывает внешние теги данного элемента конфигурации в файл конфигурации при реализации в производном классе.

(Унаследовано от ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

Задает для свойства указанное значение.

(Унаследовано от ConfigurationElement)
SetReadOnly()

Задает свойство IsReadOnly() для объекта ConfigurationElement и всех подчиненных элементов.

(Унаследовано от ConfigurationElement)
ToString()

Возвращает строку, представляющую текущий объект.

(Унаследовано от Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Изменяет объект ConfigurationElement для удаления всех значений, которые не должны сохраняться.

(Унаследовано от ConfigurationElement)

Применяется к

См. также раздел