OAuthHandler<TOptions> Класс

Определение

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

Microsoft.AspNetCore.Authentication.OAuth

Сборка:

Microsoft.AspNetCore.Authentication.OAuth.dll

Пакет:

Microsoft.AspNetCore.App.Ref v8.0.0

Обработчик проверки подлинности, поддерживающий 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	Возвращает или задает объект asssociated 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()	Инициализирует объект events, вызываемый один раз для каждого запроса .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>)