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


JwtBearerOptions Класс

Определение

Класс Options предоставляет сведения, необходимые для управления поведением обработчика проверки подлинности носителя

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

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

JwtBearerOptions()

Инициализирует новый экземпляр JwtBearerOptions.

Свойства

Audience

Возвращает или задает одно допустимое значение аудитории для любого полученного токена OpenIdConnect. Это значение передается в TokenValidationParameters.ValidAudience, если это свойство пусто.

Authority

Получает или задает полномочия для использования при выполнении вызовов OpenIdConnect.

AutomaticRefreshInterval

Возвращает или задает частоту автоматического обновления метаданных.

Backchannel

Backchannel, используемый для получения метаданных.

BackchannelHttpHandler

HttpMessageHandler, используемый для получения метаданных. Его нельзя задать одновременно с BackchannelCertificateValidator, если только значение не равно WebRequestHandler.

BackchannelTimeout

Получает или задает время ожидания при использовании обратного канала для совершения вызова http.

Challenge

Возвращает или задает запрос, помещаемый в заголовок WWW-Authenticate.

ClaimsIssuer

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

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

Конфигурация, предоставленная напрямую от разработчика. Если она предоставлена, то свойства MetadataAddress и Backchannel не используются. Эти сведения не должны обновляться во время обработки запроса.

ConfigurationManager

Отвечает за получение, кэширование и обновление конфигурации из метаданных. Если не предоставлено, то будет создано с помощью свойств MetadataAddress и Backchannel.

Events

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

EventsType

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

(Унаследовано от AuthenticationSchemeOptions)
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)
IncludeErrorDetails

Определяет, следует ли возвращать вызывающим объекту ошибки проверки маркера. Этот параметр включен по умолчанию, чтобы обработчик JWT не возвращал ошибку и error_description в заголовке WWW-Authenticate.

MapInboundClaims

Возвращает или задает MapInboundClaims свойство для экземпляра JwtSecurityTokenHandler по умолчанию в SecurityTokenValidators или JsonWebTokenHandler в TokenHandlers, которое используется при определении того, следует ли сопоставлять типы утверждений, извлекаемые при проверке JwtSecurityTokenJsonWebTokenили .

Если для параметра задано значение true, после перевода с помощью этого сопоставления для параметра Тип утверждения устанавливается утверждение JSON "name". В противном случае сопоставление не выполняется.

Значение по умолчанию — true.

MetadataAddress

Получает или задает конечную точку обнаружения для получения метаданных

RefreshInterval

Возвращает или задает минимальное время между извлечением в случае сбоя извлечения или явного запроса на обновление.

RefreshOnIssuerKeyNotFound

Получает или задает значение, указывающее, должна ли выполняться попытка обновить метаданные после SecurityTokenSignatureKeyNotFoundException. Это позволяет выполнять автоматическое восстановление при смене ключей подписи. Эта функция включена по умолчанию.

RequireHttpsMetadata

Возвращает или задает значение , если для адреса или центра метаданных требуется протокол HTTPS. Значение по умолчанию — true. Этот параметр следует отключить только в средах разработки.

SaveToken

Определяет, должен ли маркер носителя храниться в AuthenticationProperties после успешной авторизации.

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

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

TimeProvider

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

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

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

TokenValidationParameters

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

UseSecurityTokenValidators

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

Методы

Validate()

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

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

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

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

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