OAuthHandler<TOptions> Класс

Определение

Пространство имен:

Microsoft.AspNetCore.Authentication.OAuth

Сборка:

Microsoft.AspNetCore.Authentication.OAuth.dll

Пакет:

Microsoft.AspNetCore.App.Ref v8.0.0

Исходный код:

OAuthHandler.cs

Обработчик проверки подлинности, поддерживающий OAuth.

public class OAuthHandler<TOptions> : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions> where TOptions : OAuthOptions, new()

type OAuthHandler<'Options (requires 'Options :> OAuthOptions and 'Options : (new : unit -> 'Options))> = class
    inherit RemoteAuthenticationHandler<'Options (requires 'Options :> OAuthOptions and 'Options : (new : unit -> 'Options))>

Public Class OAuthHandler(Of TOptions)
Inherits RemoteAuthenticationHandler(Of TOptions)

Параметры типа

TOptions

Тип параметров.

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

Object

AuthenticationHandler<TOptions>

RemoteAuthenticationHandler<TOptions>

OAuthHandler<TOptions>

Производный

Microsoft.AspNetCore.Authentication.Facebook.FacebookHandler

Microsoft.AspNetCore.Authentication.Google.GoogleHandler

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountHandler

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

OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)	Инициализирует новый экземпляр OAuthHandler<TOptions>.
OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	Устаревшие.. Инициализирует новый экземпляр OAuthHandler<TOptions>.

Свойства

Backchannel	Возвращает экземпляр HttpClient, используемый для взаимодействия с поставщиком удаленной проверки подлинности.
ChallengeCalled	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от AuthenticationHandler<TOptions>)
ClaimsIssuer	Возвращает издателя, который следует использовать при выдаче любых утверждений. (Унаследовано от AuthenticationHandler<TOptions>)
Clock	Устаревшие.. Возвращает ISystemClock. (Унаследовано от AuthenticationHandler<TOptions>)
Context	Возвращает или задает HttpContext. (Унаследовано от AuthenticationHandler<TOptions>)
CurrentUri	Возвращает абсолютный текущий URL-адрес. (Унаследовано от AuthenticationHandler<TOptions>)
Events	Обработчик вызывает методы событий, которые дают элементу управления приложением в определенных точках, где выполняется обработка. Если экземпляр по умолчанию не указан, он ничего не делает при вызове методов.
InitializeResult	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от AuthenticationHandler<TOptions>)
Logger	Возвращает ILogger. (Унаследовано от AuthenticationHandler<TOptions>)
Options	Возвращает или задает параметры, связанные с этим обработчиком проверки подлинности. (Унаследовано от AuthenticationHandler<TOptions>)
OptionsMonitor	Возвращает IOptionsMonitor<TOptions> для обнаружения изменений параметров. (Унаследовано от AuthenticationHandler<TOptions>)
OriginalPath	Возвращает путь, как показано ПО промежуточного слоя проверки подлинности. (Унаследовано от AuthenticationHandler<TOptions>)
OriginalPathBase	Возвращает базу пути, как показано по промежуточному слоям проверки подлинности. (Унаследовано от AuthenticationHandler<TOptions>)
PriorHandler	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от AuthenticationHandler<TOptions>)
Request	Возвращает HttpRequest, связанную с текущим запросом. (Унаследовано от AuthenticationHandler<TOptions>)
Response	Возвращает HttpResponse, связанную с текущим запросом. (Унаследовано от AuthenticationHandler<TOptions>)
Scheme	Возвращает или задает AuthenticationScheme, связанные с этим обработчиком проверки подлинности. (Унаследовано от AuthenticationHandler<TOptions>)
SignInAccepted	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от AuthenticationHandler<TOptions>)
SignInScheme	Схема проверки подлинности, используемая по умолчанию для входа. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
SignOutAccepted	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от AuthenticationHandler<TOptions>)
TimeProvider	Возвращает текущее время, в первую очередь для модульного тестирования. (Унаследовано от AuthenticationHandler<TOptions>)
UrlEncoder	Возвращает UrlEncoder. (Унаследовано от AuthenticationHandler<TOptions>)

Методы

AuthenticateAsync()	Проверка подлинности текущего запроса. (Унаследовано от AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от AuthenticationHandler<TOptions>)
BuildChallengeUrl(AuthenticationProperties, String)	Создает URL-адрес запроса OAuth.
BuildRedirectUri(String)	Создает абсолютный URL-адрес для указанного targetPath. (Унаследовано от AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	Вызов текущего запроса. (Унаследовано от AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от AuthenticationHandler<TOptions>)
CreateEventsAsync()	Создает новый экземпляр экземпляра событий.
CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse)	Создает AuthenticationTicket из указанного tokens.
ExchangeCodeAsync(OAuthCodeExchangeContext)	Обмен кодом авторизации для маркера авторизации от удаленного поставщика.
FinishResponseAsync()	Перехватчик, который вызывается при отправке ответа (Унаследовано от AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	Запретить текущий запрос. (Унаследовано от AuthenticationHandler<TOptions>)
FormatScope()	Форматирование свойства Scope.
FormatScope(IEnumerable<String>)	Форматирование списка областей OAuth.
GenerateCorrelationId(AuthenticationProperties)	Создает файл cookie, содержащий nonce, используемый для сопоставления текущего запроса удаленной проверки подлинности. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от AuthenticationHandler<TOptions>)
HandleAccessDeniedErrorAsync(AuthenticationProperties)	Производные типы могут переопределить этот метод для обработки ошибок отказа в доступе. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	Позволяет производным типам обрабатывать проверку подлинности. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	Используется для обеспечения вызова HandleAuthenticateAsync только один раз. Последующие вызовы возвращают тот же результат проверки подлинности. (Унаследовано от AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	Используется для обеспечения безопасного вызова HandleAuthenticateAsync. Последующие вызовы возвращают тот же результат проверки подлинности. Все исключения будут преобразованы в результат неудачной проверки подлинности, содержащий исключение. (Унаследовано от AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	Переопределите этот метод, чтобы справиться с проблемами 401, если схема проверки подлинности, под вопросом, относится к взаимодействию с проверкой подлинности в рамках потока запросов. (например, добавление заголовка ответа или изменение результата 401 на 302 страницы входа или внешнего расположения входа.)
HandleForbiddenAsync(AuthenticationProperties)	Переопределите этот метод для обработки Forbid. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
HandleRemoteAuthenticateAsync()	Проверка подлинности удостоверения пользователя с помощью поставщика удостоверений. Метод обрабатывает запрос на конечную точку, определенную CallbackPath.
HandleRemoteCallbackAsync()	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
HandleRequestAsync()	Обрабатывает текущий запрос проверки подлинности. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
HandleSignInAsync(SignInContext)	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
HandleUnauthorizedAsync(ChallengeContext)	Переопределите этот метод, чтобы справиться с проблемами 401, если схема проверки подлинности, под вопросом, относится к взаимодействию с проверкой подлинности в рамках потока запросов. (например, добавление заголовка ответа или изменение результата 401 на 302 страницы входа или внешнего расположения входа.) (Унаследовано от AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	Инициализируйте обработчик, устраните параметры и проверьте их. (Унаследовано от AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	Инициализация вызывается один раз на запрос для контекстуализации этого экземпляра с соответствующим состоянием. (Унаследовано от AuthenticationHandler<TOptions>)
InitializeEventsAsync()	Инициализирует объект событий, вызываемый один раз для каждого запроса по InitializeAsync(AuthenticationScheme, HttpContext). (Унаследовано от AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	Вызывается после инициализации параметров или событий обработчика для завершения инициализации. (Унаследовано от AuthenticationHandler<TOptions>)
ResolveTarget(String)	Разрешает схему, в которую пересылается эта операция проверки подлинности. (Унаследовано от AuthenticationHandler<TOptions>)
ShouldHandleRequestAsync()	Возвращает значение, определяющее, должен ли текущий запрос проверки подлинности обрабатываться HandleRequestAsync(). (Унаследовано от RemoteAuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от AuthenticationHandler<TOptions>)
SignInAsync(SignInContext)	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от AuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext)	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от AuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Проверяет, коррелирует ли текущий запрос с текущим запросом удаленной проверки подлинности. (Унаследовано от RemoteAuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	Обработчик проверки подлинности, поддерживающий OAuth. (Унаследовано от RemoteAuthenticationHandler<TOptions>)