mirror of https://github.com/abpframework/abp
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
267 lines
8.5 KiB
267 lines
8.5 KiB
# Migrating from IdentityServer to OpenIddict Step by Step Guide
|
|
|
|
This guide provides layer-by-layer guidance for migrating your existing application to [OpenIddict](https://github.com/openiddict/openiddict-core) from IdentityServer. ABP startup templates use `OpenIddict` OpenId provider from v6.0.0 by default and `IdentityServer` projects are renamed to `AuthServer` in tiered/separated solutions. Since OpenIddict is only available with ABP v6.0, you will need to update your existing application in order to apply OpenIddict changes.
|
|
|
|
## History
|
|
We are not removing Identity Server packages and we will continue to release new versions of IdentityServer-related NuGet/NPM packages. That means you won't have an issue while upgrading to v6.0 when the stable version releases. We will continue to fix bugs in our packages for a while. ABP 7.0 will be based on .NET 7. If Identity Server continues to work with .NET 7, we will also continue to ship NuGet packages for our IDS integration.
|
|
|
|
On the other hand, Identity Server ends support for the open-source Identity Server at the end of 2022. The Identity Server team has decided to move to Duende IDS and ABP will not be migrated to the commercial Duende IDS. You can see the Duende Identity Server announcement from [this link](https://blog.duendesoftware.com/posts/20220111_fair_trade).
|
|
|
|
## Commercial Template
|
|
|
|
If you are using a commercial template, please check [Migrating from IdentityServer to OpenIddict for the Commercial Templates](https://docs.abp.io/en/commercial/6.0/migration-guides/openIddict-step-by-step) guide.
|
|
If you are using the microservice template, please check [Migrating the Microservice Template from IdentityServer to OpenIddict](https://docs.abp.io/en/commercial/6.0/migration-guides/openIddict-microservice) guide.
|
|
|
|
## OpenIddict Migration Steps
|
|
|
|
Use the `abp update` command to update your existing application. See [Upgrading docs](../Upgrading.md) for more info. Apply required migrations by following the [Migration Guides](Index.md) based on your application version.
|
|
|
|
### Domain.Shared Layer
|
|
|
|
- In **MyApplication.Domain.Shared.csproj** replace **project reference**:
|
|
|
|
```csharp
|
|
<PackageReference Include="Volo.Abp.IdentityServer.Domain.Shared" Version="6.0.*" />
|
|
```
|
|
|
|
with
|
|
|
|
```csharp
|
|
<PackageReference Include="Volo.Abp.OpenIddict.Domain.Shared" Version="6.0.*" />
|
|
```
|
|
|
|
- In **MyApplicationDomainSharedModule.cs** replace usings and **module dependencies:**
|
|
|
|
```csharp
|
|
using Volo.Abp.IdentityServer;
|
|
...
|
|
typeof(AbpIdentityServerDomainSharedModule)
|
|
```
|
|
|
|
with
|
|
|
|
```csharp
|
|
using Volo.Abp.OpenIddict;
|
|
...
|
|
typeof(AbpOpenIddictDomainSharedModule)
|
|
```
|
|
|
|
### Domain Layer
|
|
|
|
- In **MyApplication.Domain.csproj** replace **project references**:
|
|
|
|
```csharp
|
|
<PackageReference Include="Volo.Abp.IdentityServer.Domain" Version="6.0.*" />
|
|
<PackageReference Include="Volo.Abp.PermissionManagement.Domain.IdentityServer" Version="6.0.*" />
|
|
```
|
|
|
|
with
|
|
|
|
```csharp
|
|
<PackageReference Include="Volo.Abp.OpenIddict.Domain" Version="6.0.*" />
|
|
<PackageReference Include="Volo.Abp.PermissionManagement.Domain.OpenIddict" Version="6.0.*" />
|
|
```
|
|
|
|
- In **MyApplicationDomainModule.cs** replace usings and **module dependencies**:
|
|
|
|
```csharp
|
|
using Volo.Abp.IdentityServer;
|
|
using Volo.Abp.PermissionManagement.IdentityServer;
|
|
...
|
|
typeof(AbpIdentityServerDomainModule),
|
|
typeof(AbpPermissionManagementDomainIdentityServerModule),
|
|
```
|
|
|
|
with
|
|
|
|
```csharp
|
|
using Volo.Abp.OpenIddict;
|
|
using Volo.Abp.PermissionManagement.OpenIddict;
|
|
...
|
|
typeof(AbpOpenIddictDomainModule),
|
|
typeof(AbpPermissionManagementDomainOpenIddictModule),
|
|
```
|
|
|
|
#### OpenIddictDataSeedContributor
|
|
|
|
- Create a folder named *OpenIddict* under the Domain project and copy the [OpenIddictDataSeedContributor.cs](https://github.com/abpframework/abp-samples/blob/master/Ids2OpenId/src/Ids2OpenId.Domain/OpenIddict/OpenIddictDataSeedContributor.cs) under this folder. **Rename** all the `Ids2OpenId` with your project name.
|
|
- Delete *IdentityServer* folder that contains `IdentityServerDataSeedContributor.cs` which is no longer needed.
|
|
|
|
You can also create a project with the same name and copy the `OpenIddict` folder of the new project into your project.
|
|
|
|
### EntityFrameworkCore Layer
|
|
|
|
If you are using MongoDB, skip this step and check the *MongoDB* layer section.
|
|
|
|
- In **MyApplication.EntityFrameworkCore.csproj** replace **project reference**:
|
|
|
|
```csharp
|
|
<PackageReference Include="Volo.Abp.IdentityServer.EntityFrameworkCore" Version="6.0.*" />
|
|
```
|
|
|
|
with
|
|
|
|
```csharp
|
|
<PackageReference Include="Volo.Abp.OpenIddict.EntityFrameworkCore" Version="6.0.*" />
|
|
```
|
|
|
|
- In **MyApplicationEntityFrameworkCoreModule.cs** replace usings and **module dependencies**:
|
|
|
|
```csharp
|
|
using Volo.Abp.IdentityServer.EntityFrameworkCore;
|
|
...
|
|
typeof(AbpIdentityServerEntityFrameworkCoreModule),
|
|
```
|
|
|
|
with
|
|
|
|
```csharp
|
|
using Volo.Abp.OpenIddict.EntityFrameworkCore;
|
|
...
|
|
typeof(AbpOpenIddictEntityFrameworkCoreModule),
|
|
```
|
|
|
|
- In **MyApplicationDbContext.cs** replace usings and **fluent api configurations**:
|
|
|
|
```csharp
|
|
using Volo.Abp.IdentityServer.EntityFrameworkCore;
|
|
...
|
|
using Volo.Abp.OpenIddict.EntityFrameworkCore;
|
|
...
|
|
protected override void OnModelCreating(ModelBuilder builder)
|
|
{
|
|
base.OnModelCreating(builder);
|
|
|
|
/* Include modules to your migration db context */
|
|
|
|
...
|
|
builder.ConfigureIdentityServer();
|
|
```
|
|
|
|
with
|
|
|
|
```csharp
|
|
using Volo.Abp.OpenIddict.EntityFrameworkCore;
|
|
...
|
|
protected override void OnModelCreating(ModelBuilder builder)
|
|
{
|
|
base.OnModelCreating(builder);
|
|
|
|
/* Include modules to your migration db context */
|
|
|
|
...
|
|
builder.ConfigureOpenIddict();
|
|
```
|
|
|
|
### MongoDB Layer
|
|
|
|
If you are using EntityFrameworkCore, skip this step and check the *EntityFrameworkCore* layer section.
|
|
|
|
- In **MyApplication.MongoDB.csproj** replace **project reference**:
|
|
|
|
```csharp
|
|
<PackageReference Include="Volo.Abp.IdentityServer.MongoDB" Version="6.0.*" />
|
|
```
|
|
|
|
with
|
|
|
|
```csharp
|
|
<PackageReference Include="Volo.Abp.OpenIddict.MongoDB" Version="6.0.*" />
|
|
```
|
|
|
|
- In **MyApplicationMongoDbModule.cs** replace usings and **module dependencies**:
|
|
|
|
```csharp
|
|
using Volo.Abp.IdentityServer.MongoDB;
|
|
...
|
|
typeof(AbpIdentityServerMongoDbModule),
|
|
```
|
|
|
|
with
|
|
|
|
```csharp
|
|
using Volo.Abp.OpenIddict.MongoDB;
|
|
...
|
|
typeof(AbpOpenIddictMongoDbModule),
|
|
```
|
|
|
|
### DbMigrator Project
|
|
|
|
- In **MyApplication.DbMigrator.csproj** **add project reference**:
|
|
|
|
```csharp
|
|
<PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.1" />
|
|
```
|
|
|
|
for creating the host builder.
|
|
|
|
- In `appsettings.json` **replace IdentityServer section with OpenIddict:**
|
|
|
|
```json
|
|
"OpenIddict": {
|
|
"Applications": {
|
|
"MyApplication_Web": {
|
|
"ClientId": "MyApplication_Web",
|
|
"ClientSecret": "1q2w3e*",
|
|
"RootUrl": "https://localhost:44384"
|
|
},
|
|
"MyApplication_App": {
|
|
"ClientId": "MyApplication_App",
|
|
"RootUrl": "http://localhost:4200"
|
|
},
|
|
"MyApplication_BlazorServerTiered": {
|
|
"ClientId": "MyApplication_BlazorServerTiered",
|
|
"ClientSecret": "1q2w3e*",
|
|
"RootUrl": "https://localhost:44346"
|
|
},
|
|
"MyApplication_Swagger": {
|
|
"ClientId": "MyApplication_Swagger",
|
|
"RootUrl": "https://localhost:44391"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
Replace **MyApplication** with your application name.
|
|
|
|
### Test Project
|
|
|
|
- In **MyApplicationTestBaseModule.cs** **remove** the IdentityServer related using and PreConfigurations:
|
|
|
|
```csharp
|
|
using Volo.Abp.IdentityServer;
|
|
```
|
|
|
|
and
|
|
|
|
```csharp
|
|
PreConfigure<AbpIdentityServerBuilderOptions>(options =>
|
|
{
|
|
options.AddDeveloperSigningCredential = false;
|
|
});
|
|
|
|
PreConfigure<IIdentityServerBuilder>(identityServerBuilder =>
|
|
{
|
|
identityServerBuilder.AddDeveloperSigningCredential(false, System.Guid.NewGuid().ToString());
|
|
});
|
|
```
|
|
|
|
from `PreConfigureServices`.
|
|
|
|
### UI Layer
|
|
|
|
- [Angular UI Migration](OpenIddict-Angular.md)
|
|
- [MVC/Razor UI Migration](OpenIddict-Mvc.md)
|
|
- [Blazor-Server UI Migration](OpenIddict-Blazor-Server.md)
|
|
- [Blazor-Wasm UI Migration](OpenIddict-Blazor.md)
|
|
|
|
## Source code of samples and module
|
|
|
|
* [Open source tiered & separate auth server application migrate Identity Server to OpenIddict](https://github.com/abpframework/abp-samples/tree/master/Ids2OpenId)
|
|
* [OpenIddict module document](https://docs.abp.io/en/abp/6.0/Modules/OpenIddict)
|
|
* [OpenIddict module source code](https://github.com/abpframework/abp/tree/rel-6.0/modules/openiddict)
|
|
|
|
## See Also
|
|
|
|
* [ABP Version 6.0 Migration Guide](Abp-6_0.md)
|