mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-24 18:04:57 +08:00
325 lines
14 KiB
HTML
325 lines
14 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>Class OpenIddictValidationAspNetCoreHandler
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class OpenIddictValidationAspNetCoreHandler
|
|
">
|
|
<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.AspNetCore.OpenIddictValidationAspNetCoreHandler">
|
|
|
|
|
|
<h1 id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler" data-uid="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler" class="text-break">Class OpenIddictValidationAspNetCoreHandler
|
|
</h1>
|
|
<div class="markdown level0 summary"><p>Provides the logic necessary to extract, validate and handle OpenID Connect requests.</p>
|
|
</div>
|
|
<div class="markdown level0 conceptual"></div>
|
|
<div class="inheritance">
|
|
<h5>Inheritance</h5>
|
|
<div class="level0"><span class="xref">System.Object</span></div>
|
|
<div class="level1"><span class="xref">OpenIddictValidationAspNetCoreHandler</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><span class="xref">IAuthenticationRequestHandler</span></div>
|
|
</div>
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="OpenIddict.Validation.AspNetCore.html">OpenIddict.Validation.AspNetCore</a></h6>
|
|
<h6><strong>Assembly</strong>: cs.temp.dll.dll</h6>
|
|
<h5 id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class OpenIddictValidationAspNetCoreHandler : AuthenticationHandler<OpenIddictValidationAspNetCoreOptions>, IAuthenticationRequestHandler</code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
|
|
|
|
<a id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler__ctor_" data-uid="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler.#ctor*"></a>
|
|
<h4 id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler__ctor_OpenIddict_Validation_IOpenIddictValidationDispatcher_OpenIddict_Validation_IOpenIddictValidationFactory_IOptionsMonitor_OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreOptions__ILoggerFactory_UrlEncoder_ISystemClock_" data-uid="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler.#ctor(OpenIddict.Validation.IOpenIddictValidationDispatcher,OpenIddict.Validation.IOpenIddictValidationFactory,IOptionsMonitor{OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreOptions},ILoggerFactory,UrlEncoder,ISystemClock)">OpenIddictValidationAspNetCoreHandler(IOpenIddictValidationDispatcher, IOpenIddictValidationFactory, IOptionsMonitor<OpenIddictValidationAspNetCoreOptions>, ILoggerFactory, UrlEncoder, ISystemClock)</h4>
|
|
<div class="markdown level1 summary"><p>Creates a new instance of the <a class="xref" href="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler.html">OpenIddictValidationAspNetCoreHandler</a> class.</p>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public OpenIddictValidationAspNetCoreHandler(IOpenIddictValidationDispatcher dispatcher, IOpenIddictValidationFactory factory, IOptionsMonitor<OpenIddictValidationAspNetCoreOptions> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><a class="xref" href="OpenIddict.Validation.IOpenIddictValidationDispatcher.html">IOpenIddictValidationDispatcher</a></td>
|
|
<td><span class="parametername">dispatcher</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><a class="xref" href="OpenIddict.Validation.IOpenIddictValidationFactory.html">IOpenIddictValidationFactory</a></td>
|
|
<td><span class="parametername">factory</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">IOptionsMonitor</span><<a class="xref" href="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreOptions.html">OpenIddictValidationAspNetCoreOptions</a>></td>
|
|
<td><span class="parametername">options</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ILoggerFactory</span></td>
|
|
<td><span class="parametername">logger</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">UrlEncoder</span></td>
|
|
<td><span class="parametername">encoder</span></td>
|
|
<td></td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">ISystemClock</span></td>
|
|
<td><span class="parametername">clock</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler_HandleAuthenticateAsync_" data-uid="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler.HandleAuthenticateAsync*"></a>
|
|
<h4 id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler_HandleAuthenticateAsync" data-uid="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler.HandleAuthenticateAsync">HandleAuthenticateAsync()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected override Task<AuthenticateResult> HandleAuthenticateAsync()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">Task</span><<span class="xref">AuthenticateResult</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler_HandleChallengeAsync_" data-uid="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler.HandleChallengeAsync*"></a>
|
|
<h4 id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler_HandleChallengeAsync_System_Nullable_AuthenticationProperties__" data-uid="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler.HandleChallengeAsync(System.Nullable{AuthenticationProperties})">HandleChallengeAsync(Nullable<AuthenticationProperties>)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected override Task HandleChallengeAsync(AuthenticationProperties? properties)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">AuthenticationProperties</span>></td>
|
|
<td><span class="parametername">properties</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">Task</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler_HandleForbiddenAsync_" data-uid="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler.HandleForbiddenAsync*"></a>
|
|
<h4 id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler_HandleForbiddenAsync_System_Nullable_AuthenticationProperties__" data-uid="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler.HandleForbiddenAsync(System.Nullable{AuthenticationProperties})">HandleForbiddenAsync(Nullable<AuthenticationProperties>)</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">protected override Task HandleForbiddenAsync(AuthenticationProperties? properties)</code></pre>
|
|
</div>
|
|
<h5 class="parameters">Parameters</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Name</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">System.Nullable</span><<span class="xref">AuthenticationProperties</span>></td>
|
|
<td><span class="parametername">properties</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">Task</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler_HandleRequestAsync_" data-uid="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler.HandleRequestAsync*"></a>
|
|
<h4 id="OpenIddict_Validation_AspNetCore_OpenIddictValidationAspNetCoreHandler_HandleRequestAsync" data-uid="OpenIddict.Validation.AspNetCore.OpenIddictValidationAspNetCoreHandler.HandleRequestAsync">HandleRequestAsync()</h4>
|
|
<div class="markdown level1 summary"></div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Task<bool> HandleRequestAsync()</code></pre>
|
|
</div>
|
|
<h5 class="returns">Returns</h5>
|
|
<table class="table table-bordered table-striped table-condensed">
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><span class="xref">Task</span><<span class="xref">System.Boolean</span>></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<span class="xref">IAuthenticationRequestHandler</span>
|
|
</div>
|
|
</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>
|