openiddict-documentation/api/OpenIddict.Validation.html
2021-01-17 18:24:47 +00:00

344 lines
25 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Namespace OpenIddict.Validation
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace OpenIddict.Validation
">
<meta name="generator" content="docfx 2.56.6.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head> <body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo.png" alt="">
</a> </div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="OpenIddict.Validation">
<h1 id="OpenIddict_Validation" data-uid="OpenIddict.Validation" class="text-break">Namespace OpenIddict.Validation
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationConfiguration.html">OpenIddictValidationConfiguration</a></h4>
<section><p>Contains the methods required to ensure that the OpenIddict validation configuration is valid.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationConstants.html">OpenIddictValidationConstants</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationConstants.Properties.html">OpenIddictValidationConstants.Properties</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationDispatcher.html">OpenIddictValidationDispatcher</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.html">OpenIddictValidationEvents</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.ApplyConfigurationRequestContext.html">OpenIddictValidationEvents.ApplyConfigurationRequestContext</a></h4>
<section><p>Represents an event called for each request to the configuration endpoint
to send the configuration request to the remote authorization server.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.ApplyCryptographyRequestContext.html">OpenIddictValidationEvents.ApplyCryptographyRequestContext</a></h4>
<section><p>Represents an event called for each request to the cryptography endpoint
to send the cryptography request to the remote authorization server.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.ApplyIntrospectionRequestContext.html">OpenIddictValidationEvents.ApplyIntrospectionRequestContext</a></h4>
<section><p>Represents an event called for each request to the introspection endpoint
to send the introspection request to the remote authorization server.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseContext.html">OpenIddictValidationEvents.BaseContext</a></h4>
<section><p>Represents an abstract base class used for certain event contexts.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseExternalContext.html">OpenIddictValidationEvents.BaseExternalContext</a></h4>
<section><p>Represents an abstract base class used for certain event contexts.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseRequestContext.html">OpenIddictValidationEvents.BaseRequestContext</a></h4>
<section><p>Represents an abstract base class used for certain event contexts.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.BaseValidatingContext.html">OpenIddictValidationEvents.BaseValidatingContext</a></h4>
<section><p>Represents an abstract base class used for certain event contexts.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.ExtractConfigurationResponseContext.html">OpenIddictValidationEvents.ExtractConfigurationResponseContext</a></h4>
<section><p>Represents an event called for each configuration response
to extract the response parameters from the server response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.ExtractCryptographyResponseContext.html">OpenIddictValidationEvents.ExtractCryptographyResponseContext</a></h4>
<section><p>Represents an event called for each cryptography response
to extract the response parameters from the server response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.ExtractIntrospectionResponseContext.html">OpenIddictValidationEvents.ExtractIntrospectionResponseContext</a></h4>
<section><p>Represents an event called for each introspection response
to extract the response parameters from the server response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.HandleConfigurationResponseContext.html">OpenIddictValidationEvents.HandleConfigurationResponseContext</a></h4>
<section><p>Represents an event called for each validated configuration response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.HandleCryptographyResponseContext.html">OpenIddictValidationEvents.HandleCryptographyResponseContext</a></h4>
<section><p>Represents an event called for each validated cryptography response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.HandleIntrospectionResponseContext.html">OpenIddictValidationEvents.HandleIntrospectionResponseContext</a></h4>
<section><p>Represents an event called for each validated introspection response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.PrepareConfigurationRequestContext.html">OpenIddictValidationEvents.PrepareConfigurationRequestContext</a></h4>
<section><p>Represents an event called for each request to the configuration endpoint
to give the user code a chance to add parameters to the configuration request.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.PrepareCryptographyRequestContext.html">OpenIddictValidationEvents.PrepareCryptographyRequestContext</a></h4>
<section><p>Represents an event called for each request to the cryptography endpoint
to give the user code a chance to add parameters to the cryptography request.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.PrepareIntrospectionRequestContext.html">OpenIddictValidationEvents.PrepareIntrospectionRequestContext</a></h4>
<section><p>Represents an event called for each request to the introspection endpoint
to give the user code a chance to add parameters to the introspection request.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.ProcessAuthenticationContext.html">OpenIddictValidationEvents.ProcessAuthenticationContext</a></h4>
<section><p>Represents an event called when processing an authentication operation.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.ProcessChallengeContext.html">OpenIddictValidationEvents.ProcessChallengeContext</a></h4>
<section><p>Represents an event called when processing a challenge response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.ProcessErrorContext.html">OpenIddictValidationEvents.ProcessErrorContext</a></h4>
<section><p>Represents an event called when processing an errored response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEvents.ProcessRequestContext.html">OpenIddictValidationEvents.ProcessRequestContext</a></h4>
<section><p>Represents an event called when processing an incoming request.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationFactory.html">OpenIddictValidationFactory</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandler-1.html">OpenIddictValidationHandler&lt;TContext&gt;</a></h4>
<section><p>Represents a handler able to process <code data-dev-comment-type="typeparamref" class="typeparamref">TContext</code> events.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlerDescriptor.html">OpenIddictValidationHandlerDescriptor</a></h4>
<section><p>Represents an immutable descriptor of an OpenIddict validation event handler.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlerDescriptor.Builder-1.html">OpenIddictValidationHandlerDescriptor.Builder&lt;TContext&gt;</a></h4>
<section><p>Contains methods allowing to build a descriptor instance.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlerFilters.html">OpenIddictValidationHandlerFilters</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlerFilters.RequireAuthorizationEntryValidationEnabled.html">OpenIddictValidationHandlerFilters.RequireAuthorizationEntryValidationEnabled</a></h4>
<section><p>Represents a filter that excludes the associated handlers if authorization validation was not enabled.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlerFilters.RequireIntrospectionValidation.html">OpenIddictValidationHandlerFilters.RequireIntrospectionValidation</a></h4>
<section><p>Represents a filter that excludes the associated handlers if introspection is not used.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlerFilters.RequireLocalValidation.html">OpenIddictValidationHandlerFilters.RequireLocalValidation</a></h4>
<section><p>Represents a filter that excludes the associated handlers if local validation is not used.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlerFilters.RequireTokenEntryValidationEnabled.html">OpenIddictValidationHandlerFilters.RequireTokenEntryValidationEnabled</a></h4>
<section><p>Represents a filter that excludes the associated handlers if token validation was not enabled.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.html">OpenIddictValidationHandlers</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.AttachDefaultChallengeError.html">OpenIddictValidationHandlers.AttachDefaultChallengeError</a></h4>
<section><p>Contains the logic responsible of ensuring that the challenge response contains an appropriate error.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Discovery.html">OpenIddictValidationHandlers.Discovery</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Discovery.ExtractCryptographyEndpoint.html">OpenIddictValidationHandlers.Discovery.ExtractCryptographyEndpoint</a></h4>
<section><p>Contains the logic responsible of extracting the JWKS endpoint address from the discovery document.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Discovery.ExtractIntrospectionEndpoint.html">OpenIddictValidationHandlers.Discovery.ExtractIntrospectionEndpoint</a></h4>
<section><p>Contains the logic responsible of extracting the introspection endpoint address from the discovery document.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Discovery.ExtractSigningKeys.html">OpenIddictValidationHandlers.Discovery.ExtractSigningKeys</a></h4>
<section><p>Contains the logic responsible of extracting the signing keys from the JWKS document.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Discovery.ValidateIssuer.html">OpenIddictValidationHandlers.Discovery.ValidateIssuer</a></h4>
<section><p>Contains the logic responsible of extracting the issuer from the discovery document.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.HandleErrorResponse-1.html">OpenIddictValidationHandlers.HandleErrorResponse&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of extracting potential errors from the response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Introspection.html">OpenIddictValidationHandlers.Introspection</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Introspection.AttachCredentials.html">OpenIddictValidationHandlers.Introspection.AttachCredentials</a></h4>
<section><p>Contains the logic responsible of attaching the client credentials to the introspection request.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Introspection.AttachToken.html">OpenIddictValidationHandlers.Introspection.AttachToken</a></h4>
<section><p>Contains the logic responsible of attaching the token to the introspection request.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Introspection.HandleInactiveResponse.html">OpenIddictValidationHandlers.Introspection.HandleInactiveResponse</a></h4>
<section><p>Contains the logic responsible of extracting the active: false marker from the response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Introspection.PopulateClaims.html">OpenIddictValidationHandlers.Introspection.PopulateClaims</a></h4>
<section><p>Contains the logic responsible of extracting the claims from the introspection response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Introspection.ValidateIssuer.html">OpenIddictValidationHandlers.Introspection.ValidateIssuer</a></h4>
<section><p>Contains the logic responsible of extracting the issuer from the introspection response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Introspection.ValidateTokenType.html">OpenIddictValidationHandlers.Introspection.ValidateTokenType</a></h4>
<section><p>Contains the logic responsible of extracting and validating the token type from the introspection response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.Introspection.ValidateWellKnownClaims.html">OpenIddictValidationHandlers.Introspection.ValidateWellKnownClaims</a></h4>
<section><p>Contains the logic responsible of validating the well-known claims contained in the introspection response.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.IntrospectToken.html">OpenIddictValidationHandlers.IntrospectToken</a></h4>
<section><p>Contains the logic responsible of validating the tokens using OAuth 2.0 introspection.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.MapInternalClaims.html">OpenIddictValidationHandlers.MapInternalClaims</a></h4>
<section><p>Contains the logic responsible of mapping internal claims used by OpenIddict.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.NormalizeScopeClaims.html">OpenIddictValidationHandlers.NormalizeScopeClaims</a></h4>
<section><p>Contains the logic responsible of normalizing the scope claims stored in the tokens.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.RestoreReferenceTokenProperties.html">OpenIddictValidationHandlers.RestoreReferenceTokenProperties</a></h4>
<section><p>Contains the logic responsible of restoring the properties associated with a reference token entry.
Note: this handler is not used when the degraded mode is enabled.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.ValidateAudience.html">OpenIddictValidationHandlers.ValidateAudience</a></h4>
<section><p>Contains the logic responsible of rejecting authentication demands containing
access tokens that were issued to be used by another audience/resource server.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.ValidateAuthorizationEntry.html">OpenIddictValidationHandlers.ValidateAuthorizationEntry</a></h4>
<section><p>Contains the logic responsible of authentication demands a token whose
associated authorization entry is no longer valid (e.g was revoked).
Note: this handler is not used when the degraded mode is enabled.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.ValidateExpirationDate.html">OpenIddictValidationHandlers.ValidateExpirationDate</a></h4>
<section><p>Contains the logic responsible of rejecting authentication demands containing expired access tokens.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.ValidateIdentityModelToken.html">OpenIddictValidationHandlers.ValidateIdentityModelToken</a></h4>
<section><p>Contains the logic responsible of validating tokens generated using IdentityModel.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.ValidatePrincipal.html">OpenIddictValidationHandlers.ValidatePrincipal</a></h4>
<section><p>Contains the logic responsible of rejecting authentication demands for which no valid principal was resolved.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.ValidateReferenceTokenIdentifier.html">OpenIddictValidationHandlers.ValidateReferenceTokenIdentifier</a></h4>
<section><p>Contains the logic responsible of validating reference token identifiers.
Note: this handler is not used when the degraded mode is enabled.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.ValidateToken.html">OpenIddictValidationHandlers.ValidateToken</a></h4>
<section><p>Contains the logic responsible of ensuring a token was correctly resolved from the context.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlers.ValidateTokenEntry.html">OpenIddictValidationHandlers.ValidateTokenEntry</a></h4>
<section><p>Contains the logic responsible of authentication demands a token whose
associated token entry is no longer valid (e.g was revoked).
Note: this handler is not used when the degraded mode is enabled.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHelpers.html">OpenIddictValidationHelpers</a></h4>
<section><p>Exposes extensions simplifying the integration with the OpenIddict validation services.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationOptions.html">OpenIddictValidationOptions</a></h4>
<section><p>Provides various settings needed to configure the OpenIddict validation handler.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationRetriever.html">OpenIddictValidationRetriever</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationService.html">OpenIddictValidationService</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationTransaction.html">OpenIddictValidationTransaction</a></h4>
<section><p>Represents the context associated with an OpenID Connect validation request.</p>
</section>
<h3 id="interfaces">Interfaces
</h3>
<h4><a class="xref" href="OpenIddict.Validation.IOpenIddictValidationDispatcher.html">IOpenIddictValidationDispatcher</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.IOpenIddictValidationFactory.html">IOpenIddictValidationFactory</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.IOpenIddictValidationHandler-1.html">IOpenIddictValidationHandler&lt;TContext&gt;</a></h4>
<section><p>Represents a handler able to process <code data-dev-comment-type="typeparamref" class="typeparamref">TContext</code> events.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.IOpenIddictValidationHandlerFilter-1.html">IOpenIddictValidationHandlerFilter&lt;TContext&gt;</a></h4>
<section></section>
<h3 id="enums">Enums
</h3>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationEndpointType.html">OpenIddictValidationEndpointType</a></h4>
<section><p>Represents the type of an OpenIddict validation endpoint.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationHandlerType.html">OpenIddictValidationHandlerType</a></h4>
<section><p>Represents the type of an OpenIddict validation handler.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.OpenIddictValidationType.html">OpenIddictValidationType</a></h4>
<section><p>Represents the type of validation performed by the OpenIddict validation services.</p>
</section>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>