lsm/openiddict-documentation
1
0
Fork 0
mirror of https://gitee.com/dcren/openiddict-documentation.git synced 2025-11-09 10:54:46 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update the documentation pages

Browse Source
This commit is contained in:
OpenIddict Bot
2020-07-03 21:51:56 +00:00
parent f4f15466c4
commit cf7d02d6d9
20 changed files with 870 additions and 792 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
guide/getting-started.html
View File

@@ -8,7 +8,7 @@
<title>Getting started </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Getting started ">
<meta name="generator" content="docfx 2.24.0.0">
<meta name="generator" content="docfx 2.45.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@@ -20,7 +20,7 @@
</head>
<body data-spy="scroll" data-target="#affix">
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
@@ -264,7 +264,7 @@ using (var scope = app.ApplicationServices.CreateScope())
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>

6
guide/index.html
View File

@@ -8,7 +8,7 @@
<title>Introduction </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Introduction ">
<meta name="generator" content="docfx 2.24.0.0">
<meta name="generator" content="docfx 2.45.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@@ -20,7 +20,7 @@
</head>
<body data-spy="scroll" data-target="#affix">
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
@@ -111,7 +111,7 @@ with the power to control who can access your API and the information that is ex
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>

12
guide/migration.html
View File

@@ -8,7 +8,7 @@
<title>Migrate to OpenIddict RC3 </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Migrate to OpenIddict RC3 ">
<meta name="generator" content="docfx 2.24.0.0">
<meta name="generator" content="docfx 2.45.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@@ -20,7 +20,7 @@
</head>
<body data-spy="scroll" data-target="#affix">
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
@@ -281,15 +281,15 @@ folder in your application root folder and an <code>__EFMigrationsHistory</code>
Version=&quot;2.0.0&quot; /&gt;
&lt;/ItemGroup&gt;
</code></pre><p>Then, open a new command line and add an initial migration using <code>dotnet ef migrations add InitialMigration</code> (<strong>but don&#39;t apply it!</strong>).</p>
<h2 id="update-your-packages-references">Update your packages references</h2>
<h2 id="update-your-packages-references-1">Update your packages references</h2>
<p>For that, simply update your <code>.csproj</code> file to point to the newest OpenIddict packages:</p>
<h3 id="aspnet-core-1x">ASP.NET Core 1.x</h3>
<h3 id="aspnet-core-1x-1">ASP.NET Core 1.x</h3>
<pre><code class="lang-xml">&lt;ItemGroup&gt;
&lt;PackageReference Include=&quot;OpenIddict&quot; Version=&quot;1.0.0-rc2-final&quot; /&gt;
&lt;PackageReference Include=&quot;OpenIddict.EntityFrameworkCore&quot; Version=&quot;1.0.0-rc2-final&quot; /&gt;
&lt;PackageReference Include=&quot;OpenIddict.Mvc&quot; Version=&quot;1.0.0-rc2-final&quot; /&gt;
&lt;/ItemGroup&gt;
</code></pre><h3 id="aspnet-core-2x">ASP.NET Core 2.x</h3>
</code></pre><h3 id="aspnet-core-2x-1">ASP.NET Core 2.x</h3>
<pre><code class="lang-xml">&lt;ItemGroup&gt;
&lt;PackageReference Include=&quot;OpenIddict&quot; Version=&quot;2.0.0-rc2-final&quot; /&gt;
&lt;PackageReference Include=&quot;OpenIddict.EntityFrameworkCore&quot; Version=&quot;2.0.0-rc2-final&quot; /&gt;
@@ -550,7 +550,7 @@ controlling and limiting the OAuth2/OpenID Connect features a client application
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>

6
guide/samples.html
View File

@@ -8,7 +8,7 @@
<title>Samples </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Samples ">
<meta name="generator" content="docfx 2.24.0.0">
<meta name="generator" content="docfx 2.45.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@@ -20,7 +20,7 @@
</head>
<body data-spy="scroll" data-target="#affix">
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
@@ -107,7 +107,7 @@
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>

133
guide/toc.html
View File

@@ -1,65 +1,4 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Table of Content </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Table of Content ">
<meta name="generator" content="docfx 2.24.0.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
</head>
<body data-spy="scroll" data-target="#affix">
<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="../logo.svg" 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="article row grid">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="">

<div id="sidetoggle">
<div>
<div class="sidefilter">
@@ -72,57 +11,23 @@
<div class="toc" id="toc">
<ul class="nav level1">
<li>
<a href="index.html" name="" title="Introduction">Introduction</a>
</li>
<li>
<a href="getting-started.html" name="" title="Getting started">Getting started</a>
</li>
<li>
<a href="samples.html" name="" title="Samples">Samples</a>
</li>
<li>
<a href="migration.html" name="" title="Migration guide">Migration guide</a>
</li>
<li>
<a href="token-formats.html" name="" title="Understanding the different token formats">Understanding the different token formats</a>
</li>
</ul> </div>
<li>
<a href="index.html" name="" title="Introduction">Introduction</a>
</li>
<li>
<a href="getting-started.html" name="" title="Getting started">Getting started</a>
</li>
<li>
<a href="samples.html" name="" title="Samples">Samples</a>
</li>
<li>
<a href="migration.html" name="" title="Migration guide">Migration guide</a>
</li>
<li>
<a href="token-formats.html" name="" title="Understanding the different token formats">Understanding the different token formats</a>
</li>
</ul>
</div>
</div>
</div>
</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">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</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>Copyright © 2015-2017 Microsoft<br>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>
</div>

18
guide/token-formats.html
View File

@@ -8,7 +8,7 @@
<title>Understanding the different token formats </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Understanding the different token formats ">
<meta name="generator" content="docfx 2.24.0.0">
<meta name="generator" content="docfx 2.45.1.0">
<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
@@ -20,7 +20,7 @@
</head>
<body data-spy="scroll" data-target="#affix">
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
@@ -100,7 +100,7 @@
<hr>
<h2 id="reference-tokens">Reference tokens</h2>
<p>When using reference token format, authorization codes, access tokens and refresh tokens are stored as ciphertext in the database and a crypto-secure random identifier is returned to the client application.</p>
<h3 id="benefits">Benefits</h3>
<h3 id="benefits-1">Benefits</h3>
<ul>
<li>Minimal configuration required</li>
<li>Uses OpenIddict&#39;s built-in validation</li>
@@ -109,30 +109,30 @@
<li>Issued tokens are tracked in data store</li>
<li>Can immediately be revoked</li>
</ul>
<h3 id="drawbacks">Drawbacks</h3>
<h3 id="drawbacks-1">Drawbacks</h3>
<ul>
<li>.NET Core validation only (although someone could write it for other platforms)</li>
<li>Requires a connection to OpenIddict&#39;s data store, e.g. Entity Framework DataContext. Resource servers may not want to have to reference OpenIddict&#39;s database</li>
<li>Because only ids are in the access tokens, a call to the database is required for every request</li>
</ul>
<h3 id="setup-and-api-validation-configuration">Setup and API validation configuration</h3>
<h3 id="setup-and-api-validation-configuration-1">Setup and API validation configuration</h3>
<p><a href="../configuration/token-setup-and-validation.html#reference-token-format">Here</a></p>
<hr>
<h2 id="jwts-json-web-tokens">JWTs (JSON Web Tokens)</h2>
<p>These are standard tokens verifiable by third parties, used by Azure Active Directory, Auth0, and other valid OAuth 2.0 service. They are signed by the authorization server but their contents are not encrypted so they can be read by anyone.</p>
<h3 id="benefits">Benefits</h3>
<h3 id="benefits-2">Benefits</h3>
<ul>
<li>Good to be familiar with JWTs because they are a commonly used access token type in OAuth 2.0 and are also <code>id token</code> type</li>
<li>Plenty of platforms include JWT validation libraries (.NET, PHP, Node, Python, etc)</li>
<li>Future proof</li>
</ul>
<h3 id="drawbacks">Drawbacks</h3>
<h3 id="drawbacks-2">Drawbacks</h3>
<ul>
<li>Anyone can inspect contents (see <a href="https://jwt.io/">https://jwt.io/</a>), so if token is hanging around in a log somewhere or intercepted somehow all claims or other information in the token can be read, even if token is expired</li>
<li>Claims are stored within the token, which is convenient but token size could get large if there are a lot of claims (probably not an issue in real-world scenarios)</li>
<li>Token expiration is in the token itself, so even if users sign out their tokens will still be valid until they reach their expiration</li>
</ul>
<h3 id="setup-and-api-validation-configuration">Setup and API validation configuration</h3>
<h3 id="setup-and-api-validation-configuration-2">Setup and API validation configuration</h3>
<p><a href="../configuration/token-setup-and-validation.html#jwts">Here</a></p>
</article>
</div>
@@ -162,7 +162,7 @@
<a href="#top">Back to top</a>
</span>
<span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>