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() |
Создание экземпляра параметров, инициализированных со значениями по умолчанию |
Свойства
| Имя | Описание |
|---|---|
| AccessDeniedPath |
Свойство AccessDeniedPath используется обработчиком для целевого объекта перенаправления при обработке ForbidAsync. |
| ClaimsIssuer |
Возвращает или задает издателя, который должен использоваться для всех созданных утверждений. (Унаследовано от AuthenticationSchemeOptions) |
| Cookie |
Определяет параметры, используемые для создания файла cookie. |
| CookieDomain |
Устаревшие..
Это свойство устарело и будет удалено в будущей версии. Рекомендуемая альтернатива — <seealso cref="P:Майкрософт. AspNetCore.Http.CookieBuilder.Domain"></seealso> в Cookie. Определяет домен, используемый для создания файла cookie. Не предоставляется по умолчанию. |
| CookieHttpOnly |
Устаревшие..
Устаревшие..
Это свойство устарело и будет удалено в будущей версии. Рекомендуемая альтернатива — <seealso cref="P:Майкрософт. AspNetCore.Http.CookieBuilder.HttpOnly"></seealso> в Cookie. Определяет, должен ли браузер разрешить доступ к файлу cookie на стороне клиента javascript. Значение по умолчанию имеет значение true, что означает, что файл cookie передается только http-запросам и не предоставляется скрипту на странице. |
| CookieManager |
Компонент, используемый для получения файлов cookie из запроса или задания их в ответе. ChunkingCookieManager будет использоваться по умолчанию. |
| CookieName |
Устаревшие..
Устаревшие..
Это свойство устарело и будет удалено в будущей версии. Рекомендуемая альтернатива — <seealso cref="P:Майкрософт. AspNetCore.Http.CookieBuilder.Name"></seealso> в Cookie. Определяет имя файла cookie, используемое для сохранения удостоверения. Значение по умолчанию — ". AspNetCore.Cookies". Это значение следует изменить, если изменить имя AuthenticationScheme, особенно если система использует обработчик проверки подлинности cookie несколько раз. |
| CookiePath |
Устаревшие..
Это свойство устарело и будет удалено в будущей версии. Рекомендуемая альтернатива — <seealso cref="P:Майкрософт. AspNetCore.Http.CookieBuilder.Path"></seealso> на Cookie. Определяет путь, используемый для создания файла cookie. Значение по умолчанию — "/" для максимальной совместимости браузера. |
| CookieSecure |
Устаревшие..
Это свойство устарело и будет удалено в будущей версии. Рекомендуемая альтернатива — <seealso cref="P:Майкрософт. AspNetCore.Http.CookieBuilder.SecurePolicy"></seealso> в Cookie. Определяет, должен ли файл cookie передаваться только по HTTPS-запросу. По умолчанию файл cookie ограничивается HTTPS-запросами, если страница, выполняющая вход, также httpS. Если у вас есть страница входа HTTPS и части сайта, возможно, потребуется изменить это значение. |
| DataProtectionProvider |
Если этот параметр будет использоваться cookieAuthenticationHandler для защиты данных. |
| Events |
Поставщик может быть назначен экземпляру объекта, созданного приложением во время запуска. Обработчик вызывает методы поставщика, предоставляющие элемент управления приложением в определенных точках, где выполняется обработка. Если экземпляр по умолчанию не указан, он ничего не делает при вызове методов. |
| EventsType |
Если задано, он будет использоваться в качестве типа службы для получения экземпляра events вместо свойства. (Унаследовано от AuthenticationSchemeOptions) |
| ExpireTimeSpan |
Определяет, сколько времени, когда запрос проверки подлинности, хранящийся в файле cookie, останется действительным с момента его создания. Сведения об истечении срока действия хранятся в защищенном билете cookie. Из-за этого просроченный файл cookie будет игнорироваться, даже если он передается серверу после очистки браузера. Это свойство следует использовать вместо Expirationтого, чтобы игнорировать его. |
| 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, за которым следует ForwardDefaultSelector. Первый непустой результат будет использоваться в качестве целевой схемы для перенаправления. (Унаследовано от AuthenticationSchemeOptions) |
| ForwardDefaultSelector |
Используется для выбора схемы по умолчанию для текущего запроса, в который обработчики проверки подлинности должны пересылать все операции проверки подлинности по умолчанию. Логика переадресации по умолчанию проверяет наиболее конкретный параметр ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut, а затем проверит параметр ForwardDefaultSelector, за которым следует ForwardDefaultSelector. Первый непустой результат будет использоваться в качестве целевой схемы для перенаправления. (Унаследовано от 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 |
Для скользящего экспирации задано значение true, чтобы указать обработчику повторно выдавать новый файл cookie с новым сроком действия в любой момент, когда он обрабатывает запрос, который превышает половину периода окончания срока действия. |
| TicketDataFormat |
TicketDataFormat используется для защиты и отмены защиты удостоверения и других свойств, хранящихся в значении файла cookie. Если он не указан, будет создан с помощью DataProtectionProvider. |
| TimeProvider |
Используется для тестирования. (Унаследовано от AuthenticationSchemeOptions) |
Методы
| Имя | Описание |
|---|---|
| Validate() |
Убедитесь, что параметры допустимы. Должен вызывать исключение, если вещи не в порядке. (Унаследовано от AuthenticationSchemeOptions) |
| Validate(String) |
Проверяет, допустимы ли параметры для определенной схемы (Унаследовано от AuthenticationSchemeOptions) |