CookieAuthenticationOptions Класс

Определение

Параметры конфигурации для 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)
Наследование
CookieAuthenticationOptions
Реализации

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

CookieAuthenticationOptions()

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

Свойства

AccessDeniedPath

Свойство Акцессдениедпас информирует по промежуточного слоя о том, что необходимо изменить исходящий код состояния 403 с запретом на перенаправление 302 по заданному пути.

AuthenticationScheme

Аусентикатионсчеме в параметрах соответствует логическому имени для конкретной схемы проверки подлинности. Может быть присвоено другое значение, чтобы использовать одинаковый тип промежуточного ПО проверки подлинности более одного раза на конвейере.

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

Если задано значение true, промежуточное по проверки подлинности изменяет пользователя запроса, входящего в. Если значение равно false, по промежуточного слоя проверки подлинности предоставит удостоверение только при явном указании Аусентикатионсчеме.

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

Если задано значение true, по промежуточного слоя проверки подлинности должно работать автоматически. Если задано значение false, по промежуточного слоя проверки подлинности будет изменять только те ответы, которые явно указаны Аусентикатионсчеме.

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

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

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

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

CookieHttpOnly

Определяет, следует ли браузеру разрешать JavaScript на стороне клиента доступ к файлам cookie. Значение по умолчанию — true, что означает, что файлы cookie будут передаваться только в HTTP-запросы, и скрипту на странице не будет разрешен к ним доступ.

CookieManager

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

         Диспетчер ChunkingCookieManager, который будет использоваться по умолчанию.
CookieName

Определяет имя файла cookie, используемого для сохранения удостоверения. Значение по умолчанию —. AspNetCore. cookies». Это значение должно быть изменено при изменении имени Аусентикатионсчеме, особенно если система использует по промежуточного слоя проверки подлинности cookie несколько раз.

CookiePath

Определяет путь, используемый для создания файла cookie. Значение по умолчанию — "/" для обеспечения максимальной совместимости с браузером.

CookieSecure

Определяет, должны ли файлы cookie передаваться только в HTTPS-запросе. По умолчанию файлы cookie ограничиваются HTTPS-запросами, если страница, на которой выполняется SignIn, также является HTTPS-страницей. Если имеется страница входа HTTPS, а некоторые части сайта — HTTP, то может потребоваться изменить это значение.

DataProtectionProvider

Если этот параметр задан, Кукиеаусентикатионмиддлеваре будет использовать для защиты данных.

Description

Дополнительная информация о типе проверки подлинности, доступная в приложении.

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

Параметр Provider может назначаться экземпляру объекта, созданному приложением в во время запуска. По промежуточного слоя вызывает методы поставщика, которые предоставляют Управление приложением в определенных точках, где происходит обработка. Если он не предоставлен, то используется экземпляр по умолчанию, который ничего не делает при вызове методов.

ExpireTimeSpan

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

LoginPath

Свойство LoginPath информирует ПО промежуточного слоя, что следует изменить исходящий код состояния "401 - не санкционировано" на 302 — перенаправление по указанному пути входа. Текущий URL-адрес, создавший код 401, добавляется в LoginPath как параметр строки запроса, именованный ReturnUrlParameter. После того как запрос к Логинпас предоставит новое удостоверение для входа, для перенаправления обратного просмотра используется значение 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

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