diff --git a/guides/getting-started.html b/guides/getting-started.html
index 8cecfc2..c1cc766 100644
--- a/guides/getting-started.html
+++ b/guides/getting-started.html
@@ -234,8 +234,7 @@ Here's an example for the client credentials grant:
await _applicationManager.GetDisplayNameAsync(application),
Destinations.AccessToken, Destinations.IdentityToken);
- return SignIn(new ClaimsPrincipal(identity),
- OpenIddictServerAspNetCoreDefaults.AuthenticationScheme);
+ return SignIn(new ClaimsPrincipal(identity), OpenIddictServerAspNetCoreDefaults.AuthenticationScheme);
}
}
@@ -254,8 +253,7 @@ Here's an example for the client credentials grant:
var context = scope.ServiceProvider.GetRequiredService<ApplicationDbContext>();
await context.Database.EnsureCreatedAsync();
- var manager =
- scope.ServiceProvider.GetRequiredService<IOpenIddictApplicationManager>();
+ var manager = scope.ServiceProvider.GetRequiredService<IOpenIddictApplicationManager>();
if (await manager.FindByClientIdAsync("console") is null)
{
diff --git a/guides/index.html b/guides/index.html
index ab38c48..23a4662 100644
--- a/guides/index.html
+++ b/guides/index.html
@@ -6,9 +6,9 @@
- Introduction
+ What's OpenIddict?
-
+
@@ -91,17 +91,129 @@
-
Introduction
+
What's OpenIddict?
-
What's OpenIddict?
-
OpenIddict was born in late 2015 and was initially based on AspNet.Security.OpenIdConnect.Server
-(codenamed ASOS), a low-level OpenID Connect server middleware forked from OWIN/Katana's OAuthAuthorizationServerMiddleware. In 2020, ASOS was merged into OpenIddict 3.0
-to form a unified stack under the OpenIddict umbrella, while still offering an easy-to-use approach for new users and a low-level experience for advanced users.
-
Why an OpenID Connect server?
-
Adding an OpenID Connect server to your application allows you to support token authentication.
-It also allows you to manage all your users using local password or an external identity provider (e.g. Facebook or Google) for all your
-applications in one central place, with the power to control who can access your API and the information that is exposed to each client.
-
+
OpenIddict is an open source and versatile framework for building standard-compliant OAuth 2.0/OpenID Connect servers
+in any ASP.NET Core 2.1 (and higher) and legacy ASP.NET 4.6.1 (and higher) applications.
+
OpenIddict was born in late 2015 and was initially based on AspNet.Security.OpenIdConnect.Server
+(codenamed ASOS), a low-level OpenID Connect server middleware inspired by the OAuth 2.0 authorization server middleware developed by Microsoft for the OWIN project
+and the first OpenID Connect server ever created for ASP.NET Core.
+
In 2020, ASOS was merged into OpenIddict 3.0 to form a unified stack under the OpenIddict umbrella, while still offering an easy-to-use approach for new users
+and a low-level experience for advanced users thanks to a "degraded mode" that allows using OpenIddict in a stateless way (i.e without a backing database).
+
As part of this process, native support for Microsoft.Owin was added to OpenIddict 3.0 to allow using it in legacy ASP.NET 4.6.1 (and higher) applications,
+making it an excellent candidate for replacing OAuthAuthorizationServerMiddleware and OAuthBearerAuthenticationMiddleware without having to migrate to ASP.NET Core.
+
Core concepts
+
User authentication
+
Unlike other solutions, OpenIddict exclusively focuses on the OAuth 2.0/OpenID Connect protocol aspects of the authorization process
+and leaves user authentication up to the implementer: OpenIddict can be natively used with any form of user authentication like password, token,
+federated or Integration Windows Authentication. While convenient, using a membership stack like ASP.NET Core Identity is not required.
+
Integration with OpenIddict is typically done by enabling the pass-through mode to handle requests in a controller action
+or in a minimal API handler or, for more complex scenarios, by directly using its advanced events model.
+
Pass-through mode
+
As with OAuthAuthorizationServerMiddleware, OpenIddict allows handling authorization, logout and token requests in custom controller actions or any other
+middleware able to hook into the ASP.NET Core or OWIN request processing pipeline. In this case, OpenIddict will always validate incoming requests first
+(e.g by ensuring the mandatory parameters are present and valid) before allowing the rest of the pipeline to be invoked: should any validation error occur,
+OpenIddict will automatically reject the request before it reaches user-defined controller actions or custom middleware.
+
builder.Services.AddOpenIddict()
+ .AddServer(options =>
+ {
+ // Enable the authorization and token endpoints.
+ options.SetAuthorizationEndpointUris("/authorize")
+ .SetTokenEndpointUris("/token");
+
+ // Enable the authorization code flow.
+ options.AllowAuthorizationCodeFlow();
+
+ // Register the signing and encryption credentials.
+ options.AddDevelopmentEncryptionCertificate()
+ .AddDevelopmentSigningCertificate();
+
+ // Register the ASP.NET Core host and configure the authorization endpoint
+ // to allow the /authorize minimal API handler to handle authorization requests
+ // after being validated by the built-in OpenIddict server event handlers.
+ //
+ // Token requests will be handled by OpenIddict itself by reusing the identity
+ // created by the /authorize handler and stored in the authorization codes.
+ options.UseAspNetCore()
+ .EnableAuthorizationEndpointPassthrough();
+ });
+
app.MapGet("/authorize", async (HttpContext context) =>
+{
+ // Resolve the claims stored in the principal created after the Steam authentication dance.
+ // If the principal cannot be found, trigger a new challenge to redirect the user to Steam.
+ var principal = (await context.AuthenticateAsync(SteamAuthenticationDefaults.AuthenticationScheme))?.Principal;
+ if (principal is null)
+ {
+ return Results.Challenge(properties: null, new[] { SteamAuthenticationDefaults.AuthenticationScheme });
+ }
+
+ var identifier = principal.FindFirst(ClaimTypes.NameIdentifier)!.Value;
+
+ // Create a new identity and import a few select claims from the Steam principal.
+ var identity = new ClaimsIdentity(TokenValidationParameters.DefaultAuthenticationType);
+ identity.AddClaim(new Claim(Claims.Subject, identifier));
+ identity.AddClaim(new Claim(Claims.Name, identifier).SetDestinations(Destinations.AccessToken));
+
+ return Results.SignIn(new ClaimsPrincipal(identity), properties: null, OpenIddictServerAspNetCoreDefaults.AuthenticationScheme);
+});
+
Events model
+
OpenIddict implements a powerful event-based model for its server and validation stacks: each part of the request processing logic is implemented as an event handler
+that can be removed, moved to a different position in the pipeline or replaced by a custom handler to override the default logic used by OpenIddict:
+
/// <summary>
+/// Contains the logic responsible of rejecting authorization requests that don't specify a valid prompt parameter.
+/// </summary>
+public class ValidatePromptParameter : IOpenIddictServerHandler<ValidateAuthorizationRequestContext>
+{
+ /// <summary>
+ /// Gets the default descriptor definition assigned to this handler.
+ /// </summary>
+ public static OpenIddictServerHandlerDescriptor Descriptor { get; }
+ = OpenIddictServerHandlerDescriptor.CreateBuilder<ValidateAuthorizationRequestContext>()
+ .UseSingletonHandler<ValidatePromptParameter>()
+ .SetOrder(ValidateNonceParameter.Descriptor.Order + 1_000)
+ .SetType(OpenIddictServerHandlerType.BuiltIn)
+ .Build();
+
+ /// <inheritdoc/>
+ public ValueTask HandleAsync(ValidateAuthorizationRequestContext context)
+ {
+ if (context is null)
+ {
+ throw new ArgumentNullException(nameof(context));
+ }
+
+ // Reject requests specifying prompt=none with consent/login or select_account.
+ if (context.Request.HasPrompt(Prompts.None) && (context.Request.HasPrompt(Prompts.Consent) ||
+ context.Request.HasPrompt(Prompts.Login) ||
+ context.Request.HasPrompt(Prompts.SelectAccount)))
+ {
+ context.Logger.LogInformation(SR.GetResourceString(SR.ID6040));
+
+ context.Reject(
+ error: Errors.InvalidRequest,
+ description: SR.FormatID2052(Parameters.Prompt),
+ uri: SR.FormatID8000(SR.ID2052));
+
+ return default;
+ }
+
+ return default;
+ }
+}
+
In OpenIddict itself, event handlers are typically defined as dedicated classes but they can also be registered using delegates:
diff --git a/guides/migration/20-to-30.html b/guides/migration/20-to-30.html
index f514a60..0b2ca65 100644
--- a/guides/migration/20-to-30.html
+++ b/guides/migration/20-to-30.html
@@ -163,9 +163,44 @@ and are no longer supported. Make sure your application (or intermediate librari
Important
If your application references the OpenIdConnectConstants class, update it to use OpenIddictConstants instead.
Update the references to the Entity Framework Core/Entity Framework 6/MongoDB models
-
If your application references the OpenIddictApplication, OpenIddictAuthorization, OpenIddictScope or OpenIddictToken models, update these reference to use
-their new names: OpenIddict[provider name]Application, OpenIddict[provider name]Authorization, OpenIddict[provider name]Scope and OpenIddict[provider name]Token
-(e.g when using MongoDB: OpenIddictMongoDbApplication, OpenIddictMongoDbAuthorization, OpenIddictMongoDbScope and OpenIddictMongoDbToken).
+
If your application references the OpenIddictApplication, OpenIddictAuthorization, OpenIddictScope or OpenIddictToken models,
+update these reference to use their new names:
+
+
+
+
Old name
+
New name (Entity Framework Core)
+
New name (Entity Framework 6)
+
New name (MongoDB)
+
+
+
+
+
OpenIddictApplication
+
OpenIddictEntityFrameworkCoreApplication
+
OpenIddictEntityFrameworkApplication
+
OpenIddictMongoDbApplication
+
+
+
OpenIddictAuthorization
+
OpenIddictEntityFrameworkCoreAuthorization
+
OpenIddictEntityFrameworkAuthorization
+
OpenIddictMongoDbAuthorization
+
+
+
OpenIddictScope
+
OpenIddictEntityFrameworkCoreScope
+
OpenIddictEntityFrameworkScope
+
OpenIddictMongoDbScope
+
+
+
OpenIddictToken
+
OpenIddictEntityFrameworkCoreToken
+
OpenIddictEntityFrameworkToken
+
OpenIddictMongoDbToken
+
+
+
Enable ASP.NET Core integration in the server and validation options
With the base server and validation stacks being decoupled from ASP.NET Core, you now have to explicitly register the ASP.NET Core host in the server/validation options:
services.AddOpenIddict()
@@ -339,8 +374,9 @@ and the hybrid flow MUST be explicitly opted in. If you use the hybrid flow, mak
});
Update your applications to grant them the appropriate response type permissions
If you have many applications to migrate, you can use this script
+
Note
If you have many applications to migrate, you can use this script
to infer appropriate response type permissions using the already granted grant types.
+
diff --git a/index.html b/index.html
index 823bd1a..cf30377 100644
--- a/index.html
+++ b/index.html
@@ -6,9 +6,9 @@
- OpenIddict: the OpenID Connect stack you'll be addicted to
+ What's OpenIddict?
-
+
@@ -90,37 +90,202 @@
OpenIddict: the OpenID Connect stack you'll be addicted to
+
What's OpenIddict?
OpenIddict aims at providing a versatile solution to implement an OpenID Connect server and token validation 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.
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 3.x
+
OpenIddict 4.x (preview)
+
+
+
+
+
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
+
✔️
+
✔️
+
+
+
+
+
+
+
+
+
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
+
✔️
+
✔️
+
+
+
+
❗Note: ASP.NET Core 2.1 on .NET Core 2.1 is no longer supported. While OpenIddict 4.x can still be used on .NET Core 2.1
+thanks to its .NET Standard 2.0 compatibility, users are strongly encouraged to migrate to ASP.NET Core/.NET 6.0.
+ASP.NET Core 2.1 on .NET Framework 4.6.1 (and higher) is still fully supported.
+
ℹ️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:
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:
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):