Enx.OpenIddict.RavenDB 0.2.0

Enx.OpenIddict.RavenDB

RavenDB storage provider for OpenIddict — the flexible, standards-compliant OpenID Connect/OAuth 2.0 server framework for ASP.NET Core.

Overview

Enx.OpenIddict.RavenDB implements all four OpenIddict core store interfaces backed by RavenDB, enabling you to use a document-oriented database as the persistence layer for your OpenID Connect / OAuth 2.0 server.

Requirements

• .NET Standard 2.0 / 2.1, .NET 8, or .NET 10
• OpenIddict 7.x
• RavenDB.Client 7.x

Installation

dotnet add package Enx.OpenIddict.RavenDB

The models package is included transitively. If you need to reference the entity types directly in a separate project, add:

dotnet add package Enx.OpenIddict.RavenDB.Models

Getting started

1. Configure RavenDB

Register your RavenDB IDocumentStore as usual before configuring OpenIddict:

builder.Services.AddSingleton<IDocumentStore>(provider =>
{
    var store = new DocumentStore
    {
        Urls = ["http://localhost:8080"],
        Database = "MyApp"
    };
    store.Initialize();
    return store;
});

// Register a scoped async session used by the OpenIddict stores
builder.Services.AddScoped(provider =>
    provider.GetRequiredService<IDocumentStore>().OpenAsyncSession());

2. Register OpenIddict with the RavenDB provider

builder.Services.AddOpenIddict()
    .AddCore(options =>
    {
        options.UseRavenDB();
    })
    .AddServer(options =>
    {
        // ... your server configuration
    });

3. Deploy RavenDB indexes

The library ships with custom RavenDB indexes for efficient querying. Deploy them once at startup:

var store = app.Services.GetRequiredService<IDocumentStore>();
await IndexCreation.CreateIndexesAsync(
    typeof(OpenIddictRavenDBApplication).Assembly, store);

Custom entities

All entity types are extensible. Inherit from the base model, then tell OpenIddict to use your custom type:

public class MyApplication : OpenIddictRavenDBApplication
{
    public string? Tenant { get; set; }
}

builder.Services.AddOpenIddict()
    .AddCore(options =>
    {
        options.UseRavenDB(ravendb =>
        {
            ravendb.ReplaceDefaultApplicationEntity<MyApplication>();
        });
    });

The same pattern applies to ReplaceDefaultAuthorizationEntity<T>, ReplaceDefaultScopeEntity<T>, and ReplaceDefaultTokenEntity<T>.

Entity models

Contributing

Contributions are welcome. Please open an issue before submitting a pull request for significant changes.

License

This project is licensed under the MIT License. Copyright © 2026 Jean-François Pustay.