Skip to content

Commit

Permalink
Document the operating systems integration
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinchalet committed Aug 12, 2024
1 parent c100296 commit f9e00be
Show file tree
Hide file tree
Showing 5 changed files with 555 additions and 28 deletions.
20 changes: 15 additions & 5 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,22 @@ export default defineConfig({
},
"/integrations/": {
items: [
{ text: "ASP.NET Core", link: "/integrations/aspnet-core" },
{ text: "ASP.NET Core Data Protection", link: "/integrations/aspnet-core-data-protection" },
{ text: "Entity Framework", link: "/integrations/entity-framework" },
{ text: "Entity Framework Core", link: "/integrations/entity-framework-core" },
{ text: "MongoDB", link: "/integrations/mongodb" },
{
text: "Web hosts",
items: [
{ text: "ASP.NET Core", link: "/integrations/aspnet-core" }
]
},
{
text: "Object-relational mappers and databases",
items: [
{ text: "Entity Framework", link: "/integrations/entity-framework" },
{ text: "Entity Framework Core", link: "/integrations/entity-framework-core" },
{ text: "MongoDB", link: "/integrations/mongodb" }
]
},
{ text: "Quartz.NET", link: "/integrations/quartz" },
{ text: "Operating systems", link: "/integrations/operating-systems" },
{ text: "System.Net.Http", link: "/integrations/system-net-http" },
{ text: "Web providers", link: "/integrations/web-providers" },
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -231,10 +231,11 @@ If you don't want to start from one of the recommended samples, you'll need to:
> [!TIP]
> For more information on the well-known services supported out-of-the-box by the OpenIddict client, read [Web providers](/integrations/web-providers.md).
## Implement an interactive OAuth 2.0/OpenID Connect client in a desktop application:
## Implement an interactive OAuth 2.0/OpenID Connect client in a mobile or desktop application:

**To implement an interactive OAuth 2.0/OpenID Connect client in a desktop application, the simplest option is to clone
**To implement an interactive OAuth 2.0/OpenID Connect client in a mobile or desktop application, the simplest option is to clone
one of the official samples** from the [openiddict-samples repository](https://github.com/openiddict/openiddict-samples).

For more information on how to use the `OpenIddict.Client.SystemIntegration` package on Linux and Windows, read
[Introducing system integration support for the OpenIddict client](https://kevinchalet.com/2023/02/27/introducing-system-integration-support-for-the-openiddict-client/).
> [!TIP]
> For more information on how to use the OpenIddict client on Android, iOS, Linux, macOS, Mac Catalyst
> and Windows, read [Operating systems integration](/integrations/operating-systems.md).
32 changes: 16 additions & 16 deletions integrations/aspnet-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@ ASP.NET Core 2.1+ application, independently of whether they are using MVC contr

## Supported versions

| ASP.NET Core version | .NET runtime version | OpenIddict 4.x | OpenIddict 5.x |
|----------------------|----------------------|-----------------------------------------|-----------------------------------------|
| ASP.NET Core 2.1 | .NET Framework 4.6.1 | :heavy_check_mark: :information_source: | :heavy_check_mark: :information_source: |
| ASP.NET Core 2.1 | .NET Framework 4.7.2 | :heavy_check_mark: | :heavy_check_mark: |
| ASP.NET Core 2.1 | .NET Framework 4.8 | :heavy_check_mark: | :heavy_check_mark: |
| ASP.NET Core 2.1 | .NET Core 2.1 | :exclamation: | :exclamation: |
| | | | |
| ASP.NET Core 3.1 | .NET Core 3.1 | :heavy_check_mark: | :exclamation: |
| | | | |
| ASP.NET Core 5.0 | .NET 5.0 | :exclamation: | :exclamation: |
| ASP.NET Core 6.0 | .NET 6.0 | :heavy_check_mark: | :heavy_check_mark: |
| ASP.NET Core 7.0 | .NET 7.0 | :heavy_check_mark: | :exclamation: |
| ASP.NET Core 8.0 | .NET 8.0 | :heavy_check_mark: | :heavy_check_mark: |
| ASP.NET Core version | .NET runtime version | |
|----------------------|----------------------|---------------------------------------|
| ASP.NET Core 2.1 | .NET Framework 4.6.1 | :heavy_check_mark: (with limitations) |
| ASP.NET Core 2.1 | .NET Framework 4.7.2 | :heavy_check_mark: |
| ASP.NET Core 2.1 | .NET Framework 4.8 | :heavy_check_mark: |
| ASP.NET Core 2.1 | .NET Core 2.1 | :exclamation: |
| | | |
| ASP.NET Core 3.1 | .NET Core 3.1 | :heavy_check_mark: |
| | | |
| ASP.NET Core 5.0 | .NET 5.0 | :exclamation: |
| ASP.NET Core 6.0 | .NET 6.0 | :heavy_check_mark: |
| ASP.NET Core 7.0 | .NET 7.0 | :heavy_check_mark: |
| ASP.NET Core 8.0 | .NET 8.0 | :heavy_check_mark: |

> [!WARNING]
> **ASP.NET Core 2.1 on .NET Core 2.1, ASP.NET Core 3.1, 5.0 and 7.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 8.0**.
> on these platforms thanks to its .NET Standard 2.0 compatibility, users are strongly encouraged to migrate to ASP.NET Core 8.0**.
>
> ASP.NET Core 2.1 on .NET Framework 4.6.1 (and higher) is still fully supported.
Expand All @@ -35,8 +35,8 @@ ASP.NET Core 2.1+ application, independently of whether they are using MVC contr
## Basic configuration <Badge type="warning" text="client" /><Badge type="danger" text="server" /><Badge type="tip" text="validation" />

To configure the ASP.NET Core integration, you'll need to:
- **Reference the `OpenIddict.Client.UseSystemNetHttp` and/or `OpenIddict.Server.UseSystemNetHttp` and/or
`OpenIddict.Validation.UseSystemNetHttp` packages**
- **Reference the `OpenIddict.Client.AspNetCore` and/or `OpenIddict.Server.AspNetCore` and/or
`OpenIddict.Validation.AspNetCore` packages**
(depending on whether you need the client and/or server and/or validation features in your project):

```xml
Expand Down
Loading

0 comments on commit f9e00be

Please sign in to comment.