nuget updates
This commit is contained in:
StellaOps Bot
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": 2,
|
||||
"contentHash": "/2TgjyEl8rEfmDiFsdeRmy12hgls+06hOS9+TCHyvbJbQl9H/62fisWaPURV0b+sLBQ7XU60dnJ8/+zavxTy0Q==",
|
||||
"source": "/mnt/e/dev/git.stella-ops.org/local-nugets"
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
|
After Width: | Height: | Size: 2.1 KiB |
@@ -0,0 +1,26 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
|
||||
<metadata>
|
||||
<id>Microsoft.AspNetCore.Authentication.JwtBearer</id>
|
||||
<version>10.0.0-rc.1.25451.107</version>
|
||||
<authors>Microsoft</authors>
|
||||
<requireLicenseAcceptance>true</requireLicenseAcceptance>
|
||||
<license type="expression">MIT</license>
|
||||
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>
|
||||
<icon>Icon.png</icon>
|
||||
<readme>PACKAGE.md</readme>
|
||||
<projectUrl>https://asp.net/</projectUrl>
|
||||
<description>ASP.NET Core middleware that enables an application to receive an OpenID Connect bearer token.
|
||||
|
||||
This package was built from the source code at https://github.com/dotnet/dotnet/tree/2db1f5ee2bdda2e8d873769325fabede32e420e0</description>
|
||||
<copyright>© Microsoft Corporation. All rights reserved.</copyright>
|
||||
<tags>aspnetcore authentication security</tags>
|
||||
<serviceable>true</serviceable>
|
||||
<repository type="git" url="https://github.com/dotnet/dotnet" commit="2db1f5ee2bdda2e8d873769325fabede32e420e0" />
|
||||
<dependencies>
|
||||
<group targetFramework="net10.0">
|
||||
<dependency id="Microsoft.IdentityModel.Protocols.OpenIdConnect" version="8.0.1" exclude="Build,Analyzers" />
|
||||
</group>
|
||||
</dependencies>
|
||||
<frameworkReferences><group targetFramework="net10.0"><frameworkReference name="Microsoft.AspNetCore.App" /></group></frameworkReferences></metadata>
|
||||
</package>
|
||||
@@ -0,0 +1,69 @@
|
||||
## About
|
||||
|
||||
Microsoft.AspNetCore.Authentication.JwtBearer is a middleware component designed for ASP.NET Core applications. It facilitates JSON Web Token (JWT) authentication, enabling secure authentication for APIs and web services. This package allows you to validate JWT tokens issued by an authentication server, ensuring secure access to your application's resources.
|
||||
|
||||
## Key Features
|
||||
|
||||
<!-- The key features of this package -->
|
||||
|
||||
* Seamless integration with ASP.NET Core applications.
|
||||
* Supports JSON Web Token (JWT) authentication.
|
||||
* Enables secure authentication for APIs and web services.
|
||||
* Flexible configuration options for token validation parameters.
|
||||
* Works with .NET Core 3.0 and newer, as well as .NET Standard 2.1.
|
||||
|
||||
## How to Use
|
||||
|
||||
<!-- A compelling example on how to use this package with code, as well as any specific guidelines for when to use the package -->
|
||||
|
||||
```C#
|
||||
using Microsoft.AspNetCore.Authentication.JwtBearer;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using Microsoft.IdentityModel.Tokens;
|
||||
using System.Text;
|
||||
|
||||
public void ConfigureServices(IServiceCollection services)
|
||||
{
|
||||
services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
|
||||
.AddJwtBearer(options =>
|
||||
{
|
||||
options.TokenValidationParameters = new TokenValidationParameters
|
||||
{
|
||||
ValidateIssuer = true,
|
||||
ValidateAudience = true,
|
||||
ValidateLifetime = true,
|
||||
ValidateIssuerSigningKey = true,
|
||||
ValidIssuer = "your_issuer",
|
||||
ValidAudience = "your_audience",
|
||||
IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("your_secret_key"))
|
||||
};
|
||||
});
|
||||
|
||||
// Other configurations...
|
||||
}
|
||||
```
|
||||
For more detailed configuration options and advanced scenarios, please refer to the blog [JWT Validation and Authorization in ASP.NET Core](https://devblogs.microsoft.com/dotnet/jwt-validation-and-authorization-in-asp-net-core/).
|
||||
|
||||
## Main Types
|
||||
|
||||
<!-- The main types provided in this library -->
|
||||
|
||||
The main types provided by this library are:
|
||||
|
||||
* `JwtBearerDefaults`: Contains default values for JWT Bearer authentication.
|
||||
* `JwtBearerEvents`: Events used to handle JWT Bearer authentication events.
|
||||
* `JwtBearerHandler`: Handles JWT Bearer authentication requests.
|
||||
* `wtBearerOptions`: Options for configuring JWT Bearer authentication.
|
||||
|
||||
## Additional Documentation
|
||||
|
||||
<!-- Links to further documentation. Remove conceptual documentation if not available for the library. -->
|
||||
|
||||
* [Overview of ASP.NET Core authentication](https://learn.microsoft.com/aspnet/core/security/authentication/?view=aspnetcore-8.0)
|
||||
* [JwtBearer sample](https://github.com/dotnet/aspnetcore/tree/main/src/Security/Authentication/JwtBearer/samples)
|
||||
|
||||
## Feedback & Contributing
|
||||
|
||||
<!-- How to provide feedback on this package and contribute to it -->
|
||||
|
||||
Microsoft.AspNetCore.Authentication.JwtBearer is released as open-source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/aspnetcore).
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,461 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Microsoft.AspNetCore.Authentication.JwtBearer</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.AuthenticationFailedContext">
|
||||
<summary>
|
||||
A <see cref="T:Microsoft.AspNetCore.Authentication.ResultContext`1"/> when authentication has failed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.AuthenticationFailedContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.AuthenticationFailedContext"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.AuthenticationFailedContext.Exception">
|
||||
<summary>
|
||||
Gets or sets the exception associated with the authentication failure.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.ForbiddenContext">
|
||||
<summary>
|
||||
A <see cref="T:Microsoft.AspNetCore.Authentication.ResultContext`1"/> when access to a resource is forbidden.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.ForbiddenContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.ForbiddenContext"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext">
|
||||
<summary>
|
||||
A <see cref="T:Microsoft.AspNetCore.Authentication.PropertiesContext`1"/> when access to a resource authenticated using JWT bearer is challenged.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions,Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.AuthenticateFailure">
|
||||
<summary>
|
||||
Any failures encountered during the authentication process.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.Error">
|
||||
<summary>
|
||||
Gets or sets the "error" value returned to the caller as part
|
||||
of the WWW-Authenticate header. This property may be null when
|
||||
<see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.IncludeErrorDetails"/> is set to <c>false</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.ErrorDescription">
|
||||
<summary>
|
||||
Gets or sets the "error_description" value returned to the caller as part
|
||||
of the WWW-Authenticate header. This property may be null when
|
||||
<see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.IncludeErrorDetails"/> is set to <c>false</c>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.ErrorUri">
|
||||
<summary>
|
||||
Gets or sets the "error_uri" value returned to the caller as part of the
|
||||
WWW-Authenticate header. This property is always null unless explicitly set.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.Handled">
|
||||
<summary>
|
||||
If true, will skip any default logic for this challenge.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext.HandleResponse">
|
||||
<summary>
|
||||
Skips any default logic for this challenge.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerDefaults">
|
||||
<summary>
|
||||
Default values used by <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler"/> for JWT bearer authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerDefaults.AuthenticationScheme">
|
||||
<summary>
|
||||
Default value for AuthenticationScheme property in the <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents">
|
||||
<summary>
|
||||
Specifies events which the <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler"/> invokes to enable developer control over the authentication process.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnAuthenticationFailed">
|
||||
<summary>
|
||||
Invoked if authentication fails during request processing. The exceptions will be re-thrown after this event unless suppressed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnForbidden">
|
||||
<summary>
|
||||
Invoked if Authorization fails and results in a Forbidden response.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnMessageReceived">
|
||||
<summary>
|
||||
Invoked when a protocol message is first received.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnTokenValidated">
|
||||
<summary>
|
||||
Invoked after the security token has passed validation and a ClaimsIdentity has been generated.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnChallenge">
|
||||
<summary>
|
||||
Invoked before a challenge is sent back to the caller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.AuthenticationFailed(Microsoft.AspNetCore.Authentication.JwtBearer.AuthenticationFailedContext)">
|
||||
<summary>
|
||||
Invoked if exceptions are thrown during request processing. The exceptions will be re-thrown after this event unless suppressed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.Forbidden(Microsoft.AspNetCore.Authentication.JwtBearer.ForbiddenContext)">
|
||||
<summary>
|
||||
Invoked if Authorization fails and results in a Forbidden response
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.MessageReceived(Microsoft.AspNetCore.Authentication.JwtBearer.MessageReceivedContext)">
|
||||
<summary>
|
||||
Invoked when a protocol message is first received.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.TokenValidated(Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext)">
|
||||
<summary>
|
||||
Invoked after the security token has passed validation and a ClaimsIdentity has been generated.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.Challenge(Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerChallengeContext)">
|
||||
<summary>
|
||||
Invoked before a challenge is sent back to the caller.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler">
|
||||
<summary>
|
||||
An <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationHandler`1"/> that can perform JWT-bearer based authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions},Microsoft.Extensions.Logging.ILoggerFactory,System.Text.Encodings.Web.UrlEncoder,Microsoft.AspNetCore.Authentication.ISystemClock)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.#ctor(Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions},Microsoft.Extensions.Logging.ILoggerFactory,System.Text.Encodings.Web.UrlEncoder)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.Events">
|
||||
<summary>
|
||||
The handler calls methods on the events which give the application control at certain points where processing is occurring.
|
||||
If it is not provided a default instance is supplied which does nothing when the methods are called.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.CreateEventsAsync">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.HandleAuthenticateAsync">
|
||||
<summary>
|
||||
Searches the 'Authorization' header for a 'Bearer' token. If the 'Bearer' token is found, it is validated using <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> set in the options.
|
||||
</summary>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.HandleChallengeAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler.HandleForbiddenAsync(Microsoft.AspNetCore.Authentication.AuthenticationProperties)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions">
|
||||
<summary>
|
||||
Options class provides information needed to control Bearer Authentication handler behavior
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.RequireHttpsMetadata">
|
||||
<summary>
|
||||
Gets or sets if HTTPS is required for the metadata address or authority.
|
||||
The default is true. This should be disabled only in development environments.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.MetadataAddress">
|
||||
<summary>
|
||||
Gets or sets the discovery endpoint for obtaining metadata
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Authority">
|
||||
<summary>
|
||||
Gets or sets the Authority to use when making OpenIdConnect calls.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Audience">
|
||||
<summary>
|
||||
Gets or sets a single valid audience value for any received OpenIdConnect token.
|
||||
This value is passed into TokenValidationParameters.ValidAudience if that property is empty.
|
||||
</summary>
|
||||
<value>
|
||||
The expected audience for any received OpenIdConnect token.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Challenge">
|
||||
<summary>
|
||||
Gets or sets the challenge to put in the "WWW-Authenticate" header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Events">
|
||||
<summary>
|
||||
The object provided by the application to process events raised by the bearer authentication handler.
|
||||
The application may implement the interface fully, or it may create an instance of JwtBearerEvents
|
||||
and assign delegates only to the events it wants to process.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.BackchannelHttpHandler">
|
||||
<summary>
|
||||
The HttpMessageHandler used to retrieve metadata.
|
||||
This cannot be set at the same time as BackchannelCertificateValidator unless the value
|
||||
is a WebRequestHandler.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Backchannel">
|
||||
<summary>
|
||||
The Backchannel used to retrieve metadata.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.BackchannelTimeout">
|
||||
<summary>
|
||||
Gets or sets the timeout when using the backchannel to make an http call.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.Configuration">
|
||||
<summary>
|
||||
Configuration provided directly by the developer. If provided, then MetadataAddress and the Backchannel properties
|
||||
will not be used. This information should not be updated during request processing.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.ConfigurationManager">
|
||||
<summary>
|
||||
Responsible for retrieving, caching, and refreshing the configuration from metadata.
|
||||
If not provided, then one will be created using the MetadataAddress and Backchannel properties.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.RefreshOnIssuerKeyNotFound">
|
||||
<summary>
|
||||
Gets or sets if a metadata refresh should be attempted after a SecurityTokenSignatureKeyNotFoundException. This allows for automatic
|
||||
recovery in the event of a signature key rollover. This is enabled by default.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.SecurityTokenValidators">
|
||||
<summary>
|
||||
Gets the ordered list of <see cref="T:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator"/> used to validate access tokens.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.TokenHandlers">
|
||||
<summary>
|
||||
Gets the ordered list of <see cref="T:Microsoft.IdentityModel.Tokens.TokenHandler"/> used to validate access tokens.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.TokenValidationParameters">
|
||||
<summary>
|
||||
Gets or sets the parameters used to validate identity tokens.
|
||||
</summary>
|
||||
<remarks>Contains the types and definitions required for validating a token.</remarks>
|
||||
<exception cref="T:System.ArgumentNullException">if 'value' is null.</exception>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.SaveToken">
|
||||
<summary>
|
||||
Defines whether the bearer token should be stored in the
|
||||
<see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties"/> after a successful authorization.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.IncludeErrorDetails">
|
||||
<summary>
|
||||
Defines whether the token validation errors should be returned to the caller.
|
||||
Enabled by default, this option can be disabled to prevent the JWT handler
|
||||
from returning an error and an error_description in the WWW-Authenticate header.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.MapInboundClaims">
|
||||
<summary>
|
||||
Gets or sets the <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.MapInboundClaims"/> property on the default instance of <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler"/> in SecurityTokenValidators, or <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler"/> in TokenHandlers, which is used when determining
|
||||
whether or not to map claim types that are extracted when validating a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/> or a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
|
||||
<para>If this is set to true, the Claim Type is set to the JSON claim 'name' after translating using this mapping. Otherwise, no mapping occurs.</para>
|
||||
<para>The default value is true.</para>
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.AutomaticRefreshInterval">
|
||||
<summary>
|
||||
Gets or sets how often an automatic metadata refresh should occur.
|
||||
</summary>
|
||||
<value>
|
||||
Defaults to <see cref="F:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.DefaultAutomaticRefreshInterval" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.RefreshInterval">
|
||||
<summary>
|
||||
Gets or sets the minimum time between retrievals, in the event that a retrieval failed, or that a refresh was explicitly requested.
|
||||
</summary>
|
||||
<value>
|
||||
Defaults to <see cref="F:Microsoft.IdentityModel.Protocols.ConfigurationManager`1.DefaultRefreshInterval" />.
|
||||
</value>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.UseSecurityTokenValidators">
|
||||
<summary>
|
||||
Gets or sets whether <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.TokenHandlers"/> or <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions.SecurityTokenValidators"/> will be used to validate the inbound token.
|
||||
</summary>
|
||||
<remarks>
|
||||
The advantages of using TokenHandlers are:
|
||||
<para>There is an Async model.</para>
|
||||
<para>The default token handler is a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler"/> which is faster than a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityTokenHandler"/>.</para>
|
||||
<para>There is an ability to make use of a Last-Known-Good model for metadata that protects applications when metadata is published with errors.</para>
|
||||
SecurityTokenValidators can be used when <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext.SecurityToken"/> needs a <see cref="T:System.IdentityModel.Tokens.Jwt.JwtSecurityToken"/>.
|
||||
When using TokenHandlers, <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext.SecurityToken"/> will be a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerPostConfigureOptions">
|
||||
<summary>
|
||||
Used to setup defaults for all <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerPostConfigureOptions.PostConfigure(System.String,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<summary>
|
||||
Invoked to post configure a JwtBearerOptions instance.
|
||||
</summary>
|
||||
<param name="name">The name of the options instance being configured.</param>
|
||||
<param name="options">The options instance to configure.</param>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.MessageReceivedContext">
|
||||
<summary>
|
||||
A context for <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnMessageReceived"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.MessageReceivedContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.MessageReceivedContext"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.MessageReceivedContext.Token">
|
||||
<summary>
|
||||
Bearer Token. This will give the application an opportunity to retrieve a token from an alternative location.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext">
|
||||
<summary>
|
||||
A context for <see cref="P:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerEvents.OnTokenValidated"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext.#ctor(Microsoft.AspNetCore.Http.HttpContext,Microsoft.AspNetCore.Authentication.AuthenticationScheme,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<summary>
|
||||
Initializes a new instance of <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext"/>.
|
||||
</summary>
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.TokenValidatedContext.SecurityToken">
|
||||
<summary>
|
||||
Gets or sets the validated security token.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.Resources.Exception_OptionMustBeProvided">
|
||||
<summary>The '{0}' option must be provided.</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearer.Resources.FormatException_OptionMustBeProvided(System.Object)">
|
||||
<summary>The '{0}' option must be provided.</summary>
|
||||
</member>
|
||||
<member name="P:Microsoft.AspNetCore.Authentication.JwtBearer.Resources.Exception_ValidatorHandlerMismatch">
|
||||
<summary>An ICertificateValidator cannot be specified at the same time as an HttpMessageHandler unless it is a WebRequestHandler.</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearerConfigureOptions.#ctor(Microsoft.AspNetCore.Authentication.IAuthenticationConfigurationProvider)">
|
||||
<summary>
|
||||
Initializes a new <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearerConfigureOptions"/> given the configuration
|
||||
provided by the <paramref name="configurationProvider"/>.
|
||||
</summary>
|
||||
<param name="configurationProvider">An <see cref="T:Microsoft.AspNetCore.Authentication.IAuthenticationConfigurationProvider"/> instance.</param>\
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearerConfigureOptions.Configure(System.String,Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="M:Microsoft.AspNetCore.Authentication.JwtBearerConfigureOptions.Configure(Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions)">
|
||||
<inheritdoc />
|
||||
</member>
|
||||
<member name="T:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions">
|
||||
<summary>
|
||||
Extension methods to configure JWT bearer authentication.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions.AddJwtBearer(Microsoft.AspNetCore.Authentication.AuthenticationBuilder)">
|
||||
<summary>
|
||||
Enables JWT-bearer authentication using the default scheme <see cref="F:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerDefaults.AuthenticationScheme"/>.
|
||||
<para>
|
||||
JWT bearer authentication performs authentication by extracting and validating a JWT token from the <c>Authorization</c> request header.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder"/>.</param>
|
||||
<returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions.AddJwtBearer(Microsoft.AspNetCore.Authentication.AuthenticationBuilder,System.String)">
|
||||
<summary>
|
||||
Enables JWT-bearer authentication using a pre-defined scheme.
|
||||
<para>
|
||||
JWT bearer authentication performs authentication by extracting and validating a JWT token from the <c>Authorization</c> request header.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder"/>.</param>
|
||||
<param name="authenticationScheme">The authentication scheme.</param>
|
||||
<returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions.AddJwtBearer(Microsoft.AspNetCore.Authentication.AuthenticationBuilder,System.Action{Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions})">
|
||||
<summary>
|
||||
Enables JWT-bearer authentication using the default scheme <see cref="F:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerDefaults.AuthenticationScheme"/>.
|
||||
<para>
|
||||
JWT bearer authentication performs authentication by extracting and validating a JWT token from the <c>Authorization</c> request header.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder"/>.</param>
|
||||
<param name="configureOptions">A delegate that allows configuring <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.</param>
|
||||
<returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions.AddJwtBearer(Microsoft.AspNetCore.Authentication.AuthenticationBuilder,System.String,System.Action{Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions})">
|
||||
<summary>
|
||||
Enables JWT-bearer authentication using the specified scheme.
|
||||
<para>
|
||||
JWT bearer authentication performs authentication by extracting and validating a JWT token from the <c>Authorization</c> request header.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder"/>.</param>
|
||||
<param name="authenticationScheme">The authentication scheme.</param>
|
||||
<param name="configureOptions">A delegate that allows configuring <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.</param>
|
||||
<returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
|
||||
</member>
|
||||
<member name="M:Microsoft.Extensions.DependencyInjection.JwtBearerExtensions.AddJwtBearer(Microsoft.AspNetCore.Authentication.AuthenticationBuilder,System.String,System.String,System.Action{Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions})">
|
||||
<summary>
|
||||
Enables JWT-bearer authentication using the specified scheme.
|
||||
<para>
|
||||
JWT bearer authentication performs authentication by extracting and validating a JWT token from the <c>Authorization</c> request header.
|
||||
</para>
|
||||
</summary>
|
||||
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder"/>.</param>
|
||||
<param name="authenticationScheme">The authentication scheme.</param>
|
||||
<param name="displayName">The display name for the authentication handler.</param>
|
||||
<param name="configureOptions">A delegate that allows configuring <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions"/>.</param>
|
||||
<returns>A reference to <paramref name="builder"/> after the operation has completed.</returns>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Binary file not shown.
@@ -0,0 +1 @@
|
||||
IEwqDuYVSb6Xcpe0a7iqqDgyqlgUDR1JrIIDcDPJpQw1HJNBE5aZUo4BEpRIsu7+oCF6oXvi6hAdGOGQFF+Rng==
|
||||
Reference in New Issue
Block a user