documentation.openiddict.com Open in urlscan Pro
2606:50c0:8000::153  Public Scan

Form analysis
0 forms found in the DOM

Text Content

OpenIddict
OpenIddict
 * Guides
 * Configuration
 * Integrations
 * Samples (external)
 * Changelog (external)


Generated by DocFX


OPENIDDICT


THE OPENID CONNECT STACK YOU'LL BE ADDICTED TO.




WHAT'S OPENIDDICT?

OpenIddict aims at providing a versatile solution to implement OpenID Connect
client, server and token validation support in any ASP.NET Core 2.1 (and higher)
application. ASP.NET 4.6.1 (and higher) applications are also fully supported
thanks to a native Microsoft.Owin 4.2 integration.

OpenIddict fully supports the code/implicit/hybrid flows, the client
credentials/resource owner password grants and the device authorization flow.

OpenIddict natively supports Entity Framework Core, Entity Framework 6 and
MongoDB out-of-the-box and custom stores can be implemented to support other
providers.

--------------------------------------------------------------------------------


GETTING STARTED

Developers looking for a simple and turnkey solution are strongly encouraged to
use OrchardCore and its OpenID module, which is based on OpenIddict, comes with
sensible defaults and offers a built-in management GUI to easily register OpenID
client applications.

To implement a custom OpenID Connect server using OpenIddict, read Getting
started.

Samples demonstrating how to use OpenIddict with the different OAuth 2.0/OpenID
Connect flows can be found in the dedicated repository.

--------------------------------------------------------------------------------


COMPATIBILITY MATRIX

Web framework version .NET runtime version OpenIddict 4.x OpenIddict 5.x ASP.NET
Core 2.1 .NET Framework 4.6.1 ✔️ ℹ️ ✔️ ℹ️ ASP.NET Core 2.1 .NET Framework 4.7.2
✔️ ✔️ ASP.NET Core 2.1 .NET Framework 4.8 ✔️ ✔️ ASP.NET Core 2.1 .NET Core 2.1 ❗
❗ ASP.NET Core 3.1 .NET Core 3.1 ✔️ ❗ ASP.NET Core 5.0 .NET 5.0 ❗ ❗ ASP.NET Core
6.0 .NET 6.0 ✔️ ✔️ ASP.NET Core 7.0 .NET 7.0 ✔️ ✔️ ASP.NET Core 8.0 .NET 8.0 ✔️
✔️ Microsoft.Owin 4.2 .NET Framework 4.6.1 ✔️ ℹ️ ✔️ ℹ️ Microsoft.Owin 4.2 .NET
Framework 4.7.2 ✔️ ✔️ Microsoft.Owin 4.2 .NET Framework 4.8 ✔️ ✔️

❗ ASP.NET Core 2.1 on .NET Core 2.1, ASP.NET Core 3.1 and 5.0 are no longer
supported by Microsoft. While OpenIddict can still be used on these platforms
thanks to its .NET Standard 2.0 compatibility, users are strongly encouraged to
migrate to ASP.NET Core/.NET 6.0.

ℹ️ Note: the following features are not available when targeting .NET Framework
4.6.1:

 * X.509 development encryption/signing certificates: calling
   AddDevelopmentEncryptionCertificate() or AddDevelopmentSigningCertificate()
   will result in a PlatformNotSupportedException being thrown at runtime if no
   valid development certificate can be found and a new one must be generated.
 * X.509 ECDSA signing certificates/keys: calling AddSigningCertificate() or
   AddSigningKey() with an ECDSA certificate/key will always result in a
   PlatformNotSupportedException being thrown at runtime.

--------------------------------------------------------------------------------


CERTIFICATION

Unlike many other identity providers, OpenIddict is not a turnkey solution but a
framework that requires writing custom code to be operational (typically, at
least an authorization controller), making it a poor candidate for the
certification program.

While a reference implementation could be submitted as-is, this wouldn't
guarantee that implementations deployed by OpenIddict users would be
standard-compliant.

Instead, developers are encouraged to execute the conformance tests against
their own deployment once they've implemented their own logic.

> The samples repository contains a dedicated sample specially designed to be
> used with the OpenID Connect Provider Certification tool and demonstrate that
> OpenIddict can be easily used in a certified implementation. To allow
> executing the certification tests as fast as possible, that sample doesn't
> include any membership or consent feature (two hardcoded identities are
> proposed for tests that require switching between identities).

--------------------------------------------------------------------------------


RESOURCES

Looking for additional resources to help you get started with OpenIddict? Don't
miss these interesting blog posts:

 * OpenIddict 4.0 preview1 is out by Kévin Chalet
 * Introducing the OpenIddict-powered providers by Kévin Chalet
 * Introducing the OpenIddict client by Kévin Chalet
 * Secure a Blazor WASM ASP.NET Core hosted APP using BFF and OpenIddict by
   Damien Bowden
 * How to Secure ASP.NET Core Applications with OpenIddict Using Virto Commerce
   B2B eCommerce: Tech Case Study by Virto Commerce
 * OpenIddict 3.0 general availability by Kévin Chalet
 * Setting up an Authorization Server with OpenIddict by Robin van der Knaap
 * Introducing OpenIddict 3.0's first release candidate version by Kévin Chalet
 * OpenIddict 3.0 beta6 is out by Kévin Chalet
 * Introducing Quartz.NET support and new languages in OpenIddict 3.0 beta4 by
   Kévin Chalet
 * Introducing localization support in OpenIddict 3.0 beta3 by Kévin Chalet
 * OpenIddict 3.0 beta2 is out by Kévin Chalet
 * Introducing OpenIddict 3.0 beta1 by Kévin Chalet
 * Adding OpenIddict 3.0 to an OWIN application by Kévin Chalet
 * Creating an OpenID Connect server proxy with OpenIddict 3.0's degraded mode
   by Kévin Chalet

OpenIddict-based projects maintained by third parties:

 * OrchardCore OpenID module: turnkey OpenID Connect server and token validation
   solution, built with multitenancy in mind
 * OpenIddict UI by Thomas Duft: headless UI for managing client applications
   and scopes
 * P41.OpenIddict.CouchDB by Panos Athanasiou: CouchDB stores for OpenIddict
 * pixel-identity by Nishant Singh: Ready to host OpenID Connect service using
   OpenIddict and ASP.NET Identity with a Blazor-based UI for managing users,
   roles, applications and scopes with support for multiple databases.

--------------------------------------------------------------------------------


SECURITY POLICY

Security issues and bugs should be reported privately by emailing
security@openiddict.com. You should receive a response within 24 hours. If for
some reason you do not, please follow up via email to ensure we received your
original message.

--------------------------------------------------------------------------------


SUPPORT

If you need support, please make sure you sponsor the project before creating a
GitHub ticket. If you're not a sponsor, you can post your questions on Gitter or
StackOverflow:

 * Gitter: https://app.gitter.im/#/room/#openiddict_openiddict-core:gitter.im
 * StackOverflow: https://stackoverflow.com/questions/tagged/openiddict

❗ With OpenIddict 5.0 being now generally available, the previous version,
OpenIddict 4.0, stops being supported and won't receive bug fixes or security
updates. As such, it is recommended to migrate to OpenIddict 5.0 to continue
receiving bug and security fixes.

There are, however, two exceptions to this policy:

 * ABP Framework 7.0 users will still receive patches for OpenIddict 4.x for as
   long as ABP Framework 7.0 itself is supported by Volosoft (typically a year
   following the release of ABP 8.0), whether they have a commercial ABP license
   or just use the free packages.

 * OpenIddict sponsors who have opted for a $250+/month sponsorship are now
   offered extended support:
   
   * $250/month sponsors get full support for OpenIddict 4.x until June 18, 2024
     (6 months).
   * $500/month sponsors get full support for OpenIddict 4.x until December 18,
     2024 (12 months).
   * $1,000/month sponsors get full support for OpenIddict 4.x until December
     18, 2025 (24 months).

--------------------------------------------------------------------------------


NIGHTLY BUILDS

If you want to try out the latest features and bug fixes, there is a MyGet feed
with nightly builds of OpenIddict. To reference the OpenIddict MyGet feed,
create a NuGet.config file (at the root of your solution):

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="nuget" value="https://api.nuget.org/v3/index.json" />
    <add key="openiddict" value="https://www.myget.org/F/openiddict/api/v3/index.json" />
  </packageSources>
</configuration>


--------------------------------------------------------------------------------


CONTRIBUTORS

OpenIddict is actively maintained by Kévin Chalet. Contributions are welcome and
can be submitted using pull requests.

Special thanks to our sponsors for their incredible support:





--------------------------------------------------------------------------------


LICENSE

This project is licensed under the Apache License. This means that you can use,
modify and distribute it freely. See
http://www.apache.org/licenses/LICENSE-2.0.html for more details.