CookieAuthenticationOptions Класс

Ссылка

Определение

Пространство имен:: Microsoft.AspNetCore.Builder

Сборка:: Microsoft.AspNetCore.Authentication.Cookies.dll

Пакет:: Microsoft.AspNetCore.Authentication.Cookies v1.0.0

Пакет:: Microsoft.AspNetCore.Authentication.Cookies v1.1.0

Важно!

Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Параметры конфигурации для CookieAuthenticationMiddleware.

public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Builder::AuthenticationOptions, Microsoft::Extensions::Options::IOptions<Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^>

public class CookieAuthenticationOptions : Microsoft.AspNetCore.Builder.AuthenticationOptions, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.CookieAuthenticationOptions>

type CookieAuthenticationOptions = class
    inherit AuthenticationOptions
    interface IOptions<CookieAuthenticationOptions>

Public Class CookieAuthenticationOptions
Inherits AuthenticationOptions
Implements IOptions(Of CookieAuthenticationOptions)

Наследование: Object

AuthenticationOptions
CookieAuthenticationOptions

Реализации: IOptions<CookieAuthenticationOptions>

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

CookieAuthenticationOptions()

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

Свойства

AccessDeniedPath	Свойство AccessDeniedPath сообщает ПО промежуточного слоя, что оно должно изменить исходящий код состояния 403 Forbidden на перенаправление 302 по заданному пути.
AuthenticationScheme	AuthenticationScheme в параметрах соответствует логическому имени для конкретной схемы проверки подлинности. Может быть присвоено другое значение, чтобы использовать одинаковый тип промежуточного ПО проверки подлинности более одного раза на конвейере. (Унаследовано от AuthenticationOptions)
AutomaticAuthenticate	Если значение равно true, ПО промежуточного слоя для проверки подлинности изменит запрос пользователя. Если задано значение false, ПО промежуточного слоя для проверки подлинности будет предоставлять удостоверение только при явном указании AuthenticationScheme. (Унаследовано от AuthenticationOptions)
AutomaticChallenge	Если значение равно true, ПО промежуточного слоя проверки подлинности должно обрабатывать автоматический запрос. Если значение равно false, ПО промежуточного слоя для проверки подлинности изменит ответы только при явном указании AuthenticationScheme. (Унаследовано от AuthenticationOptions)
ClaimsIssuer	Возвращает или задает издателя, который должен использоваться для всех создаваемых утверждений. (Унаследовано от AuthenticationOptions)
CookieDomain	Определяет домен, используемый для создания файла cookie. По умолчанию не предоставляется.
CookieHttpOnly	Определяет, следует ли браузеру разрешать JavaScript на стороне клиента доступ к файлам cookie. Значение по умолчанию — true, что означает, что файлы cookie будут передаваться только в HTTP-запросы, и скрипту на странице не будет разрешен к ним доступ.
CookieManager	Компонент, использованный для получения файлов cookie из запроса или задания их для отклика. Диспетчер ChunkingCookieManager, который будет использоваться по умолчанию.
CookieName	Определяет имя файла cookie, используемого для сохранения удостоверения. Значение по умолчанию — ". AspNetCore.Cookies". Это значение следует изменить при изменении имени AuthenticationScheme, особенно если система использует ПО промежуточного слоя для проверки подлинности файлов cookie несколько раз.
CookiePath	Определяет путь, используемый для создания файла cookie. Значение по умолчанию — "/" для обеспечения максимальной совместимости с браузером.
CookieSecure	Определяет, должны ли файлы cookie передаваться только в HTTPS-запросе. По умолчанию файлы cookie ограничиваются HTTPS-запросами, если страница, на которой выполняется SignIn, также является HTTPS-страницей. Если имеется страница входа HTTPS, а некоторые части сайта — HTTP, то может потребоваться изменить это значение.
DataProtectionProvider	Если этот параметр задан, он будет использоваться cookieAuthenticationMiddleware для защиты данных.
Description	Дополнительная информация о типе проверки подлинности, доступная в приложении. (Унаследовано от AuthenticationOptions)
Events	Параметр Provider может назначаться экземпляру объекта, созданному приложением в во время запуска. ПО промежуточного слоя вызывает методы поставщика, которые предоставляют приложению управление в определенных точках обработки. Если он не предоставлен, то используется экземпляр по умолчанию, который ничего не делает при вызове методов.
ExpireTimeSpan	Управляет временем, в течение которого файл cookie остается действительным с момента его создания. Сведения об истечении срока действия находятся в защищенном билете файла cookie. Вследствие этого файл cookie с истекшим сроком действия будет игнорироваться, даже если он передается на сервер после того, как браузер должен был очистить его.
LoginPath	Свойство LoginPath информирует ПО промежуточного слоя, что следует изменить исходящий код состояния "401 - не санкционировано" на 302 — перенаправление по указанному пути входа. Текущий URL-адрес, создавший код 401, добавляется в LoginPath как параметр строки запроса, именованный ReturnUrlParameter. Когда запрос к LoginPath предоставляет новое удостоверение входа, значение ReturnUrlParameter используется для перенаправления браузера обратно. на URL-адрес, который вызвал исходный код состояния несанкционированного доступа.
LogoutPath	Если ПО промежуточного слоя использует LogoutPath, то запрос по этому пути будет перенаправляться на основе ReturnUrlParameter.
ReturnUrlParameter	ReturnUrlParameter определяет имя параметра строки запроса, который добавляется ПО промежуточного слоя, когда код состояния "401 - не санкционировано" изменяется на 302 — перенаправление по пути входа. Это также параметр строки запроса, который ищется, когда запрос прибывает в путь входа или в путь выхода, чтобы получить исходный URL-адрес после выполнения этого действия.
SessionStore	Необязательный контейнер, в котором хранится удостоверение для всех запросов. При использовании только идентификатор сеанса отправляется клиенту. Можно использовать, чтобы нейтрализовать проблемы с большим числом удостоверений.
SlidingExpiration	Параметр SlidingExpiration устанавливается в значение true, чтобы указать ПО промежуточного слоя, что следует выдавать новый файл cookie с новым окончанием срока действия каждый раз при обработке запроса, когда истекло более половины срока действия.
SystemClock	Только для тестирования.
SystemClock	Только для тестирования. (Унаследовано от AuthenticationOptions)
TicketDataFormat	TicketDataFormat используется для установки и снятия защиты Identity и других свойств, хранящихся в значении файла cookie. Если он не указан, обработчик данных по умолчанию создается с помощью службы защиты данных, содержащейся в IApplicationBuilder.Properties. Служба защиты данных по умолчанию зависит от ключа машины при работе в ASP.NET или от DPAPI при работе в другом процессе.

Явные реализации интерфейса

IOptions<CookieAuthenticationOptions>.Value

Параметры конфигурации для CookieAuthenticationMiddleware.

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

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