README

OpenIddict

 The OpenID Connect stack you'll be addicted to.

 What is OpenIddict?

OpenIddict aims at providing a versatile solution to implement OpenID Connect client, server and token validation support in .NET applications.

 [!TIP]
 While the client, server and token validation features can be used in any ASP.NET 4.6.2+ or
 ASP.NET Core 2.3+ web application,
 the client feature can also be used in
 Android, iOS, Linux, Mac Catalyst, macOS and Windows applications
 to integrate with OpenIddict-based identity providers or any other OAuth 2.0/OpenID Connect-compliant implementation.

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

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

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.

Developers looking for a simple and turnkey solution are strongly encouraged to evaluate Volo.OpenIddict.Pro,
which is based on OpenIddict, supports all the common OAuth 2.0/OpenID Connect flows and offers a powerful applications/scopes management GUI.

 [!TIP]
 Looking to integrate with a SAML2P Identity Provider (IDP) or Service Provider (SP)? Rock Solid Knowledge,
 a sponsor of OpenIddict, is developing a range of identity components to enhance your OpenIddict solution.
 The first of these is their popular SAML2P component.

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

 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.

 [!TIP]
 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 7.0 is out by Kévin Chalet
- OpenIddict on AWS Serverless: adding interactive login by A