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

195 lines
12 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.Owin
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace OpenIddict.Validation.Owin
">
<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.Owin">
<h1 id="OpenIddict_Validation_Owin" data-uid="OpenIddict.Validation.Owin" class="text-break">Namespace OpenIddict.Validation.Owin
</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.Owin.OpenIddictValidationOwinConfiguration.html">OpenIddictValidationOwinConfiguration</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.Owin.OpenIddictValidationOwinConstants.html">OpenIddictValidationOwinConstants</a></h4>
<section><p>Exposes common constants used by the OpenIddict OWIN host.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinConstants.Cache.html">OpenIddictValidationOwinConstants.Cache</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinConstants.Headers.html">OpenIddictValidationOwinConstants.Headers</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinConstants.Properties.html">OpenIddictValidationOwinConstants.Properties</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinDefaults.html">OpenIddictValidationOwinDefaults</a></h4>
<section><p>Exposes the default values used by the OpenIddict validation handler.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandler.html">OpenIddictValidationOwinHandler</a></h4>
<section><p>Provides the entry point necessary to register the OpenIddict validation in an OWIN pipeline.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlerFilters.html">OpenIddictValidationOwinHandlerFilters</a></h4>
<section><p>Contains a collection of event handler filters commonly used by the OWIN handlers.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlerFilters.RequireOwinRequest.html">OpenIddictValidationOwinHandlerFilters.RequireOwinRequest</a></h4>
<section><p>Represents a filter that excludes the associated handlers if no OWIN request can be found.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlers.html">OpenIddictValidationOwinHandlers</a></h4>
<section></section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlers.AttachCacheControlHeader-1.html">OpenIddictValidationOwinHandlers.AttachCacheControlHeader&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of attaching the appropriate HTTP response cache headers.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlers.AttachHostChallengeError.html">OpenIddictValidationOwinHandlers.AttachHostChallengeError</a></h4>
<section><p>Contains the logic responsible of attaching the error details using the OWIN authentication properties.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlers.AttachHttpResponseCode-1.html">OpenIddictValidationOwinHandlers.AttachHttpResponseCode&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of attaching an appropriate HTTP status code.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlers.AttachWwwAuthenticateHeader-1.html">OpenIddictValidationOwinHandlers.AttachWwwAuthenticateHeader&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of attaching errors details to the WWW-Authenticate header.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlers.ExtractAccessTokenFromAuthorizationHeader.html">OpenIddictValidationOwinHandlers.ExtractAccessTokenFromAuthorizationHeader</a></h4>
<section><p>Contains the logic responsible of extracting the access token from the standard HTTP Authorization header.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlers.ExtractAccessTokenFromBodyForm.html">OpenIddictValidationOwinHandlers.ExtractAccessTokenFromBodyForm</a></h4>
<section><p>Contains the logic responsible of extracting the access token from the standard access_token form parameter.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlers.ExtractAccessTokenFromQueryString.html">OpenIddictValidationOwinHandlers.ExtractAccessTokenFromQueryString</a></h4>
<section><p>Contains the logic responsible of extracting the access token from the standard access_token query parameter.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlers.InferIssuerFromHost.html">OpenIddictValidationOwinHandlers.InferIssuerFromHost</a></h4>
<section><p>Contains the logic responsible of infering the default issuer from the HTTP request host and validating it.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlers.ProcessChallengeErrorResponse-1.html">OpenIddictValidationOwinHandlers.ProcessChallengeErrorResponse&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of processing challenge responses that contain a WWW-Authenticate header.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinHandlers.ProcessJsonResponse-1.html">OpenIddictValidationOwinHandlers.ProcessJsonResponse&lt;TContext&gt;</a></h4>
<section><p>Contains the logic responsible of processing OpenID Connect responses that must be returned as JSON.
Note: this handler is not used when the OpenID Connect request is not initially handled by OWIN.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinMiddleware.html">OpenIddictValidationOwinMiddleware</a></h4>
<section><p>Provides the entry point necessary to register the OpenIddict validation handler in an OWIN pipeline.
Note: this middleware is intented to be used with dependency injection containers
that support middleware resolution, like Autofac. Since it depends on scoped services,
it is NOT recommended to instantiate it as a singleton like a regular OWIN middleware.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinMiddlewareFactory.html">OpenIddictValidationOwinMiddlewareFactory</a></h4>
<section><p>Provides the entry point necessary to instantiate and register the scoped
<a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinMiddleware.html">OpenIddictValidationOwinMiddleware</a> in an OWIN/Katana pipeline.</p>
</section>
<h4><a class="xref" href="OpenIddict.Validation.Owin.OpenIddictValidationOwinOptions.html">OpenIddictValidationOwinOptions</a></h4>
<section><p>Provides various settings needed to configure the OpenIddict OWIN validation integration.</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>