mirror of
https://gitee.com/dcren/openiddict-documentation.git
synced 2025-07-15 23:13:34 +08:00
288 lines
12 KiB
HTML
288 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>MongoDB integration </title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="MongoDB integration ">
|
|
<meta name="generator" content="docfx 2.56.7.0">
|
|
|
|
<link rel="shortcut icon" href="../images/favicon.ico">
|
|
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500;700&display=swap" rel="stylesheet">
|
|
<link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/night-owl.min.css">
|
|
<link rel="stylesheet" href="../styles/colors.css">
|
|
<link rel="stylesheet" href="../styles/discord.css">
|
|
<link rel="stylesheet" href="../styles/main.css">
|
|
<meta property="docfx:navrel" content="../toc.html">
|
|
<meta property="docfx:tocrel" content="toc.html">
|
|
|
|
|
|
|
|
</head>
|
|
|
|
<body>
|
|
<div class="top-navbar">
|
|
|
|
<a href="javascript:void(0);" class="burger-icon" onclick="toggleMenu()">
|
|
<svg name="Hamburger" style="vertical-align: middle;" width="24" height="24" viewbox="0 0 24 24"><path fill="currentColor" fill-rule="evenodd" clip-rule="evenodd" d="M20 6H4V9H20V6ZM4 10.999H20V13.999H4V10.999ZM4 15.999H20V18.999H4V15.999Z"></path></svg>
|
|
</a>
|
|
|
|
|
|
<a class="brand" href="../index.html">
|
|
<img src="../images/logo.png" alt="OpenIddict" class="logomark">
|
|
<span class="brand-title">OpenIddict</span>
|
|
</a>
|
|
</div>
|
|
|
|
<div class="body-content">
|
|
|
|
<div id="blackout" class="blackout" onclick="toggleMenu()"></div>
|
|
|
|
<nav id="sidebar" role="navigation">
|
|
|
|
<div class="sidebar">
|
|
|
|
|
|
|
|
|
|
<div>
|
|
|
|
<a class="brand" href="../index.html">
|
|
<img src="../images/logo.png" alt="OpenIddict" class="logomark">
|
|
<span class="brand-title">OpenIddict</span>
|
|
</a>
|
|
<div id="navbar">
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="sidebar-item-separator"></div>
|
|
|
|
|
|
<div id="sidetoggle">
|
|
<div id="sidetoc"></div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="footer">
|
|
|
|
<span>Generated by <strong>DocFX</strong></span>
|
|
</div>
|
|
</nav>
|
|
|
|
<main class="main-panel">
|
|
|
|
<div role="main" class="hide-when-search">
|
|
|
|
|
|
<div class="subnav navbar navbar-default">
|
|
<div class="container hide-when-search" id="breadcrumb">
|
|
<ul class="breadcrumb">
|
|
<li></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<article class="content wrap" id="_content" data-uid="">
|
|
<h1 id="mongodb-integration">MongoDB integration</h1>
|
|
|
|
<h2 id="basic-configuration">Basic configuration</h2>
|
|
<p>To configure OpenIddict to use MongoDB as the database for applications, authorizations, scopes and tokens, you'll need to:</p>
|
|
<ul>
|
|
<li><p><strong>Reference the <code>OpenIddict.MongoDb</code> package</strong>:</p>
|
|
<pre><code class="lang-xml"><PackageReference Include="OpenIddict.MongoDb" Version="4.6.0" />
|
|
</code></pre></li>
|
|
<li><p><strong>Configure OpenIddict to use the MongoDB stores</strong>:</p>
|
|
<pre><code class="lang-csharp">services.AddOpenIddict()
|
|
.AddCore(options =>
|
|
{
|
|
// Note: to use a remote server, call the MongoClient constructor overload
|
|
// that accepts a connection string or an instance of MongoClientSettings.
|
|
options.UseMongoDb()
|
|
.UseDatabase(new MongoClient().GetDatabase("openiddict"));
|
|
});
|
|
</code></pre><p>Alternatively, you can register the <code>IMongoDatabase</code> instance as a service:</p>
|
|
<pre><code class="lang-csharp">services.AddOpenIddict()
|
|
.AddCore(options =>
|
|
{
|
|
options.UseMongoDb();
|
|
});
|
|
|
|
// Note: to use a remote server, call the MongoClient constructor overload
|
|
// that accepts a connection string or an instance of MongoClientSettings.
|
|
services.AddSingleton(new MongoClient().GetDatabase("shared-database-instance"));
|
|
</code></pre></li>
|
|
<li><p><strong>Create indexes to improve performance</strong> (recommended): for that, you can use the following script to
|
|
initialize the database and create the indexes used by the OpenIddict entities:</p>
|
|
<pre><code class="lang-csharp">using System.Threading;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Options;
|
|
using MongoDB.Driver;
|
|
using OpenIddict.MongoDb;
|
|
using OpenIddict.MongoDb.Models;
|
|
|
|
var services = new ServiceCollection();
|
|
services.AddOpenIddict()
|
|
.AddCore(options => options.UseMongoDb());
|
|
|
|
services.AddSingleton(new MongoClient("mongodb://localhost:27017").GetDatabase("openiddict"));
|
|
|
|
var provider = services.BuildServiceProvider();
|
|
var context = provider.GetRequiredService<IOpenIddictMongoDbContext>();
|
|
var options = provider.GetRequiredService<IOptionsMonitor<OpenIddictMongoDbOptions>>().CurrentValue;
|
|
var database = await context.GetDatabaseAsync(CancellationToken.None);
|
|
|
|
var applications = database.GetCollection<OpenIddictMongoDbApplication>(options.ApplicationsCollectionName);
|
|
|
|
await applications.Indexes.CreateManyAsync(new[]
|
|
{
|
|
new CreateIndexModel<OpenIddictMongoDbApplication>(
|
|
Builders<OpenIddictMongoDbApplication>.IndexKeys.Ascending(application => application.ClientId),
|
|
new CreateIndexOptions
|
|
{
|
|
Unique = true
|
|
}),
|
|
|
|
new CreateIndexModel<OpenIddictMongoDbApplication>(
|
|
Builders<OpenIddictMongoDbApplication>.IndexKeys.Ascending(application => application.PostLogoutRedirectUris),
|
|
new CreateIndexOptions
|
|
{
|
|
Background = true
|
|
}),
|
|
|
|
new CreateIndexModel<OpenIddictMongoDbApplication>(
|
|
Builders<OpenIddictMongoDbApplication>.IndexKeys.Ascending(application => application.RedirectUris),
|
|
new CreateIndexOptions
|
|
{
|
|
Background = true
|
|
})
|
|
});
|
|
|
|
var authorizations = database.GetCollection<OpenIddictMongoDbAuthorization>(options.AuthorizationsCollectionName);
|
|
|
|
await authorizations.Indexes.CreateOneAsync(
|
|
new CreateIndexModel<OpenIddictMongoDbAuthorization>(
|
|
Builders<OpenIddictMongoDbAuthorization>.IndexKeys
|
|
.Ascending(authorization => authorization.ApplicationId)
|
|
.Ascending(authorization => authorization.Scopes)
|
|
.Ascending(authorization => authorization.Status)
|
|
.Ascending(authorization => authorization.Subject)
|
|
.Ascending(authorization => authorization.Type),
|
|
new CreateIndexOptions
|
|
{
|
|
Background = true
|
|
}));
|
|
|
|
var scopes = database.GetCollection<OpenIddictMongoDbScope>(options.ScopesCollectionName);
|
|
|
|
await scopes.Indexes.CreateOneAsync(new CreateIndexModel<OpenIddictMongoDbScope>(
|
|
Builders<OpenIddictMongoDbScope>.IndexKeys.Ascending(scope => scope.Name),
|
|
new CreateIndexOptions
|
|
{
|
|
Unique = true
|
|
}));
|
|
|
|
var tokens = database.GetCollection<OpenIddictMongoDbToken>(options.TokensCollectionName);
|
|
|
|
await tokens.Indexes.CreateManyAsync(new[]
|
|
{
|
|
new CreateIndexModel<OpenIddictMongoDbToken>(
|
|
Builders<OpenIddictMongoDbToken>.IndexKeys.Ascending(token => token.ReferenceId),
|
|
new CreateIndexOptions<OpenIddictMongoDbToken>
|
|
{
|
|
// Note: partial filter expressions are not supported on Azure Cosmos DB.
|
|
// As a workaround, the expression and the unique constraint can be removed.
|
|
PartialFilterExpression = Builders<OpenIddictMongoDbToken>.Filter.Exists(token => token.ReferenceId),
|
|
Unique = true
|
|
}),
|
|
|
|
new CreateIndexModel<OpenIddictMongoDbToken>(
|
|
Builders<OpenIddictMongoDbToken>.IndexKeys
|
|
.Ascending(token => token.ApplicationId)
|
|
.Ascending(token => token.Status)
|
|
.Ascending(token => token.Subject)
|
|
.Ascending(token => token.Type),
|
|
new CreateIndexOptions
|
|
{
|
|
Background = true
|
|
})
|
|
});
|
|
</code></pre></li>
|
|
</ul>
|
|
<h2 id="advanced-configuration">Advanced configuration</h2>
|
|
<h3 id="use-custom-entities">Use custom entities</h3>
|
|
<p>For applications that require storing additional data alongside the properties used by OpenIddict, custom entities can be used. For that, you need to:</p>
|
|
<ul>
|
|
<li><p><strong>Create custom entities</strong>:</p>
|
|
<pre><code class="lang-csharp">public class CustomApplication : OpenIddictMongoDbApplication
|
|
{
|
|
public string CustomProperty { get; set; }
|
|
}
|
|
|
|
public class CustomAuthorization : OpenIddictMongoDbAuthorization
|
|
{
|
|
public string CustomProperty { get; set; }
|
|
}
|
|
|
|
public class CustomScope : OpenIddictMongoDbScope
|
|
{
|
|
public string CustomProperty { get; set; }
|
|
}
|
|
|
|
public class CustomToken : OpenIddictMongoDbToken
|
|
{
|
|
public string CustomProperty { get; set; }
|
|
}
|
|
</code></pre></li>
|
|
<li><p><strong>Configure MongoDb to use the custom entities</strong>:</p>
|
|
<pre><code class="lang-csharp">services.AddOpenIddict()
|
|
.AddCore(options =>
|
|
{
|
|
options.UseMongoDb()
|
|
.ReplaceDefaultApplicationEntity<CustomApplication>()
|
|
.ReplaceDefaultAuthorizationEntity<CustomAuthorization>()
|
|
.ReplaceDefaultScopeEntity<CustomScope>()
|
|
.ReplaceDefaultTokenEntity<CustomToken>();
|
|
});
|
|
</code></pre></li>
|
|
</ul>
|
|
<h3 id="use-custom-collection-names">Use custom collection names</h3>
|
|
<p>By default, OpenIddict uses the <code>openiddict.[entity name]s</code> pattern to determine the default collection names.
|
|
Applications that require using different collection names can use the <code>Set*CollectionName()</code> helpers:</p>
|
|
<pre><code class="lang-csharp">services.AddOpenIddict()
|
|
.AddCore(options =>
|
|
{
|
|
options.UseMongoDb()
|
|
.SetApplicationsCollectionName("custom-applications-collection")
|
|
.SetAuthorizationsCollectionName("custom-authorizations-collection")
|
|
.SetScopesCollectionName("custom-scopes-collection")
|
|
.SetTokensCollectionName("custom-tokens-collection");
|
|
});
|
|
</code></pre></article>
|
|
|
|
</div>
|
|
</main>
|
|
</div>
|
|
|
|
|
|
<script src="https://code.jquery.com/jquery-3.5.1.min.js" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
|
|
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js"></script>
|
|
<script type="text/javascript" src="../styles/jquery.twbsPagination.js"></script>
|
|
<script type="text/javascript" src="../styles/url.min.js"></script>
|
|
<script src="https://cdn.jsdelivr.net/npm/anchor-js/anchor.min.js"></script>
|
|
<script type="text/javascript" src="../styles/docfx.js"></script>
|
|
<script type="text/javascript" src="../styles/main.js"></script>
|
|
|
|
</body>
|
|
|
|
</html>
|