今回のテーマ・課題
ASP.NET CoreのMVCアプリケーションでIdentity Server 4が起動するようにする最小限の手順を示す。
参考サイト:
IdentityServerの設定と概要(https://identityserver4-ja.readthedocs.io/ja/latest/quickstarts/0_overview.html#)
1. ソリューションとプロジェクトの構成
ソリューション名 | 目的 |
---|---|
IS4QuickStart | IdentityServerのトライアルプロジェクトを統合するソリューション |
プロジェクト名 | 目的 |
---|---|
QS01_SettingUpIdentityServer | 最初に作成するIdentityServerを使用したASP.NET Coreプロジェクト |
2. QS01_SettingUpIdentityServerの作成手順
- ASP.NET Core の空のWebアプリケーションとして作成する。
- Nuget Package ManagerでIdentity Server 4をインストールする。
("Install-Package IdentityServer4" ・・・ Nuget Package Console) - Startupの変更
// ・・・
using IdentityServer4.Models;
namespace QS01_SettingUpIdentityServer
{
public class Startup
{
public void ConfigureServices(IServiceCollection services)
{
// IdentityServerをサービスとして追加する。
// ※)注意事項
// AddInMemoryClientsとAddInMemoryIdentityResourcesの2つのメソッドも指定する。
services.AddIdentityServer()
.AddDeveloperSigningCredential()
.AddInMemoryClients(new List<Client>())
.AddInMemoryIdentityResources(new List<IdentityResource>());
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
// IdentityServerをミドルウェアとして登録
app.UseIdentityServer();
app.UseRouting();
// ・・・
}
}
注意事項
参考サイトでは、ConfigureServicesのコードは
services.AddIdentityServer().AddDeveloperSigningCredential();
までしか書いていないがこれだと、Program.Main()の
CreateHostBuilder(args).Build().Run();で以下の例外がスローされConfigureに進まない!
InvalidOperationException: Unable to resolve service for type 'IdentityServer4.Stores.IClientStore' v
while attempting to activate 'IdentityServer4.Services.LogoutNotificationService'.
3.ホスティングの変更
IdentityServerはコンソールホストで実行してログの出力内容を常時チェックできるようにしておく。
それをやるためにはプロジェクトのプロパティー|デバッグでプロファイルをIISExpressではなくプロジェクト本体にする。
注釈
-
IIS Expressと自己ホスティングに同じポートを設定すること。この方法で、クライアントの設定を変更することなく、2つの間で切り替えることができる。
-
起動時にコンソールホストを選択するには、Visual Studioの起動メニューでコンソールホストを選択する。
## Gitから複製したサンプルコードの実行について
問題点(1)
クローンしたばかりのソリューションを開いてパッケージの復元をしようとすると
重大度レベル:エラー
コード:NETSDK1004
説明:資産ファイル'C:\Users\雅俊\Source\Repos\TrailRunner-MF\IdentityServer\samples\Quickstarts\1_ClientCredentials\src\IdentityServer\obj\project.assets.json'が見つかりません。 NuGet パッケージの復元を実行して、このファイルを生成してください。
のようなエラーが出て先に進めなくなる場合がある。
- 実際のプログラム・・・https://github.com/IdentityServer/IdentityServer4/tree/main/samples/Quickstarts/1_ClientCredentials
解決法は以下の通り。
- Visual Studio >>ツール>>オプション>> Nuget Manager >>パッケージソース
- サードパーティのパッケージソースのチェックを外しました。
- ソリューションを再構築します。
問題点(2)
GitHubから取ってきたQuickStartのソリューションは、Clientをスタートアッププロジェクトに指定してデバッグ開始してもちゃんと動かない。
必ずClient(=コンソールアプリケーション)のProgramクラスのMainメソッドの以下の箇所でエラーになってしまう。
namespace Client
{
public class Program
{
private static async Task Main()
{
// discover endpoints from metadata
var client = new HttpClient();
var disco = await client.GetDiscoveryDocumentAsync("https://localhost:5001"); // **ここ**
if (disco.IsError) // **かららずえらーになってしまう。**
{
Console.WriteLine(disco.Error);
return;
}
・・・・
解決方法
ソリューションを「マルチスタートアッププロジェクト」に指定する。
やり方は以下の通り。
- ソリューションエクスプローラで最上位ノードのソリューションを選択した状態でコンテキストメニューを開き、プロパティーを開く。
- マルチスタートアップを指定して、起動順序を入れ替え、アクションをそれぞれ「開始」に指定する。
こうすればIdentityServer/Apiが起動したうえでClientが起動し、上述のclient.GetDiscoveryDocumentAsyncメソッドは成功しプログラムは継続する。
## ノウハウ IdentityServer, Apiそれぞれに割り振られているIISExpress起動用のポート番号は、実行マシンで他の常駐プログラム(=サービス)等で使用されていなければ、他のIISExpressでテストするソリューション内のWebアプリケーションとダブっても問題ない。 ### 例 * ソリューションAのWebアプリケーションプロジェクトa-1がhttp://localhost:5001を使用する。
- ソリューションBのWebアプリケーションプロジェクトb-1もhttp://localhost:5001を使用する。
このときVisual Studiioが1つしか起動していなくてソリューションA/Bいずれか一方だけを実行していれば全然問題ない。
仮に2つ起動していてそれぞれソリューションA/Bを開いても、同時にデバッグ(またはデバッグなしで)開始しない限りお互いへの干渉はない。