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


CookieAuthenticationOptions Класс

Определение

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

public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions
public class CookieAuthenticationOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions
type CookieAuthenticationOptions = class
    inherit AuthenticationSchemeOptions
Public Class CookieAuthenticationOptions
Inherits AuthenticationSchemeOptions
Наследование
CookieAuthenticationOptions

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

CookieAuthenticationOptions()

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

Свойства

AccessDeniedPath

Свойство AccessDeniedPath используется обработчиком для целевого объекта перенаправления при обработке ForbidAsync.

ClaimsIssuer

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

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

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

CookieDomain
Устаревшие..

Это свойство устарело и будет удалено в следующей версии. Рекомендуемый вариант — в Cookie.

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

CookieHttpOnly
Устаревшие..
Устаревшие..

Это свойство устарело и будет удалено в следующей версии. Рекомендуемый вариант — в Cookie.

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

CookieManager

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

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

CookieName
Устаревшие..
Устаревшие..

Это свойство устарело и будет удалено в следующей версии. Рекомендуемый вариант — в Cookie.

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

CookiePath
Устаревшие..

Это свойство устарело и будет удалено в следующей версии. Рекомендуемый вариант — в Cookie.

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

CookieSecure
Устаревшие..

Это свойство устарело и будет удалено в следующей версии. Рекомендуемый вариант — в Cookie.

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

DataProtectionProvider

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

Events

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

EventsType

Если задано значение , будет использоваться в качестве типа службы для получения экземпляра Events вместо свойства .

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

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

Это значение отличается от значения Expires, которое указывает, как долго браузер будет хранить файл cookie.

ForwardAuthenticate

Если задано значение , это указывает целевую схему, в которую эта схема должна пересылать вызовы AuthenticateAsync. Например, Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue"); Задайте для целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку.

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

Если задано значение , это указывает целевую схему, в которую эта схема должна переадресовывать вызовы ChallengeAsync. Например, Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue"); Задайте для целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку.

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

Если задано значение , это указывает схему по умолчанию, в которую обработчики проверки подлинности должны перенаправлять все операции проверки подлинности по умолчанию. Логика переадресации по умолчанию сначала проверка самый конкретный параметр ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, а затем проверка ForwardDefaultSelector, а затем ForwardDefault. Первый результат, отличный от NULL, будет использоваться в качестве целевой схемы для пересылки.

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

Используется для выбора схемы по умолчанию для текущего запроса, в который обработчики проверки подлинности должны пересылать все операции проверки подлинности по умолчанию. Логика переадресации по умолчанию сначала проверка самый конкретный параметр ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, а затем проверка ForwardDefaultSelector, а затем ForwardDefault. Первый результат, отличный от NULL, будет использоваться в качестве целевой схемы для пересылки.

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

Если задано значение , это указывает целевую схему, в которую эта схема должна пересылать вызовы ForbidAsync. Например, Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue"); Задайте для целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку.

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

Если задано значение , то указывает целевую схему, в которую эта схема должна пересылать вызовы SignInAsync. Например, Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue"); Задайте для целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку.

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

Если задано значение , это указывает целевую схему, в которую эта схема должна пересылать вызовы SignOutAsync. Например, Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue"); Задайте для целевого объекта текущую схему, чтобы отключить пересылку и разрешить нормальную обработку.

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

Свойство LoginPath используется обработчиком для целевого объекта перенаправления при обработке ChallengeAsync. Текущий URL-адрес, который добавляется в LoginPath в качестве параметра строки запроса с именем ReturnUrlParameter. Когда запрос к LoginPath предоставляет новое удостоверение SignIn, значение ReturnUrlParameter используется для перенаправления браузера обратно на исходный URL-адрес.

LogoutPath

Если logoutPath указан обработчик, запрос на этот путь будет перенаправляться на основе ReturnUrlParameter.

ReturnUrlParameter

ReturnUrlParameter определяет имя параметра строки запроса, который добавляется обработчиком во время запроса. Это также параметр строки запроса, который ищется, когда запрос прибывает в путь входа или в путь выхода, чтобы получить исходный URL-адрес после выполнения этого действия.

SessionStore

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

SlidingExpiration

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

TicketDataFormat

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

TimeProvider

Используется для тестирования.

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

Методы

Validate()

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

(Унаследовано от AuthenticationSchemeOptions)
Validate(String)

Проверка допустимости параметров для конкретной схемы

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

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