mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-04-24 18:04:57 +08:00
Update the documentation pages
This commit is contained in:
parent
2262d5b0c1
commit
78ff179c3b
@ -75,20 +75,9 @@
|
|||||||
</li>
|
</li>
|
||||||
<li><p><strong>Have an existing project or create a new one</strong>: when creating a new project using Visual Studio's default ASP.NET Core template, using <strong>individual user accounts authentication</strong> is strongly recommended. When updating an existing project, you must provide your own <code>AccountController</code> to handle the registration process and the authentication flow.</p>
|
<li><p><strong>Have an existing project or create a new one</strong>: when creating a new project using Visual Studio's default ASP.NET Core template, using <strong>individual user accounts authentication</strong> is strongly recommended. When updating an existing project, you must provide your own <code>AccountController</code> to handle the registration process and the authentication flow.</p>
|
||||||
</li>
|
</li>
|
||||||
<li><p><strong>Add the appropriate MyGet repositories to your NuGet sources</strong>. This can be done by adding a new <code>NuGet.Config</code> file at the root of your solution:</p>
|
<li><p><strong>Update your <code>.csproj</code> file</strong> to reference the <code>OpenIddict</code> packages:</p>
|
||||||
<pre><code class="lang-xml"><?xml version="1.0" encoding="utf-8"?>
|
<pre><code class="lang-xml"><PackageReference Include="OpenIddict" Version="2.0.0-*" />
|
||||||
<configuration>
|
|
||||||
<packageSources>
|
|
||||||
<add key="NuGet" value="https://api.nuget.org/v3/index.json" />
|
|
||||||
<add key="aspnet-contrib" value="https://www.myget.org/F/aspnet-contrib/api/v3/index.json" />
|
|
||||||
</packageSources>
|
|
||||||
</configuration>
|
|
||||||
</code></pre></li>
|
|
||||||
<li><p><strong>Update your <code>.csproj</code> file</strong> to reference <code>AspNet.Security.OAuth.Validation</code> and the <code>OpenIddict</code> packages:</p>
|
|
||||||
<pre><code class="lang-xml"><PackageReference Include="AspNet.Security.OAuth.Validation" Version="2.0.0-*" />
|
|
||||||
<PackageReference Include="OpenIddict" Version="2.0.0-*" />
|
|
||||||
<PackageReference Include="OpenIddict.EntityFrameworkCore" Version="2.0.0-*" />
|
<PackageReference Include="OpenIddict.EntityFrameworkCore" Version="2.0.0-*" />
|
||||||
<PackageReference Include="OpenIddict.Mvc" Version="2.0.0-*" />
|
|
||||||
</code></pre></li>
|
</code></pre></li>
|
||||||
<li><p><strong>Configure the OpenIddict services</strong> in <code>Startup.ConfigureServices</code>:</p>
|
<li><p><strong>Configure the OpenIddict services</strong> in <code>Startup.ConfigureServices</code>:</p>
|
||||||
<pre><code class="lang-csharp">public void ConfigureServices(IServiceCollection services)
|
<pre><code class="lang-csharp">public void ConfigureServices(IServiceCollection services)
|
||||||
@ -111,38 +100,38 @@
|
|||||||
.AddEntityFrameworkStores<ApplicationDbContext>()
|
.AddEntityFrameworkStores<ApplicationDbContext>()
|
||||||
.AddDefaultTokenProviders();
|
.AddDefaultTokenProviders();
|
||||||
|
|
||||||
// Register the OAuth2 validation handler.
|
|
||||||
services.AddAuthentication()
|
|
||||||
.AddOAuthValidation();
|
|
||||||
|
|
||||||
// Register the OpenIddict services.
|
// Register the OpenIddict services.
|
||||||
// Note: use the generic overload if you need
|
services.AddOpenIddict()
|
||||||
// to replace the default OpenIddict entities.
|
.AddCore(options =>
|
||||||
services.AddOpenIddict(options =>
|
{
|
||||||
{
|
// Configure OpenIddict to use the Entity Framework Core stores and entities.
|
||||||
// Register the Entity Framework stores.
|
options.UseEntityFrameworkCore()
|
||||||
options.AddEntityFrameworkCoreStores<ApplicationDbContext>();
|
.UseDbContext<ApplicationDbContext>();
|
||||||
|
})
|
||||||
|
|
||||||
// Register the ASP.NET Core MVC binder used by OpenIddict.
|
.AddServer(options =>
|
||||||
// Note: if you don't call this method, you won't be able to
|
{
|
||||||
// bind OpenIdConnectRequest or OpenIdConnectResponse parameters.
|
// Register the ASP.NET Core MVC binder used by OpenIddict.
|
||||||
options.AddMvcBinders();
|
// Note: if you don't call this method, you won't be able to
|
||||||
|
// bind OpenIdConnectRequest or OpenIdConnectResponse parameters.
|
||||||
|
options.UseMvc();
|
||||||
|
|
||||||
// Enable the token endpoint (required to use the password flow).
|
// Enable the token endpoint (required to use the password flow).
|
||||||
options.EnableTokenEndpoint("/connect/token");
|
options.EnableTokenEndpoint("/connect/token");
|
||||||
|
|
||||||
// Allow client applications to use the grant_type=password flow.
|
// Allow client applications to use the grant_type=password flow.
|
||||||
options.AllowPasswordFlow();
|
options.AllowPasswordFlow();
|
||||||
|
|
||||||
// During development, you can disable the HTTPS requirement.
|
// During development, you can disable the HTTPS requirement.
|
||||||
options.DisableHttpsRequirement();
|
options.DisableHttpsRequirement();
|
||||||
});
|
|
||||||
|
// Accept token requests that don't specify a client_id.
|
||||||
|
options.AcceptAnonymousClients();
|
||||||
|
})
|
||||||
|
|
||||||
|
.AddValidation();
|
||||||
}
|
}
|
||||||
</code></pre><blockquote><p><strong>Note:</strong> for more information about the different options and configurations available, check out
|
</code></pre></li>
|
||||||
<a href="https://github.com/openiddict/core/wiki/Configuration-and-options">Configuration and options</a>
|
|
||||||
in the project wiki.</p>
|
|
||||||
</blockquote>
|
|
||||||
</li>
|
|
||||||
<li><p><strong>Make sure the authentication middleware is registered before all the other middleware, including <code>app.UseMvc()</code></strong>:</p>
|
<li><p><strong>Make sure the authentication middleware is registered before all the other middleware, including <code>app.UseMvc()</code></strong>:</p>
|
||||||
<pre><code class="lang-csharp">public void Configure(IApplicationBuilder app)
|
<pre><code class="lang-csharp">public void Configure(IApplicationBuilder app)
|
||||||
{
|
{
|
||||||
@ -162,53 +151,78 @@ in the project wiki.</p>
|
|||||||
// to replace the default OpenIddict entities.
|
// to replace the default OpenIddict entities.
|
||||||
options.UseOpenIddict();
|
options.UseOpenIddict();
|
||||||
});
|
});
|
||||||
</code></pre><blockquote><p><strong>Note:</strong> if you change the default entity primary key (e.g. to <code>int</code> or <code>Guid</code> instead of <code>string</code>), make sure to use the <code>services.AddOpenIddict()</code> extension accepting a <code>TKey</code> generic argument and use the generic <code>options.UseOpenIddict<TKey>()</code> overload.</p>
|
</code></pre></li>
|
||||||
</blockquote>
|
</ul>
|
||||||
</li>
|
<blockquote><p><strong>Note:</strong> if you change the default entity primary key (e.g. to <code>int</code> or <code>Guid</code> instead of <code>string</code>), make sure you use the <code>options.ReplaceDefaultEntities<TKey>()</code> core extension accepting a <code>TKey</code> generic argument and use the generic <code>options.UseOpenIddict<TKey>()</code> overload to configure Entity Framework Core to use the specified key type:</p>
|
||||||
<li><p><strong>Create your own authorization controller</strong>:</p>
|
<pre><code class="lang-csharp">services.AddOpenIddict()
|
||||||
|
.AddCore(options =>
|
||||||
|
{
|
||||||
|
// Configure OpenIddict to use the default entities with a custom key type.
|
||||||
|
options.UseEntityFrameworkCore()
|
||||||
|
.UseDbContext<ApplicationDbContext>()
|
||||||
|
.ReplaceDefaultEntities<Guid>();
|
||||||
|
});
|
||||||
|
|
||||||
|
services.AddDbContext<ApplicationDbContext>(options =>
|
||||||
|
{
|
||||||
|
// Configure the context to use Microsoft SQL Server.
|
||||||
|
options.UseSqlServer(configuration["Data:DefaultConnection:ConnectionString"]);
|
||||||
|
|
||||||
|
options.UseOpenIddict<Guid>();
|
||||||
|
});
|
||||||
|
</code></pre></blockquote>
|
||||||
|
<ul>
|
||||||
|
<li><strong>Create your own authorization controller</strong>:</li>
|
||||||
|
</ul>
|
||||||
<p>To <strong>support the password or the client credentials flow, you must provide your own token endpoint action</strong>.
|
<p>To <strong>support the password or the client credentials flow, you must provide your own token endpoint action</strong>.
|
||||||
To enable authorization code/implicit flows support, you'll similarly have to create your own authorization endpoint action and your own views/view models.</p>
|
To enable authorization code/implicit flows support, you'll similarly have to create your own authorization endpoint action and your own views/view models.</p>
|
||||||
<p>The <strong>Mvc.Server sample comes with an <a href="https://github.com/openiddict/openiddict-core/blob/dev/samples/Mvc.Server/Controllers/AuthorizationController.cs"><code>AuthorizationController</code> that supports both the password flow and the authorization code flow and that you can easily reuse in your application</a></strong>.</p>
|
<p>The <strong>Mvc.Server sample comes with an <a href="https://github.com/openiddict/openiddict-core/blob/dev/samples/Mvc.Server/Controllers/AuthorizationController.cs"><code>AuthorizationController</code> that supports both the password flow and the authorization code flow and that you can easily reuse in your application</a></strong>.</p>
|
||||||
</li>
|
<ul>
|
||||||
<li><p><strong>Enable the corresponding flows in the OpenIddict options</strong>:</p>
|
<li><p><strong>Enable the corresponding flows in the OpenIddict options</strong>:</p>
|
||||||
<pre><code class="lang-csharp">public void ConfigureServices(IServiceCollection services)
|
<pre><code class="lang-csharp">public void ConfigureServices(IServiceCollection services)
|
||||||
{
|
{
|
||||||
// Register the OpenIddict services.
|
// Register the OpenIddict services.
|
||||||
// Note: use the generic overload if you need
|
services.AddOpenIddict()
|
||||||
// to replace the default OpenIddict entities.
|
.AddCore(options =>
|
||||||
services.AddOpenIddict(options =>
|
{
|
||||||
{
|
// Configure OpenIddict to use the Entity Framework Core stores and entities.
|
||||||
// Register the Entity Framework stores.
|
options.UseEntityFrameworkCore()
|
||||||
options.AddEntityFrameworkCoreStores<ApplicationDbContext>();
|
.UseDbContext<ApplicationDbContext>();
|
||||||
|
})
|
||||||
|
|
||||||
// Register the ASP.NET Core MVC binder used by OpenIddict.
|
.AddServer(options =>
|
||||||
// Note: if you don't call this method, you won't be able to
|
{
|
||||||
// bind OpenIdConnectRequest or OpenIdConnectResponse parameters.
|
// Register the ASP.NET Core MVC binder used by OpenIddict.
|
||||||
options.AddMvcBinders();
|
// Note: if you don't call this method, you won't be able to
|
||||||
|
// bind OpenIdConnectRequest or OpenIdConnectResponse parameters.
|
||||||
|
options.UseMvc();
|
||||||
|
|
||||||
// Enable the authorization and token endpoints (required to use the code flow).
|
// Enable the authorization/token endpoints (required to use the code flow).
|
||||||
options.EnableAuthorizationEndpoint("/connect/authorize")
|
options.EnableAuthorizationEndpoint("/connect/authorize")
|
||||||
.EnableTokenEndpoint("/connect/token");
|
.EnableTokenEndpoint("/connect/token");
|
||||||
|
|
||||||
// Allow client applications to use the code flow.
|
// Allow client applications to use the code flow.
|
||||||
options.AllowAuthorizationCodeFlow();
|
options.AllowAuthorizationCodeFlow();
|
||||||
|
|
||||||
// During development, you can disable the HTTPS requirement.
|
// During development, you can disable the HTTPS requirement.
|
||||||
options.DisableHttpsRequirement();
|
options.DisableHttpsRequirement();
|
||||||
});
|
})
|
||||||
|
|
||||||
|
.AddValidation();
|
||||||
}
|
}
|
||||||
</code></pre></li>
|
</code></pre></li>
|
||||||
<li><p><strong>Register your client application</strong>:</p>
|
<li><p><strong>Register your client application</strong>:</p>
|
||||||
<pre><code class="lang-csharp">// Create a new service scope to ensure the database context is correctly disposed when this methods returns.
|
<pre><code class="lang-csharp">// Create a new service scope to ensure the database context
|
||||||
using (var scope = app.ApplicationServices.GetRequiredService<IServiceScopeFactory>().CreateScope())
|
// is correctly disposed when this methods returns.
|
||||||
|
using (var scope = app.ApplicationServices.CreateScope())
|
||||||
{
|
{
|
||||||
var context = scope.ServiceProvider.GetRequiredService<ApplicationDbContext>();
|
var provider = scope.ServiceProvider;
|
||||||
|
var context = provider.GetRequiredService<ApplicationDbContext>();
|
||||||
await context.Database.EnsureCreatedAsync();
|
await context.Database.EnsureCreatedAsync();
|
||||||
|
|
||||||
// Note: when using a custom entity or a custom key type, replace OpenIddictApplication by the appropriate type.
|
var manager = provider.GetRequiredService<IOpenIddictApplicationManager>();
|
||||||
var manager = scope.ServiceProvider.GetRequiredService<OpenIddictApplicationManager<OpenIddictApplication>>();
|
|
||||||
|
|
||||||
if (await manager.FindByClientIdAsync("[client identifier]", cancellationToken) == null)
|
if (await manager.FindByClientIdAsync("[client identifier]") == null)
|
||||||
{
|
{
|
||||||
var descriptor = new OpenIddictApplicationDescriptor
|
var descriptor = new OpenIddictApplicationDescriptor
|
||||||
{
|
{
|
||||||
@ -217,7 +231,7 @@ using (var scope = app.ApplicationServices.GetRequiredService<IServiceScopeFa
|
|||||||
RedirectUris = { new Uri("[redirect uri]") }
|
RedirectUris = { new Uri("[redirect uri]") }
|
||||||
};
|
};
|
||||||
|
|
||||||
await manager.CreateAsync(descriptor, cancellationToken);
|
await manager.CreateAsync(descriptor);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
</code></pre></li>
|
</code></pre></li>
|
||||||
|
@ -116,7 +116,7 @@
|
|||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "guide/getting-started.html",
|
"relative_path": "guide/getting-started.html",
|
||||||
"hash": "1XJUTyg0gItxGGe1z7Xn0w=="
|
"hash": "0wyHg87zimUQBVUd+YBcoA=="
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"is_incremental": false,
|
"is_incremental": false,
|
||||||
|
Loading…
Reference in New Issue
Block a user